atmos describe stacks
Purpose
Use this command to show the fully deep-merged configuration for all stacks and the components in the stacks.
Usage​
Execute the describe stacks command like this:
atmos describe stacks [options]
This command shows configuration for stacks and components in the stacks.
tip
Run atmos describe stacks --help to see all the available options
Examples​
atmos describe stacks
atmos describe stacks -s tenant1-ue2-dev
atmos describe stacks --file=stacks.yaml
atmos describe stacks --file=stacks.json --format=json
atmos describe stacks --components=infra/vpc
atmos describe stacks --components=echo-server,infra/vpc
atmos describe stacks --components=echo-server,infra/vpc --sections=none
atmos describe stacks --components=echo-server,infra/vpc --sections=none
atmos describe stacks --components=none --sections=metadata
atmos describe stacks --components=echo-server,infra/vpc --sections=vars,settings,metadata
atmos describe stacks --components=test/test-component-override-3 --sections=vars,settings,component,deps,inheritance --file=stacks.yaml
atmos describe stacks --components=test/test-component-override-3 --sections=vars,settings --format=json --file=stacks.json
atmos describe stacks --components=test/test-component-override-3 --sections=deps,vars -s=tenant2-ue2-staging
atmos describe stacks --process-templates=false
atmos describe stacks --process-functions=false
atmos describe stacks --skip=terraform.output
atmos describe stacks --skip=terraform.output --skip=include
atmos describe stacks --skip=include,eval
atmos describe stacks --query <yq-expression>
tip
Use the --query flag (shorthand -q) to filter the output.
Flags​
| Flag | Description | Alias | Required |
|---|---|---|---|
--stack | Filter by a specific stack. Supports names of the top-level stack manifests (including subfolder paths), and Atmos stack names (derived from the context vars) | -s | no |
--file | If specified, write the result to the file | no | |
--format | Specify the output format: yaml or json (yaml is default) | no | |
--components | Filter by specific Atmos components (comma-separated string of component names) | no | |
--component-types | Filter by specific component types: terraform or helmfile | no | |
--sections | Output only the specified component sections. Available component sections: backend, backend_type, deps, env,inheritance, metadata, remote_state_backend,remote_state_backend_type, settings, vars | no | |
--process-templates | Enable/disable processing of all Go templatesin Atmos stacks manifests when executing the command. Use the flag to see the stack configurations before and after the templates are processed. If the flag is not provided, it's set to true by default.atmos describe stacks --process-templates=false | no | |
--process-functions | Enable/disable processing of all Atmos YAML functions in Atmos stacks manifests when executing the command. Use the flag to see the stack configurations before and after the functions are processed. If the flag is not provided, it's set to true by default.atmos describe stacks --process-functions=false | no | |
--skip | Skip processing a specific Atmos YAML function in Atmos stacks manifests when executing the command. To specify more than one function, use multiple --skip flags, or separate the functions with a comma:atmos describe stacks --skip=terraform.output --skip=includeatmos describe stacks --skip=terraform.output,include | no | |
--query | Query the results of the command using yq expressions.atmos describe stacks --query <yq-expression>.For more details, refer to https://mikefarah.gitbook.io/yq | -q | no |