Skip to main content

astro deployment update

Description

Update the configuration for a Deployment on Astro. This command is functionally identical to modifying a Deployment in the Cloud UI via the Edit Configuration button.

Usage

astro deployment update <deployment-id> <flags>
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_ID
  • ASTRONOMER_KEY_SECRET

After setting the variables, this command works for a Deployment and you don't need to manually authenticate to Astronomer. Astronomer recommends storing ASTRONOMER_KEY_SECRET as a secret before using it to programmatically update production-level Deployments.

Options

OptionDescriptionPossible Values
<deployment-id> (Required)The Deployment to updateAny valid Deployment ID
-d,--descriptionThe description for the DeploymentAny string. Multiple-word descriptions should be specified in quotations (")
-l,--nameThe Deployment's nameAny string. Multiple-word descriptions should be specified in quotations
-s,--scheduler-auThe number of AU to allocate towards the Deployment's Scheduler(s). The default is5.Integer between 0 and 30
-a,--worker-auThe number of AU to allocate towards the Deployment's worker(s). The default is 10.Integer between 0 and 175
-r,--scheduler-replicasThe number of scheduler replicas for the Deployment. The default is 1.Integer between 0 and 4
-f,--forceForce a Deployment update``
-w,--workspace-idSpecify a Workspace to update a Deployment outside of your current WorkspaceAny valid Workspace ID

Examples

# Update a Deployment's name and description
$ astro deployment update cl03oiq7d80402nwn7fsl3dmv -d="My Deployment Description" --name="My Deployment Name"

# Force update a Deployment
$ astro deployment update cl03oiq7d80402nwn7fsl3dmv -d="My Deployment Description" --force