secrets
Secret sets and secret management commands
The secrets command group helps you manage sensitive information for your agent deployments. You can create and manage secret sets (key-value pairs) and image pull secrets (for private Docker registries).
list
List secret sets and image pull secrets for active namespace / organization.
If provided with a valid secret set name, will show the keys of that set (values are hidden.)
Usage:
Arguments:
Name of the secret set list keys for. Must be a valid string identifier.
Options:
Show secret sets only. Filter out image pull secrets from the results.
Organization to list secrets for. If not provided, uses the current organization from your configuration.
set
Create or update a secret set with the given name and key-value pairs. Secrets can be passed directly as key value pairs or loaded from a file.
Usage:
Arguments:
Name of the secret set to create or modify. Must be a valid string identifier containing only characters, numbers, and hyphens.
List of secret key-value pairs e.g. KEY1=value1 KEY2="value with spaces".
See this note on using special characters in secret values.
Example:
Options:
Relative path to a file with a list of secret key-value pairs. Each line in
the file should be in the format KEY=value.
Example:
Skip confirmations and proceed with the operation.
Organization to create/update the secret set in. If not provided, uses the current organization from your configuration.
unset
Removes a specific secret key from a secret set.
Usage:
Arguments:
Name of the secret set to remove the secret from.
The key of the secret to remove from the set.
Example:
Options:
Skip confirmations and proceed with the operation.
Organization containing the secret set. If not provided, uses the current organization from your configuration.
delete
Deletes an entire secret set.
Usage:
Arguments:
Name of the secret set to delete. This action is irreversible.
Options:
Skip confirmations and proceed with the operation.
Organization containing the secret set. If not provided, uses the current organization from your configuration.
image-pull-secret
Creates credentials for pulling images from private Docker registries.
This command encodes and securely stores your image repository credentials. These credentials are used with the deploy command when pulling images from private repositories. If you don’t provide credentials directly, the command will prompt you for input and offer the option to encode them in base64 format for additional security.
Usage:
Arguments:
Name of the credentials set to create or modify. Must be a valid string identifier.
Host address of the image repository e.g. https://index.docker.io/v1/.
Credentials for the image repository in the form of username:password.
Will prompt you for the value if not provided.
Example:
Options:
Encode the credentials in base64 format.
Organization to create the image pull secret in. If not provided, uses the current organization from your configuration.