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
tip
Use jq 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 Go templates in Atmos stacks manifestswhen 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 | no |