Skip to main content

astro deployment create

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.

Create a Deployment on Astro. This command is functionally identical to using the Cloud UI to create a Deployment.

Usage

astro deployment create

When you use astro deployment create, it creates a Deployment with a default Worker Queue that uses default worker types.

Some Deployment configurations, including worker queue and worker type, can be set only by using the --deployment-file flag to apply a Deployment file. See Manage Deployments as code.

Options

OptionDescriptionPossible Values
-p, --cloud-providerThe Cloud Provider to use for your Deployment. The default is gcpFor standard clusters, possible values are aws and gcp. For dedicated clusters, possible values are aws, azure, and gcp.
-c, --cluster-id(Astro Hybrid and Astro Hosted dedicated clusters only) The cluster in which you want to create a DeploymentA valid cluster ID.
--cluster-type(Astro Hosted only) The type of cluster you want to run the Deployment on. The default is standard.Either dedicated or standard.
--dag-deployEnables DAG-only deploys for the Deployment. The default is disableEither enable or disable.
--deployment-fileLocation of the template file that specifies the configuration of the new Deployment. File can be in either JSON or YAML format. See Create a Deployment with a Deployment FileA valid file path for YAML or JSON template file
-d,--descriptionThe description for the Deployment.Any string. Multiple-word descriptions should be specified in quotations (")
--enforce-cicdSpecify that the Deployment can only accept code deploys from API tokens and keys.None
-e,--executorThe executor to use for the Deployment.CeleryExecutor or KubernetesExecutor
-a, --high-availabilityEnables high availibility for the Deployment. The default is disable.Either enable or disable.
-n,--nameThe name of the Deployment.Any string. Multiple-word descriptions should be specified in quotations
--region(Astro Hosted only) The region where you want to host the Deployment.The code for any supported region
-v,--runtime-versionThe Astro Runtime version for the DeploymentAny supported version of Astro Runtime. Major, minor, and patch versions must be specified.
-s,--scheduler-sizeThe size of scheduler for the Deployment. The default is small.Either small, medium, or large.
--waitWait for the new Deployment to have a healthy status before completing the commandNone
--workspace-idThe Workspace in which to create a Deployment. If not specified, your current Workspace is assumed.Any valid Workspace ID

Examples

# CLI prompts you for a Deployment name and cluster
astro deployment create

# Create a Deployment with all required information specified. The CLI will not prompt you for more information
astro deployment create -d="My Deployment Description" --name="My Deployment Name" --cluster-id="ckwqkz36200140ror6axh8p19"

# Specify the new Deployment's configuration with a yaml file
astro deployment create --deployment-file deployment.yaml

# Create a deployment on Astro Hosted using a standard cluster
astro deployment create --name="my-gcp-deployment" --region="us-central1"

# Create a deployment on Astro Hosted using a dedicated cluster
astro deployment create --name="my-gcp-deployment" --cluster-type="dedicated" --cluster-id="clj123n1311p901muj9hwpgjb"

Was this page helpful?

Sign up for Developer Updates

Get a summary of new Astro features once a month.

You can unsubscribe at any time.
By proceeding you agree to our Privacy Policy, our Website Terms and to receive emails from Astronomer.