CLI referenceastro deployment

astro deployment update

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.

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

1astro deployment update <deployment-id> <flags>

This command is recommended for automated workflows. To run this command in an automated process such as a CI/CD pipeline, you can generate an API token, then specify the ASTRO_API_TOKEN environment variable in the system running the Astro CLI:

$export ASTRO_API_TOKEN=<your-token>

See Organization, Workspace, and Deployment API token documentation for more details about ways to use API tokens.

Options

OptionDescriptionPossible Values
<deployment-id> (Required)The ID of the Deployment to updateAny valid Deployment ID
--allowed-ip-address-rangesIf Remote Execution is enabled, limit the Deployment’s incoming traffic to the Remote Agents in your environment.A comma-separated list of CIDR blocks, such as 192.168.0.0/24,10.0.0.0/16.
--cicd-enforcementSpecify that the Deployment can only accept code deploys from API tokens. Note that in CLI versions before 1.23, this flag was --enforce-cicd.None
--dag-deployEnable or disable dag-only deploys for the Deployment.Either enable or disable. Contact Astronomer support before using disable to disable the feature.
--default-task-pod-cpuThe default task Pod CPUs to use for the Deployment. See Customize a task’s Kubernetes Pod for more information.A numeric value such as 0.25. This number cannot exceed the values you configured in your Default pod resources in the UI or in your Deployment configuration file.
--default-task-pod-memoryThe default task pod memory to use for the Deployment in Gi. See Customize a task’s Kubernetes Pod for more information.A numeric value followed by Gi, such as 0.5Gi. This number cannot exceed the values you configured in your Default pod resources in the UI or in your Deployment configuration file.
--deployment-fileA location 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-nameThe name of the Deployment to update. Use as an alternative to <deployment-id>.Any valid Deployment name
-d,--descriptionA description of the DeploymentAny string. Multiple-word descriptions should be specified in quotations (")
-m, --development-modeWhether the Deployment is for development mode only. If set to disable, the Deployment can be considered production for the purposes of Astro support case priority, but development-only features such as hibernation aren’t available. You can’t update this value to enable for existing non-development Deployments. Set to disable by default.disable or enable
-e,--executorThe executor to use for the DeploymentCeleryExecutor or KubernetesExecutor
-f,--forceForce a Deployment updateNone
-n,--nameThe Deployment’s nameAny string. Multiple-word descriptions should be specified in quotations.
--resource-quota-cpuThe Deployment’s CPU resource quota for Kubernetes Pods. See Customize a task’s Kubernetes Pod for more information.A numeric value such as 10. This number cannot exceed the values you configured in your Default pod resources in the UI or in your Deployment file configuration file.
--resource-quota-memoryThe Deployment’s memory resource quota for Kubernetes Pods in Gi. See Customize a task’s Kubernetes Pod for more information.A numeric value followed by Gi, such as 20Gi. This number cannot exceed the values you configured in your Default pod resources in the UI or in your Deployment file configuration file.
--scheduler-sizeThe size of the Scheduler for the Deployment.Possible values can be small, medium, large, or extra_large. extra_large schedulers require a minimum Astro Runtime version of 9.7.0.
-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
--task-log-bucketIf Remote Execution is enabled, specify the cloud storage bucket for task log storage. You can configure your Deployment to show the stored logs directly in the Airflow UI.A valid cloud storage bucket name, such as gs://my-task-logs or s3://my-task-logs.
--task-log-url-patternIf Remote Execution is enabled, specify the URL template to link to task logs stored in an external logging provider from the Airflow UI.A string URL template. See Configure external logging provider for Remote Execution Deployments.
--workload-identityThe workload identity to use for the Deployment.A valid AWS arn or a GCP service account.
-w,--workspace-idSpecify a Workspace to update a Deployment outside of your current WorkspaceAny valid Workspace ID

Examples

1# Update a Deployment's name and description
2$ astro deployment update cl03oiq7d80402nwn7fsl3dmv -d="My Deployment Description" --name="My Deployment Name"
3
4# Force update a Deployment
5$ astro deployment update cl03oiq7d80402nwn7fsl3dmv -d="My Deployment Description" --force
6
7# Update the Deployment according to the configurations specified in the YAML Deployment file
8$ astro deployment update --deployment-file deployment.yaml