Secrets
This page describes secrets. Secure key value pair storage.
Secrets are a secure way to store and maintain sensitive values (e.g. credentials or API tokens) for use in the sandbox lifecycle scripts. Secrets are write-only, which prevents all users from reading their values. Secret values are only available in lifecycle scripts.
Secrets are defined on team level, allowing them to be used by multiple tracks. Secrets can only be created/updated by team Owners, and can be used by Content Creators.
Follow the steps bellow to access the Secret management page.
🌐 Web UI
💻 Instruqt CLI
- 1.
- 2.Click Team settings > Secrets. ↳ The Manage secrets page opens.
- 3.A table will show detailing all your teams current Secrets
- 1.Open a new terminal.
- 2.Enter the following command:instruqt secrets list↳ Instruqt CLI lists all secrets for the currently configured team. The output looks something like this:==> Listing secrets for team TEAM_NAMENAME CREATED UPDATED DESCRIPTIONSECRET_KEY_1 2022-08-16T13:43:43 2022-08-16T13:43:43 Description of secret oneSECRET_KEY_2 2022-08-16T13:44:23 2022-08-16T15:23:06 Description of secret two
Follow the steps below to add a new secret to your team.
The description should help content creators understand how the Secret should be used. It's recommend to keep the descriptions brief but indicative of how the secret should be used.
🌐 Web UI
💻 Instruqt CLI
- 1.
- 2.Click Team settings > Secrets. ↳ The Manage secrets page opens.
- 3.Click the Create button on the top right of the page ↳ A create form is shown.
- 4.In the Name field, enter a name or key of the secret. (e.g. MY_SECRET_KEY) .
- 5.In the Description field, enter a description of the secret.
- 6.In the Value field, enter the actual secret value.
- 7.Click Save Changes. ↳ The newly created secret appears in the table on the Manage secrets page.
- 1.Open a new terminal.
- 2.Enter the following command:instruqt secrets create SECRET_NAME "SECRET_VALUE" \--description="SECRET_DESCRIPTION"⇨ Replace
SECRET_NAMEwith the name of the secret you would like to create. ⇨ ReplaceSECRET_VALUEwith the value of the secret. ↳ Instruqt CLI creates the new secret. The output looks something like this:==> Create secret SECRET_NAME for team TEAM_NAMEOK
When updating a Secret the value is always required. If you would like update the description only the previous secret value should be used.
🌐 Web UI
💻 Instruqt CLI
- 1.
- 2.Click Team settings > Secrets. ↳ The Manage secrets page opens.
- 3.Click the action [...] button end of the table row of the secret you would like to update and select update. ↳ An update form is shown.
- 4.In the Description field, enter a new description if applicable.
- 5.In the Value field, enter the new secret value, this is mandatory for updates.
- 6.Click Save changes. ↳ The newly created secret appears in the table on the Manage secrets page.
- 1.Open a new terminal.
- 2.Enter the following command:instruqt secrets update SECRET_NAME "SECRET_VALUE"⇨ Replace
SECRET_NAMEwith the name of the secret you would like to create. ⇨ ReplaceSECRET_VALUEwith the value of the secret. ↳ Instruqt CLI creates the new secret. The output looks something like this:==> Update secret SECRET_NAME for team TEAM_NAMEOK
Once a Secret has been deleted it will not be possible to recover the value that was previously stored.
🌐 Web UI
💻 Instruqt CLI
- 1.
- 2.Click Team settings > Secrets. ↳ The Manage secrets page opens.
- 3.Click the action [...] button end of the table row of the secret you would like to delete. ↳ A delete confirmation is shown
- 4.Click Confirm. ↳ The secret is deleted and removed and not available on the secrets table.
- 1.Open a new terminal.
- 2.Enter the following command:instruqt secrets delete SECRET_NAME⇨ Replace
SECRET_NAMEwith the name of the secret you would like to delete. ↳ Instruqt CLI creates the new secret. The output looks something like this:==> Delete secret SECRET_NAME for team TEAM_NAMEOK
Last modified 3mo ago