CLI referenceastro deploymentastro deployment pool

astro deployment pool create

This command is only available on Astro.

Create Airflow pools in a Deployment. Airflow pools are stored in the Deployment’s metadata database and appear in the Airflow UI.

Usage

1astro deployment pool create

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
-d,--deployment-idThe ID of the Deployment where you want to create Airflow pools.Any valid Deployment ID
--deployment-nameThe name of the Deployment where you want to create Airflow pools. Use as an alternative to <deployment-id>.Any valid Deployment name
-w,--workspace-idCreate Airflow pools in a Deployment that is not in your current Workspace. If not specified, your current Workspace is assumed.Any valid Workspace ID
--nameThe Airflow pool name. Required.Any string
-v,--slotsNumber of airflow pool slots. Required.Any integer
--descriptionThe pool description.Any string

Examples

$# create pool called my-pool stored in the Deployment with an ID of cl03oiq7d80402nwn7fsl3dmv
>astro deployment pool create --deployment-id cl03oiq7d80402nwn7fsl3dmv --name my-pool --slots 10
>
># create pool stored in the Deployment "My Deployment"
>astro deployment pool create --deployment-name="My Deployment" --name my-pool --slots 10