cloudposse/atmos v1.35.0

on GitHub

what

• Update atmos describe component command
• Update docs https://atmos.tools/cli/commands/describe/component/

why

• Add sources of the values from the component's sections (vars, env, settings) to the command output

Sources of Component ENV Variables

The sources.env section of the atmos describe component command output shows the final deep-merged component's environment variables and their inheritance chain.

Each variable descriptor has the following schema:

• final_value - the final value of the variable after Atmos processes and deep-merges all values from all stack config files

• name - the variable name

• stack_dependencies - the variable's inheritance chain (stack config files where the values for the variable were provided). It has the following schema:

  • stack_file - the stack config file where the value for the variable was provided
  • stack_file_section - the section of the stack config file where the value for the variable was provided
  • variable_value - the variable's value
  • dependency_type - how the variable was defined (inline or import). inline means the variable was defined in one of the sections
    in the stack config file. import means the stack config file where the variable is defined was imported into the parent Atmos stack

For example:

atmos describe component test/test-component-override-3 -s tenant1-ue2-dev

sources:
  env:
    TEST_ENV_VAR1:
      final_value: val1-override-3
      name: TEST_ENV_VAR1
      stack_dependencies:
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-3
          stack_file_section: components.terraform.env
          variable_value: val1-override-3
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-2
          stack_file_section: components.terraform.env
          variable_value: val1-override-2
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override
          stack_file_section: components.terraform.env
          variable_value: val1-override
        - dependency_type: import
          stack_file: catalog/terraform/test-component
          stack_file_section: components.terraform.env
          variable_value: val1
    TEST_ENV_VAR2:
      final_value: val2-override-3
      name: TEST_ENV_VAR2
      stack_dependencies:
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-3
          stack_file_section: components.terraform.env
          variable_value: val2-override-3
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-2
          stack_file_section: components.terraform.env
          variable_value: val2-override-2
        - dependency_type: import
          stack_file: catalog/terraform/test-component
          stack_file_section: components.terraform.env
          variable_value: val2

The stack_dependencies inheritance chain shows the ENV variable sources in the reverse order the sources were processed. The first item in the list was processed the last and its variable_value overrode all the previous values of the variable.

For example, the component's TEST_ENV_VAR1 ENV variable has the following inheritance chain:

sources:
  env:
    TEST_ENV_VAR1:
      final_value: val1-override-3
      name: TEST_ENV_VAR1
      stack_dependencies:
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-3
          stack_file_section: components.terraform.env
          variable_value: val1-override-3
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-2
          stack_file_section: components.terraform.env
          variable_value: val1-override-2
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override
          stack_file_section: components.terraform.env
          variable_value: val1-override
        - dependency_type: import
          stack_file: catalog/terraform/test-component
          stack_file_section: components.terraform.env
          variable_value: val1

Which we can interpret as follows (reading from the last to the first item in the stack_dependencies list):

• In the catalog/terraform/test-component stack config file (the last item in the list), the value for the TEST_ENV_VAR1 ENV variable was set to val1 in the components.terraform.env section

• Then the value was set to val1-override in the catalog/terraform/test-component-override stack config file. This value overrides the value set in the catalog/terraform/test-component stack config file

• Then the value was set to val1-override-2 in the catalog/terraform/test-component-override-2 stack config file. This value overrides the values set in the catalog/terraform/test-component and catalog/terraform/test-component-override stack config files

• Finally, in the catalog/terraform/test-component-override-3 stack config file (which was imported into the parent Atmos stack via import, the value was set to val1-override-3 in the components.terraform.env section of the test/test-component-override-3 Atmos component. This value overrode all the previous values arriving at the final_value: val1-override-3 for the ENV variable

Sources of Component Settings

The sources.settings section of the output shows the final deep-merged component's settings and their inheritance chain.

Each setting descriptor has the following schema:

• final_value - the final value of the setting after Atmos processes and deep-merges all values from all stack config files

• name - the setting name

• stack_dependencies - the setting's inheritance chain (stack config files where the values for the variable were provided). It has the following schema:

  • stack_file - the stack config file where the value for the setting was provided
  • stack_file_section - the section of the stack config file where the value for the setting was provided
  • variable_value - the setting's value
  • dependency_type - how the setting was defined (inline or import). inline means the setting was defined in one of the sections
    in the stack config file. import means the stack config file where the setting is defined was imported into the parent Atmos stack

For example:

atmos describe component test/test-component-override-3 -s tenant1-ue2-dev

sources:
  settings:
    spacelift:
      final_value:
        protect_from_deletion: true
        stack_destructor_enabled: false
        stack_name_pattern: '{tenant}-{environment}-{stage}-new-component'
        workspace_enabled: false
      name: spacelift
      stack_dependencies:
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-3
          stack_file_section: components.terraform.settings
          variable_value:
            workspace_enabled: false
        - dependency_type: import
          stack_file: catalog/terraform/test-component-override-2
          stack_file_section: components.terraform.settings
          variable_value:
            stack_name_pattern: '{tenant}-{environment}-{stage}-new-component'
            workspace_enabled: true
        - dependency_type: import
          stack_file: catalog/terraform/test-component
          stack_file_section: components.terraform.settings
          variable_value:
            workspace_enabled: true
        - dependency_type: import
          stack_file: catalog/terraform/spacelift-and-backend-override-1
          stack_file_section: settings
          variable_value:
            protect_from_deletion: true
            stack_destructor_enabled: false
            workspace_enabled: true

The stack_dependencies inheritance chain shows the sources of the setting in the reverse order the sources were processed. The first item in the list was processed the last and its variable_value overrode all the previous values of the setting.