astro deployment inspect | Astronomer Documentation

Usage

1 astro deployment inspect

When using the --key flag, specify the complete path of the key you want to return the value for, excluding deployment. For example, to return the cluster_id for a specific Deployment, you would run:

1 astro deployment inspect -n <deployment-name> --key metadata.cluster_id

See Template file contents for all possible values to return.

Options

Option	Description	Possible Values
`<deployment-id>`	The ID of the Deployment to inspect.	Any valid Deployment ID
`-n`, `--deployment-name`	Name of the Deployment to inspect. Use as an alternative to `<deployment-id>`.	Any valid Deployment name
`-k`, `--key`	Return only a specific configuration key for a Deployment. For example `--key configuration.cluster_id` to get a Deployment’s cluster ID.	Any valid Deployment configuration key
`-o`, `--output`	Output format can be one of: YAML or JSON. By default, inspecting a Deployment returns a file in YAML format.	`yaml` or `json`
`--show-workload-identity`	Return the workload identity values that are set for the Deployment.	None
`-t`, `--template`	Generate a Deployment template file for the inspected Deployment. A template file is a configuration file that includes all information about a Deployment at the time of inspection, except for its name, description field, and unique metadata. See Manage with Deployment files to learn more about templates.	None
`--workspace-id`	Specify a Workspace to run this command for a Deployment that is outside of your current Workspace.	Any valid Workspace ID

Examples

1 # Shows a list of Deployments to inspect and prompts you to choose one
2 $ astro deployment inspect
3 
4 # Shows a specific Deployment's configuration
5 $ astro deployment inspect <deployment-id>
6 
7 # Shows a specific Deployment's health status
8 $ astro deployment inspect <deployment-id> --key metadata.status
9 
10 # Save the current state of a Deployment to a YAML Deployment file
11 $ astro deployment inspect <deployment-id> > deployment.yaml
12 
13 # Save a Deployment as a JSON template file
14 $ astro deployment inspect <deployment-id> --template -o json > deployment.json

1	# Shows a list of Deployments to inspect and prompts you to choose one
2	$ astro deployment inspect
3
4	# Shows a specific Deployment's configuration
5	$ astro deployment inspect <deployment-id>
6
7	# Shows a specific Deployment's health status
8	$ astro deployment inspect <deployment-id> --key metadata.status
9
10	# Save the current state of a Deployment to a YAML Deployment file
11	$ astro deployment inspect <deployment-id> > deployment.yaml
12
13	# Save a Deployment as a JSON template file
14	$ astro deployment inspect <deployment-id> --template -o json > deployment.json

Usage

Options

Examples

Related Commands