Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
* [API Tokens](user-guide/global-configurations/authorization/api-tokens.md)
* [Manage Notification](user-guide/global-configurations/manage-notification.md)
* [External links](user-guide/global-configurations/external-links.md)
* [Tags](user-guide/global-configurations/mandatory-tags.md)
* [Devtron Upgrade](setup/upgrade/README.md)
* [Update Devtron from Devtron UI](setup/upgrade/upgrade-devtron-ui.md)
* [0.5.x-0.6.x](setup/upgrade/devtron-upgrade-0.5.x-0.6.x.md)
Expand Down
49 changes: 49 additions & 0 deletions docs/user-guide/global-configurations/mandatory-tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Mandatory Tags

Devtron's `Mandatory Tags` feature enables you to assign tags to your applications. Devtron also offers the option to propagate the mandatory tags assigned to an application as labels within the associated Kubernetes resources.

## Add Mandatory Tags

To add mandatory tags, follow these steps:

1. From the left pane, navigate to the Global Configuration section.
2. Select Tags within the Global Configuration section.

Once you are in the Tags section, locate the `Add Tag` button in the upper-right corner of the screen. Click on this button to proceed.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/mandatory-tags/add-tag.jpg)

Within the Add Tag section, you will find two options for tags:

* **Suggested tags:** These tags appear as suggestions when adding tags to applications.
* **Mandatory tags:** These tags are required for applications within the selected project.

To create mandatory tags, choose the second option: `Mandatory tags`. This ensures that the specified tags are mandatory for the applications within the selected project.

3. Next, choose the project(s) for which you want to create mandatory tags. You can select multiple projects at once.

4. After selecting the projects, proceed to add the mandatory tags for the selected projects.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/mandatory-tags/create-tag.jpg)

## Propagate Tags to Kubernetes Resources

By default, tags assigned to applications in Devtron are not automatically propagated to Kubernetes resources as labels. However, Devtron provides the flexibility to enable this feature if desired.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/mandatory-tags/propagation-enable-disable.jpg)

When the propagation is enabled for tags from the global configuration, the tags will be automatically propagated as labels for all applications within the projects where these tags are used. Even if tag propagation is disabled from the global configuration in Devtron, you still have the option to enable propagation at the application level.

## Create Application With Mandatory Tags

In a project where mandatory tags are enabled, it is required to provide values for those tags when creating new applications. Without providing values for the mandatory tags, it is not possible to create a new application within that project.

When mandatory tags are enabled, Devtron enforces the requirement to specify values for these tags during the application creation process. This ensures that all applications within the project adhere to the specified tag values.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/mandatory-tags/app-creation-with-tags.jpg)

## Propagate Tags to Kubernetes Resources While Creating Application

If tag propagation for a project is disabled globally, you can still enable it for individual applications. During the application creation process, you have the option to enable tag propagation specifically for that application. By doing so, the tags assigned to that application will be propagated as labels to the associated Kubernetes resources.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/mandatory-tags/propagation-enable-disable.jpg)