The Secret Variable is a feature of the One Platform that ensures the
security of confidential variables used in application monitoring,
services, and cloud configurations. These confidential variables are
registered in the platform with a business name and can be used to
replace information that should not be publicly visible to other users
in the organization.
The Secret Variable is not editable and contains sensitive
information such as passwords, which are not visible for querying in the
platform.
The user-chosen business name for the security of confidential
information is available to all users to apply in health checks,
headers, and other fields by using the command “{{” or clicking on the
key symbol that appears in the right corner of the field. By doing so,
you can view the list of created variables.
To configure the Secret Variable on the platform, click on the arrow
next to the organization’s name on the top bar and click on the button
with the pencil icon to enter your organization or click here.
Once inside your organization, you will find “Tokens and Secrets
Variables.” Click on the plus sign (+) button next to the name “Secret
Variable,” and a dialog box will open. In this box, you enter the name
of the variable (without the brackets ({{)) that will be used publicly
by your team of users. Then, fill in the confidential information you
want to encrypt and keep the value secret.
After filling in all the fields, click on the “Save” button to create
the configuration. In a few seconds, your Secret Variable will be
created and will be shown as in the image below:
Note: After creating the Secret Variable, it is not possible to edit it. To make modifications, you will need to delete it and create a new one.
Note: If the name “Secret” is too large, select the text by
double-clicking it and then pressing the “Tab” key. This will make the
delete icon applicable, allowing you to remove a secret.
Using a Secret Variable:
In the Application:
Adding or removing a Secret Variable can be done when creating your resilience matrix or editing it later, as needed.
- Access the “Products” section in the platform.
- Select the desired product.
- Enter the resilience matrix of the specific application you want to configure.
- Click on the pencil icon to configure the application settings.
Click on the key symbol or type “{{” within the field, and the list
of variables registered in the organization will be displayed. Select
the Secret Variable you desire, and it can be used in the URL for health
checks or in the header or value fields.
Add-On:
To register the Secret Variable via add-on, follow these steps:
- Access the desired application.
- Below, you will find all the add-ons added to this application.
- Registering the Secret Variable via add-on is similar to application
configuration. Click on the add-on name (or the left arrow), and the
settings will expand for changes. - Click on the key symbol available in the indicated fields or use “{{” to open the list of variables and enter where necessary.
- You can add them during the add-on creation or later.
- Once you’ve made the desired changes, click on “Save” to finalize the configuration.