atmos describe workflows

Purpose

Use this command to show all configured Atmos workflows.

atmos describe workflows --help

Usage

Execute the describe workflows command like this:

atmos describe workflows [options]

tip

Run atmos describe workflows --help to see all the available options

Examples

atmos describe workflows
atmos describe workflows --output map
atmos describe workflows -o list
atmos describe workflows -o all
atmos describe workflows -o list --format json
atmos describe workflows -o all -f yaml
atmos describe workflows -f json

Flags

Flag	Description	Alias	Required
`--format`	Specify the output format: `yaml` or `json` (`yaml` is default)	`-f`	no
`--output`	Specify the output type: `list`, `map` or `all` (`list` is default)	`-o`	no

When the --output list flag is passed (default), the output of the command is a list of objects. Each object has the following schema:

file - the workflow manifest file name
workflow - the name of the workflow defined in the workflow manifest file

For example:

atmos describe workflows
atmos describe workflows -o list

- file: compliance.yaml
  workflow: deploy/aws-config/global-collector
- file: compliance.yaml
  workflow: deploy/aws-config/superadmin
- file: compliance.yaml
  workflow: destroy/aws-config/global-collector
- file: compliance.yaml
  workflow: destroy/aws-config/superadmin
- file: datadog.yaml
  workflow: deploy/datadog-integration
- file: helpers.yaml
  workflow: save/docker-config-json
- file: networking.yaml
  workflow: apply-all-components
- file: networking.yaml
  workflow: plan-all-vpc
- file: networking.yaml
  workflow: plan-all-vpc-flow-logs

When the --output map flag is passed, the output of the command is a map of workflow manifests to the lists of workflows defined in each manifest. For example:

atmos describe workflows -o map

compliance.yaml:
  - deploy/aws-config/global-collector
  - deploy/aws-config/superadmin
  - destroy/aws-config/global-collector
  - destroy/aws-config/superadmin
datadog.yaml:
  - deploy/datadog-integration
helpers.yaml:
  - save/docker-config-json
networking.yaml:
  - apply-all-components
  - plan-all-vpc
  - plan-all-vpc-flow-logs

When the --output all flag is passed, the output of the command is a map of workflow manifests to the maps of all workflow definitions. For example:

atmos describe workflows -o all

networking.yaml:
  name: Networking & Logging
  description: Atmos workflows for managing VPCs and VPC Flow Logs
  workflows:
    apply-all-components:
      description: |
        Run 'terraform apply' on all components in all stacks
      steps:
        - command: terraform apply vpc-flow-logs-bucket -s plat-ue2-dev -auto-approve
        - command: terraform apply vpc -s plat-ue2-dev -auto-approve
        - command: terraform apply vpc-flow-logs-bucket -s plat-uw2-dev -auto-approve
        - command: terraform apply vpc -s plat-uw2-dev -auto-approve
        - command: terraform apply vpc-flow-logs-bucket -s plat-ue2-staging -auto-approve
        - command: terraform apply vpc -s plat-ue2-staging -auto-approve
        - command: terraform apply vpc-flow-logs-bucket -s plat-uw2-staging -auto-approve
        - command: terraform apply vpc -s plat-uw2-staging -auto-approve
        - command: terraform apply vpc-flow-logs-bucket -s plat-ue2-prod -auto-approve
        - command: terraform apply vpc -s plat-ue2-prod -auto-approve
        - command: terraform apply vpc-flow-logs-bucket -s plat-uw2-prod -auto-approve
        - command: terraform apply vpc -s plat-uw2-prod -auto-approve
    plan-all-vpc:
      description: |
        Run 'terraform plan' on all 'vpc' components in all stacks
      steps:
        - command: terraform plan vpc -s plat-ue2-dev
        - command: terraform plan vpc -s plat-uw2-dev
        - command: terraform plan vpc -s plat-ue2-staging
        - command: terraform plan vpc -s plat-uw2-staging
        - command: terraform plan vpc -s plat-ue2-prod
        - command: terraform plan vpc -s plat-uw2-prod
    plan-all-vpc-flow-logs:
      description: |
        Run 'terraform plan' on all 'vpc-flow-logs-bucket' components in all stacks
      steps:
        - command: terraform plan vpc-flow-logs-bucket -s plat-ue2-dev
        - command: terraform plan vpc-flow-logs-bucket -s plat-uw2-dev
        - command: terraform plan vpc-flow-logs-bucket -s plat-ue2-staging
        - command: terraform plan vpc-flow-logs-bucket -s plat-uw2-staging
        - command: terraform plan vpc-flow-logs-bucket -s plat-ue2-prod
        - command: terraform plan vpc-flow-logs-bucket -s plat-uw2-prod
validation.yaml:
  name: Validation
  description: Atmos workflows for VPCs and VPC Flow Logs validation
  workflows:
    validate-all-vpc:
      description: Validate all VPC components in all stacks
      steps:
        - command: validate component vpc -s plat-ue2-dev
        - command: validate component vpc -s plat-uw2-dev
        - command: validate component vpc -s plat-ue2-staging
        - command: validate component vpc -s plat-uw2-staging
        - command: validate component vpc -s plat-ue2-prod
        - command: validate component vpc -s plat-uw2-prod
    validate-all-vpc-flow-logs:
      description: Validate all VPC Flow Logs bucket components in all stacks
      steps:
        - command: validate component vpc-flow-logs-bucket -s plat-ue2-dev
        - command: validate component vpc-flow-logs-bucket -s plat-uw2-dev
        - command: validate component vpc-flow-logs-bucket -s plat-ue2-staging
        - command: validate component vpc-flow-logs-bucket -s plat-uw2-staging
        - command: validate component vpc-flow-logs-bucket -s plat-ue2-prod
        - command: validate component vpc-flow-logs-bucket -s plat-uw2-prod

tip

Use the atmos workflow CLI command to execute an Atmos workflow

atmos describe workflows --help

Usage​

Examples​

Flags​

Usage

Examples

Flags