Add `--process-templates` flag to `atmos describe stacks` and `atmos describe component` commands. Update docs @aknysh (#669)
## what- Add logging to the template functions
atmos.Component
andatmos.GomplateDatasource
- Add
--process-templates
flag toatmos describe stacks
andatmos describe component
commands - Update docs
why
-
When the environment variable
ATMOS_LOGS_LEVEL
is set toTrace
, the template functionsatmos.Component
andatmos.GomplateDatasource
will log the execution flow and the results of template evaluation - useful for debuggingATMOS_LOGS_LEVEL=Trace atmos terraform plan <component> -s <stack>
-
Enable/disable processing of
Go
templates in Atmos stacks manifests when executing the commands -
For
atmos describe component <component> -s <stack>
command, use the--process-templates
flag to see the component configuration before and after the templates are processed. If the flag is not provided, it's set totrue
by default
# Process `Go` templates in stack manifests and show the final values
atmos describe component <component> -s <stack>
# Process `Go` templates in stack manifests and show the final values
atmos describe component <component> -s <stack> --process-templates=true
# Do not process `Go` templates in stack manifests and show the template tokens in the output
atmos describe component <component> -s <stack> --process-templates=false
-
For
atmos describe stacks
command, use the--process-templates
flag to see the stack configurations before and after the templates are processed. If the flag is not provided, it's set totrue
by default# Process `Go` templates in stack manifests and show the final values atmos describe stacks # Process `Go` templates in stack manifests and show the final values atmos describe stacks --process-templates=true # Do not process `Go` templates in stack manifests and show the template tokens in the output atmos describe stacks --process-templates=false
The command
atmos describe stacks --process-templates=false
can also be used in Atmos custom commands that just list Atmos stacks does not require template processing. This will significantly speed up the custom command execution. For example, the custom commandatmos list stacks
just outputs the top-level stack names and might not require template processing. It will execute much faster if implemented like this (using the--process-templates=false
flag with theatmos describe stacks
command :- name: list commands: - name: stacks description: | List all Atmos stacks. steps: - > atmos describe stacks --process-templates=false --sections none | grep -e "^\S" | sed s/://g
fix: Atmos Affected GitHub Action Documentation @milldr (#661)
## what - Update affected-stacks job outputs and matrix integrationwhy
- The affected step was missed when the plan example was updated