Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to List Component Variables #1044

Open
RoseSecurity opened this issue Feb 10, 2025 · 2 comments
Open

Ability to List Component Variables #1044

RoseSecurity opened this issue Feb 10, 2025 · 2 comments

Comments

@RoseSecurity
Copy link
Contributor

Describe the Feature

  • It would be awesome to have the ability to list the variables of a component given the stack and component name, such as:
atmos list vars <COMPONENT> -s <STACK>

Expected Behavior

  • List the variables of a component:
 √ . [infra] (HOST) workspace ⨠ atmos list vars eks/cluster -s dev-use1-plat
access_config:
    authentication_mode: API_AND_CONFIG_MAP
addons:
    aws-ebs-csi-driver:
        addon_version: v1.31.0-eksbuild.1

Use Case

  • While the atmos describe component command is useful, some of the output is not needed for day-to-day operations and workflows.
  • Having an easy way to extract variables for a component is beneficial for quick troubleshooting.

Describe Ideal Solution

Create a command that mimics this custom command functionality:

  - name: list
    description: Execute 'list' commands
    # subcommands
    commands:
      - name: vars
        description: "List variables for an Atmos component in an Atmos Stack. Usage: atmos list vars <component> -s <stack>"
        arguments:
          - name: component
            description: Name of the component
        flags:
          - name: stack
            shorthand: s
            description: Name of the stack
            required: true
        component_config:
          component: "{{ .Arguments.component }}"
          stack: "{{ .Flags.stack }}"
        steps:
          - atmos describe component {{ .Arguments.component }} -s {{ .Flags.stack }} --query .vars

Alternatives Considered

No response

Additional Context

No response

@RoseSecurity
Copy link
Contributor Author

Looks like this will be addressed via #1036

@osterman
Copy link
Member

@RoseSecurity yes, we're implementing something similar called atmos list values which will support listing .vars and .settings etc, for a component across multiple stacks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants