Skip to main content

astro deployment update

info

The behavior and format of this command differs depending on what Astronomer product you're using. Use the following tabs to change product contexts.

Update the configuration for a Deployment on Astro.

:::note

To update existing worker queues or to create new queues for an existing Deployment, you must update your Deployment by using the --deployment-file flag to update a Deployment file.

:::

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
--dag-deployEnable or disable DAG-only deploys for the Deployment.Either enable or disable. Contact Astronomer support before using disable to disable the feature.
--deployment-fileLocation of the Deployment file to update the Deployment with. The file format can be JSON or YAML. See Create a Deployment with a Deployment File.A valid file path to any YAML or JSON Deployment file
<deployment-id> (Required)The ID of the Deployment to updateAny valid Deployment ID
--deployment-nameThe name of the Deployment to update. Use as an alternative to <deployment-id>.Any valid Deployment name
-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 24
-r,--scheduler-replicasThe number of scheduler replicas for the Deployment. The default is 1.Integer between 0 and 4
-f,--forceForce a Deployment updateNone
-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

# Update the Deployment according to the configurations specified in the YAML Deployment file
$ astro deployment update --deployment-file deployment.yaml