Add Tags to Instances

Follow the steps in this guide to create tags for organizing, monitoring, and managing access to instances.


This documentation applies to NGINX Instance Manager 2.0.0 and later.


Overview

Tags allow you to label and group NGINX instances in NGINX Instance Manager. You can also use tags to limit access to instances for OpenID Connect (OIDC) users. See Configure Authentication: RBAC for more information.

Adding a Tag

There are two ways you can add tags:

  • Add tags to the nginx-agent.conf file.
  • Add tags using the NGINX Instance Manager web interface.

Add Tags with a Configuration File

You can edit the nginx-agent.conf file to add a tag to an instance.

These tags show up during registration and can’t be removed from the web interface – if you try to remove these tags in the web interface, the NGINX Agent adds them back when restarting.

To add tags to the configuration file, take the following steps:

  1. Edit the /etc/nginx-agent/nginx-agent.conf file and add the tags in a list under the key tags:

  2. Restart the nginx-agent service:

    sudo systemctl restart nginx-agent
    

Add Tags using the Web Interface

To add tags using the NGINX Instance Manager web interface, take the following steps:

  1. Open the NGINX Instance Manager web interface and log in.

  2. In the left menu, select Instances.

  3. Select an instance row in the list of instances. An informational panel for the instance is displayed.

  4. Select Edit.

  5. In the System Tags box, select one or more tags to associate with the instance. To add a new tag, type the name for the tag, then select Add New Tag.

    • You can remove a tag from an instance by clicking the x next to the tag’s name.
  6. Select Save.