Skip to content

doc: ENT+OSS Bifurcation + Descriptions for System Variables #4230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 10, 2023
Merged

doc: ENT+OSS Bifurcation + Descriptions for System Variables #4230

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
95b461c
ENT+OSS Bifurcation for scoped variable doc
ashoknayak777 Nov 9, 2023
ddc21bb
Updates + Fixes
ashoknayak777 Nov 10, 2023
c04e8a7
Added Deployment Template in Supported Screens
ashoknayak777 Nov 10, 2023
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
30 changes: 15 additions & 15 deletions docs/user-guide/global-configurations/scoped-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ In any piece of software or code, variables are used for holding data such as nu
Devtron offers super-admins the capability to define scoped variables (key-value pairs). It means, while the key remains the same, its value can change depending on the following context:

* **Global**: Variable values will be universally same for everybody in Devtron.
* **Cluster**: Variable values might differ for each Kubernetes cluster.
* **Environment**: Variable values might differ for each environment within a cluster, e.g., staging, dev, prod.
* **Application**: Variable values might differ for each application.
* **Environment + Application**: Variable values might differ for each application on a specific environment.
* **Cluster**: Variable values might differ for each Kubernetes cluster. [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
* **Environment**: Variable values might differ for each environment within a cluster, e.g., staging, dev, prod. [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
* **Application**: Variable values might differ for each application. [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
* **Environment + Application**: Variable values might differ for each application on a specific environment. [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)

**Advantages of using scoped variables**

Expand Down Expand Up @@ -157,10 +157,10 @@ It would appear in the following format upon pasting it within an input field: `

When multiple values are associated with a scoped variable, the precedence order is as follows, with the highest priority at the top:

1. Environment + App
2. App
3. Environment
4. Cluster
1. Environment + App [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
2. App [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
3. Environment [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
4. Cluster [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
5. Global

### Example
Expand All @@ -178,14 +178,14 @@ When multiple values are associated with a scoped variable, the precedence order

## List of Predefined Variables

There are some variables that exist by default in Devtron that you can readily use if needed:
There are some system variables that exist by default in Devtron that you can readily use if needed:

* DEVTRON_NAMESPACE
* DEVTRON_CLUSTER_NAME
* DEVTRON_ENV_NAME
* DEVTRON_IMAGE_TAG
* DEVTRON_IMAGE
* DEVTRON_APP_NAME
* **DEVTRON_NAMESPACE**: Provides name of the [namespace](../../reference/glossary.md#namespace)
* **DEVTRON_CLUSTER_NAME**: Provides name of the [cluster](../global-configurations/cluster-and-environments.md) configured on Devtron
* **DEVTRON_ENV_NAME**: Provides name of the [environment](../../reference/glossary.md#environment)
* **DEVTRON_IMAGE_TAG**: Provides [image tag](https://docs.docker.com/engine/reference/commandline/tag/) associated with the [container image](../../reference/glossary.md#image)
* **DEVTRON_IMAGE**: Provides full image path of the container image, e.g., `gcr.io/k8s-minikube/kicbase:v0.0.39`
* **DEVTRON_APP_NAME**: Provides name of the [application on Devtron](../create-application.md)

{% hint style="info" %}
Currently, these variables do not appear in the scoped variable widget, but you may use them.
Expand Down