astro deployment variable update
Description
For a given Deployment on Astro, use astro deployment variable update to update the value of an existing environment variable via the Astro CLI. To do so, you can either:
- Manually enter a new
--valuein your command line for a given--key, or - Modify the value of one or more environment variables in a
.envfile and load that file with--load.
If you choose to specify --key and --value instead of loading a file, you can only update one environment variable at a time.
This command is functionally identical to editing and saving the value of an existing environment variable via the Cloud UI. For more information on environment variables, see Set environment variables on Astro.
Usage
astro deployment variable update
tip
To run this command in an automated process such as a CI/CD pipeline, set the following OS-level environment variables in a way that the Astro CLI can access them:
ASTRONOMER_KEY_IDASTRONOMER_KEY_SECRET
After setting the variables, this command works for a Deployment without you having to manually authenticate to Astronomer. Astronomer recommends storing ASTRONOMER_KEY_SECRET as a secret before using it to programmatically update production-level Deployments.
Options
| Option | Description | Possible Values |
|---|---|---|
-d,--deployment-id | The Deployment whose environment variable(s) you want to update | Any valid Deployment ID |
-e,--env | The path to a file that contains a list of environment variables. If a filepath isn't specified, this looks for a .env file in your current directory. If .env doesn't exist, this flag will create it for you | Any valid filepath |
-k,--key | The environment variable key | Any string |
-l,--load | Export updated environment variables from your Astro project's .env file to the Deployment. This is an alternative to updating an environment variable by manually specifying --key and --value. By default, this flag updates all environment variables based on the file specified with --env | `` |
-s,--secret | Set the value of the updated environment variable as secret | `` |
-v,--value | The environment variable value | `` |
-w,--workspace-id | Update an environment variable for a Deployment that is not in your current Workspace. If this is not specified, your current Workspace is assumed | Any valid Workspace ID |
Examples
# Update an existing environment variable and set as secret
$ astro deployment variable update --deployment-id cl03oiq7d80402nwn7fsl3dmv --key AIRFLOW__SECRETS__BACKEND_KWARGS --value <my-new-secret-value> --secret
# Update multiple environment variables for a Deployment at once by loading them from a .env file
$ astro deployment variable update --deployment-id cl03oiq7d80402nwn7fsl3dmv --load --env .env.dev