diff --git a/website/src/components/Screengrabs/atmos--help.html b/website/src/components/Screengrabs/atmos--help.html
index ed09c39b41..d007077a1d 100644
--- a/website/src/components/Screengrabs/atmos--help.html
+++ b/website/src/components/Screengrabs/atmos--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
Atmos is a universal tool for DevOps and cloud automation used for provisioning, managing and orchestrating workflows across various toolchains
@@ -17,27 +17,44 @@
Available Commands:
- atlantis Execute 'atlantis' commands
- aws Execute 'aws' commands
- completion Generate completion script for Bash, Zsh, Fish and PowerShell
- describe Execute 'describe' commands
- docs Open the Atmos docs
- helmfile Execute 'helmfile' commands
- help Help about any command
- terraform Execute 'terraform' commands
- validate Execute 'validate' commands
- vendor Execute 'vendor' commands
- version Print the CLI version
- workflow Execute a workflow
+ atlantis Execute 'atlantis' commands
+ aws Execute 'aws' commands
+ completion Generate completion script for Bash, Zsh, Fish and PowerShell
+ describe Execute 'describe' commands
+ docs Open the Atmos docs or display component documentation
+ helmfile Execute 'helmfile' commands
+ help Help about any command
+ list Execute 'list' commands
+ pro Execute 'pro' commands
+ terraform Execute Terraform commands
+ validate Execute 'validate' commands
+ vendor Execute 'vendor' commands
+ version Print the CLI version
+ workflow Execute a workflow
Flags:
- -h, --help Help for atmos
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ -h, --help help for atmos (default "false")
+
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-atlantis--help.html b/website/src/components/Screengrabs/atmos-atlantis--help.html
index be3bc51aaf..f32622ec0e 100644
--- a/website/src/components/Screengrabs/atmos-atlantis--help.html
+++ b/website/src/components/Screengrabs/atmos-atlantis--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes Atlantis integration commands
@@ -16,20 +16,34 @@
Available Commands:
- generate Execute 'atlantis generate' commands
+ generate Execute 'atlantis generate' commands
Flags:
- -h, --help help for atlantis
+ -h, --help help for atlantis (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos atlantis [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-atlantis-generate--help.html b/website/src/components/Screengrabs/atmos-atlantis-generate--help.html
index 9f15cba3cb..f6b551c6b8 100644
--- a/website/src/components/Screengrabs/atmos-atlantis-generate--help.html
+++ b/website/src/components/Screengrabs/atmos-atlantis-generate--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates various Atlantis configurations
@@ -16,20 +16,45 @@
Available Commands:
- repo-config Execute 'atlantis generate repo-config`
+ repo-config Execute 'atlantis generate repo-config`
Flags:
- -h, --help help for generate
+ --clone-target-ref Clone the target reference with which to compare
+ the current branch: atmos atlantis generate
+ repo-config --affected-only=true
+ --clone-target-ref=true
+ The flag is only used when '--affected-only=true'
+ If set to 'false' (default), the target reference
+ will be checked out instead
+ This requires that the target reference is already
+ cloned by Git, and the information about it exists
+ in the '.git' directory (default "false")
+
+ -h, --help help for generate (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos atlantis generate [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-atlantis-generate-repo-config--help.html b/website/src/components/Screengrabs/atmos-atlantis-generate-repo-config--help.html
index 6ea7a633a9..6d478d58a4 100644
--- a/website/src/components/Screengrabs/atmos-atlantis-generate-repo-config--help.html
+++ b/website/src/components/Screengrabs/atmos-atlantis-generate-repo-config--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates repository configuration for Atlantis
@@ -16,31 +16,129 @@
Flags:
- --affected-only Generate Atlantis projects only for the Atmos components changed between two Git commits.
- atmos atlantis generate repo-config --affected-only=true
- --components string Generate Atlantis projects for the specified components only (comma-separated values).
- atmos atlantis generate repo-config --config-template <config_template> --project-template <project_template> --components <component1>,<component2>
- --config-template string atmos atlantis generate repo-config --config-template config-1 --project-template project-1
- -h, --help help for repo-config
- --output-path string atmos atlantis generate repo-config --output-path ./atlantis.yaml --config-template config-1 --project-template project-1
- --project-template string atmos atlantis generate repo-config --config-template config-1 --project-template project-1
- --ref string Git reference with which to compare the current branch: atmos atlantis generate repo-config --affected-only=true --ref refs/heads/main. Refer to https://git-scm.com/book/en/v2/Git-Internals-Git-References for more details
- --repo-path string Filesystem path to the already cloned target repository with which to compare the current branch: atmos atlantis generate repo-config --affected-only=true --repo-path <path_to_already_cloned_repo>
- --sha string Git commit SHA with which to compare the current branch: atmos atlantis generate repo-config --affected-only=true --sha 3a5eafeab90426bd82bf5899896b28cc0bab3073
- --ssh-key string Path to PEM-encoded private key to clone private repos using SSH: atmos atlantis generate repo-config --affected-only=true --ssh-key <path_to_ssh_key>
- --ssh-key-password string Encryption password for the PEM-encoded private key if the key contains a password-encrypted PEM block: atmos atlantis generate repo-config --affected-only=true --ssh-key <path_to_ssh_key> --ssh-key-password <password>
- --stacks string Generate Atlantis projects for the specified stacks only (comma-separated values).
- atmos atlantis generate repo-config --config-template <config_template> --project-template <project_template> --stacks <stack1>,<stack2>
- The filter can contain the names of the top-level stack manifests and the logical stack names (derived from the context vars)
- atmos atlantis generate repo-config --config-template <config_template> --project-template <project_template> --stacks orgs/cp/tenant1/staging/us-east-2,orgs/cp/tenant2/dev/us-east-2
- atmos atlantis generate repo-config --config-template <config_template> --project-template <project_template> --stacks tenant1-ue2-staging,tenant1-ue2-prod
- atmos atlantis generate repo-config --config-template <config_template> --project-template <project_template> --stacks orgs/cp/tenant1/staging/us-east-2,tenant1-ue2-prod
- --verbose Print more detailed output when cloning and checking out the Git repository: atmos atlantis generate repo-config --affected-only=true --verbose=true
+ --affected-only Generate Atlantis projects only for the
+ Atmos components changed between two Git
+ commits.
+ atmos atlantis generate repo-config
+ --affected-only=true (default "false")
+
+ --components string Generate Atlantis projects for the
+ specified components only (comma-separated
+ values).
+ atmos atlantis generate repo-config
+ --config-template <config_template>
+ --project-template <project_template>
+ --components <component1>,<component2>
+
+ --config-template string atmos atlantis generate repo-config
+ --config-template config-1
+ --project-template project-1
+
+ -h, --help help for repo-config (default "false")
+
+ --output-path string atmos atlantis generate repo-config
+ --output-path ./atlantis.yaml
+ --config-template config-1
+ --project-template project-1
+
+ --project-template string atmos atlantis generate repo-config
+ --config-template config-1
+ --project-template project-1
+
+ --ref string Git reference with which to compare the
+ current branch: atmos atlantis generate
+ repo-config --affected-only=true --ref
+ refs/heads/main. Refer to
+ https://git-scm.com/book/en/v2/Git-Internals-Git-References
+ for more details
+
+ --repo-path string Filesystem path to the already cloned
+ target repository with which to compare the
+ current branch: atmos atlantis generate
+ repo-config --affected-only=true
+ --repo-path <path_to_already_cloned_repo>
+
+ --sha string Git commit SHA with which to compare the
+ current branch: atmos atlantis generate
+ repo-config --affected-only=true --sha
+ 3a5eafeab90426bd82bf5899896b28cc0bab3073
+
+ --ssh-key string Path to PEM-encoded private key to clone
+ private repos using SSH: atmos atlantis
+ generate repo-config --affected-only=true
+ --ssh-key <path_to_ssh_key>
+
+ --ssh-key-password string Encryption password for the PEM-encoded
+ private key if the key contains a
+ password-encrypted PEM block: atmos
+ atlantis generate repo-config
+ --affected-only=true --ssh-key
+ <path_to_ssh_key> --ssh-key-password
+ <password>
+
+ --stacks string Generate Atlantis projects for the
+ specified stacks only (comma-separated
+ values).
+ atmos atlantis generate repo-config
+ --config-template <config_template>
+ --project-template <project_template>
+ --stacks <stack1>,<stack2>
+ The filter can contain the names of the
+ top-level stack manifests and the logical
+ stack names (derived from the context vars)
+ atmos atlantis generate repo-config
+ --config-template <config_template>
+ --project-template <project_template>
+ --stacks
+ orgs/cp/tenant1/staging/us-east-2,orgs/cp/tenant2/dev/us-east-2
+ atmos atlantis generate repo-config
+ --config-template <config_template>
+ --project-template <project_template>
+ --stacks
+ tenant1-ue2-staging,tenant1-ue2-prod
+ atmos atlantis generate repo-config
+ --config-template <config_template>
+ --project-template <project_template>
+ --stacks
+ orgs/cp/tenant1/staging/us-east-2,tenant1-ue2-prod
+
+ --verbose Print more detailed output when cloning and
+ checking out the Git repository: atmos
+ atlantis generate repo-config
+ --affected-only=true --verbose=true
+ (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --clone-target-ref Clone the target reference with which to
+ compare the current branch: atmos atlantis
+ generate repo-config --affected-only=true
+ --clone-target-ref=true
+ The flag is only used when
+ '--affected-only=true'
+ If set to 'false' (default), the target
+ reference will be checked out instead
+ This requires that the target reference is
+ already cloned by Git, and the information
+ about it exists in the '.git' directory
+ (default "false")
+
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-aws--help.html b/website/src/components/Screengrabs/atmos-aws--help.html
index 76c05e7ffe..b7b40ab3b5 100644
--- a/website/src/components/Screengrabs/atmos-aws--help.html
+++ b/website/src/components/Screengrabs/atmos-aws--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes 'aws' CLI commands
@@ -16,20 +16,34 @@
Available Commands:
- eks Execute 'aws eks' commands
+ eks Execute 'aws eks' commands
Flags:
- -h, --help help for aws
+ -h, --help help for aws (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos aws [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-aws-eks--help.html b/website/src/components/Screengrabs/atmos-aws-eks--help.html
index 55571cab9b..5e53648c53 100644
--- a/website/src/components/Screengrabs/atmos-aws-eks--help.html
+++ b/website/src/components/Screengrabs/atmos-aws-eks--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes 'aws eks' CLI commands
@@ -16,20 +16,34 @@
Available Commands:
- update-kubeconfig Execute 'aws eks update-kubeconfig' command
+ update-kubeconfig Execute 'aws eks update-kubeconfig' command
Flags:
- -h, --help help for eks
+ -h, --help help for eks (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos aws eks [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-aws-eks-update-kubeconfig--help.html b/website/src/components/Screengrabs/atmos-aws-eks-update-kubeconfig--help.html
index 2abf0e74f1..778d53752b 100644
--- a/website/src/components/Screengrabs/atmos-aws-eks-update-kubeconfig--help.html
+++ b/website/src/components/Screengrabs/atmos-aws-eks-update-kubeconfig--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes 'aws eks update-kubeconfig' to download 'kubeconfig' from an EKS cluster and saves it to a file. The command executes 'aws eks update-kubeconfig' in three different ways:
@@ -34,21 +34,51 @@
Flags:
- --alias string atmos aws eks update-kubeconfig --alias <alias for the cluster context name>
- --dry-run atmos aws eks update-kubeconfig --dry-run=true
- -h, --help help for update-kubeconfig
- --kubeconfig string atmos aws eks update-kubeconfig --kubeconfig <path_to_kubeconfig>
- --name string atmos aws eks update-kubeconfig --name <cluster name>
- --profile string atmos aws eks update-kubeconfig --profile <profile>
- --region string atmos aws eks update-kubeconfig --region <region>
- --role-arn string atmos aws eks update-kubeconfig --role-arn <ARN>
- -s, --stack string atmos aws eks update-kubeconfig <component> -s <stack>
- --verbose atmos aws eks update-kubeconfig --verbose=true
+ --alias string atmos aws eks update-kubeconfig --alias <alias
+ for the cluster context name>
+
+ --dry-run atmos aws eks update-kubeconfig --dry-run=true
+ (default "false")
+
+ -h, --help help for update-kubeconfig (default "false")
+
+ --kubeconfig string atmos aws eks update-kubeconfig --kubeconfig
+ <path_to_kubeconfig>
+
+ --name string atmos aws eks update-kubeconfig --name <cluster
+ name>
+
+ --profile string atmos aws eks update-kubeconfig --profile
+ <profile>
+
+ --region string atmos aws eks update-kubeconfig --region <region>
+
+ --role-arn string atmos aws eks update-kubeconfig --role-arn <ARN>
+
+ -s, --stack string atmos aws eks update-kubeconfig <component> -s
+ <stack>
+
+ --verbose atmos aws eks update-kubeconfig --verbose=true
+ (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-completion--help.html b/website/src/components/Screengrabs/atmos-completion--help.html
index 15e794d8ab..d82a5343ab 100644
--- a/website/src/components/Screengrabs/atmos-completion--help.html
+++ b/website/src/components/Screengrabs/atmos-completion--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates completion scripts for Bash, Zsh, Fish and PowerShell
@@ -16,12 +16,26 @@
Flags:
- -h, --help help for completion
+ -h, --help help for completion (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+
diff --git a/website/src/components/Screengrabs/atmos-completion-bash.html b/website/src/components/Screengrabs/atmos-completion-bash.html
index e16ab809a1..128d3f9429 100644
--- a/website/src/components/Screengrabs/atmos-completion-bash.html
+++ b/website/src/components/Screengrabs/atmos-completion-bash.html
@@ -396,6 +396,7 @@
flags+=("--stacks=")
two_word_flags+=("--stacks")
flags+=("--verbose")
+ flags+=("--clone-target-ref")
flags+=("--logs-file=")
two_word_flags+=("--logs-file")
flags+=("--logs-level=")
@@ -423,6 +424,7 @@
flags_with_completion=()
flags_completion=()
+ flags+=("--clone-target-ref")
flags+=("--logs-file=")
two_word_flags+=("--logs-file")
flags+=("--logs-level=")
@@ -607,10 +609,13 @@
flags_with_completion=()
flags_completion=()
+ flags+=("--clone-target-ref")
flags+=("--file=")
two_word_flags+=("--file")
flags+=("--format=")
two_word_flags+=("--format")
+ flags+=("--include-dependents")
+ flags+=("--include-settings")
flags+=("--include-spacelift-admin-stacks")
flags+=("--ref=")
two_word_flags+=("--ref")
@@ -622,6 +627,10 @@
two_word_flags+=("--ssh-key")
flags+=("--ssh-key-password=")
two_word_flags+=("--ssh-key-password")
+ flags+=("--stack=")
+ two_word_flags+=("--stack")
+ two_word_flags+=("-s")
+ flags+=("--upload")
flags+=("--verbose")
flags+=("--logs-file=")
two_word_flags+=("--logs-file")
@@ -654,6 +663,7 @@
flags+=("--format=")
two_word_flags+=("--format")
two_word_flags+=("-f")
+ flags+=("--process-templates")
flags+=("--stack=")
two_word_flags+=("--stack")
two_word_flags+=("-s")
@@ -758,6 +768,8 @@
two_word_flags+=("--file")
flags+=("--format=")
two_word_flags+=("--format")
+ flags+=("--include-empty-stacks")
+ flags+=("--process-templates")
flags+=("--sections=")
two_word_flags+=("--sections")
flags+=("--stack=")
@@ -975,7 +987,7 @@
flags=()
two_word_flags=()
local_nonpersistent_flags=()
- flags_with_completion=()
+ flags_with_completion=()
flags_completion=()
flags+=("--logs-file=")
@@ -991,6 +1003,190 @@
noun_aliases=()
}
+_atmos_list_components()
+{
+ last_command="atmos_list_components"
+
+ command_aliases=()
+
+ commands=()
+
+ flags=()
+ two_word_flags=()
+ local_nonpersistent_flags=()
+ flags_with_completion=()
+ flags_completion=()
+
+ flags+=("--stack=")
+ two_word_flags+=("--stack")
+ two_word_flags+=("-s")
+ flags+=("--logs-file=")
+ two_word_flags+=("--logs-file")
+ flags+=("--logs-level=")
+ two_word_flags+=("--logs-level")
+ flags+=("--redirect-stderr=")
+ two_word_flags+=("--redirect-stderr")
+
+ must_have_one_flag=()
+ must_have_one_noun=()
+ noun_aliases=()
+}
+
+_atmos_list_stacks()
+{
+ last_command="atmos_list_stacks"
+
+ command_aliases=()
+
+ commands=()
+
+ flags=()
+ two_word_flags=()
+ local_nonpersistent_flags=()
+ flags_with_completion=()
+ flags_completion=()
+
+ flags+=("--component=")
+ two_word_flags+=("--component")
+ two_word_flags+=("-c")
+ flags+=("--logs-file=")
+ two_word_flags+=("--logs-file")
+ flags+=("--logs-level=")
+ two_word_flags+=("--logs-level")
+ flags+=("--redirect-stderr=")
+ two_word_flags+=("--redirect-stderr")
+
+ must_have_one_flag=()
+ must_have_one_noun=()
+ noun_aliases=()
+}
+
+_atmos_list()
+{
+ last_command="atmos_list"
+
+ command_aliases=()
+
+ commands=()
+ commands+=("components")
+ commands+=("stacks")
+
+ flags=()
+ two_word_flags=()
+ local_nonpersistent_flags=()
+ flags_with_completion=()
+ flags_completion=()
+
+ flags+=("--logs-file=")
+ two_word_flags+=("--logs-file")
+ flags+=("--logs-level=")
+ two_word_flags+=("--logs-level")
+ flags+=("--redirect-stderr=")
+ two_word_flags+=("--redirect-stderr")
+
+ must_have_one_flag=()
+ must_have_one_noun=()
+ noun_aliases=()
+}
+
+_atmos_pro_lock()
+{
+ last_command="atmos_pro_lock"
+
+ command_aliases=()
+
+ commands=()
+
+ flags=()
+ two_word_flags=()
+ local_nonpersistent_flags=()
+ flags_with_completion=()
+ flags_completion=()
+
+ flags+=("--component=")
+ two_word_flags+=("--component")
+ two_word_flags+=("-c")
+ flags+=("--message=")
+ two_word_flags+=("--message")
+ two_word_flags+=("-m")
+ flags+=("--stack=")
+ two_word_flags+=("--stack")
+ two_word_flags+=("-s")
+ flags+=("--ttl=")
+ two_word_flags+=("--ttl")
+ two_word_flags+=("-t")
+ flags+=("--logs-file=")
+ two_word_flags+=("--logs-file")
+ flags+=("--logs-level=")
+ two_word_flags+=("--logs-level")
+ flags+=("--redirect-stderr=")
+ two_word_flags+=("--redirect-stderr")
+
+ must_have_one_flag=()
+ must_have_one_noun=()
+ noun_aliases=()
+}
+
+_atmos_pro_unlock()
+{
+ last_command="atmos_pro_unlock"
+
+ command_aliases=()
+
+ commands=()
+
+ flags=()
+ two_word_flags=()
+ local_nonpersistent_flags=()
+ flags_with_completion=()
+ flags_completion=()
+
+ flags+=("--component=")
+ two_word_flags+=("--component")
+ two_word_flags+=("-c")
+ flags+=("--stack=")
+ two_word_flags+=("--stack")
+ two_word_flags+=("-s")
+ flags+=("--logs-file=")
+ two_word_flags+=("--logs-file")
+ flags+=("--logs-level=")
+ two_word_flags+=("--logs-level")
+ flags+=("--redirect-stderr=")
+ two_word_flags+=("--redirect-stderr")
+
+ must_have_one_flag=()
+ must_have_one_noun=()
+ noun_aliases=()
+}
+
+_atmos_pro()
+{
+ last_command="atmos_pro"
+
+ command_aliases=()
+
+ commands=()
+ commands+=("lock")
+ commands+=("unlock")
+
+ flags=()
+ two_word_flags=()
+ local_nonpersistent_flags=()
+ flags_with_completion=()
+ flags_completion=()
+
+ flags+=("--logs-file=")
+ two_word_flags+=("--logs-file")
+ flags+=("--logs-level=")
+ two_word_flags+=("--logs-level")
+ flags+=("--redirect-stderr=")
+ two_word_flags+=("--redirect-stderr")
+
+ must_have_one_flag=()
+ must_have_one_noun=()
+ noun_aliases=()
+}
+
_atmos_terraform_generate_backend()
{
last_command="atmos_terraform_generate_backend"
@@ -1308,6 +1504,7 @@
two_word_flags+=("--component")
two_word_flags+=("-c")
flags+=("--dry-run")
+ flags+=("--everything")
flags+=("--stack=")
two_word_flags+=("--stack")
two_word_flags+=("-s")
@@ -1369,6 +1566,10 @@
flags_with_completion=()
flags_completion=()
+ flags+=("--check")
+ flags+=("-c")
+ local_nonpersistent_flags+=("--check")
+ local_nonpersistent_flags+=("-c")
flags+=("--logs-file=")
two_word_flags+=("--logs-file")
flags+=("--logs-level=")
@@ -1434,6 +1635,8 @@
aliashash["hf"]="helmfile"
fi
commands+=("help")
+ commands+=("list")
+ commands+=("pro")
commands+=("terraform")
if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
command_aliases+=("tf")
@@ -1499,3 +1702,4 @@
fi
# ex: ts=4 sw=4 et filetype=sh
+
diff --git a/website/src/components/Screengrabs/atmos-completion-fish.html b/website/src/components/Screengrabs/atmos-completion-fish.html
index 0da8bf8d62..f3c2336a8e 100644
--- a/website/src/components/Screengrabs/atmos-completion-fish.html
+++ b/website/src/components/Screengrabs/atmos-completion-fish.html
@@ -80,7 +80,7 @@
__atmos_debug "========= clearing previously set __atmos_perform_completion_once_result variable =========="
set --erase __atmos_perform_completion_once_result
__atmos_debug "Successfully erased the variable __atmos_perform_completion_once_result"
-end
+end
function __atmos_requires_order_preservation
__atmos_debug ""
@@ -233,3 +233,4 @@
complete -c atmos -n 'not __atmos_requires_order_preservation && __atmos_prepare_completions' -f -a '$__atmos_comp_results'
# otherwise we use the -k flag
complete -k -c atmos -n '__atmos_requires_order_preservation && __atmos_prepare_completions' -f -a '$__atmos_comp_results'
+
diff --git a/website/src/components/Screengrabs/atmos-completion-powershell.html b/website/src/components/Screengrabs/atmos-completion-powershell.html
index c77b22e9f2..288ebb87df 100644
--- a/website/src/components/Screengrabs/atmos-completion-powershell.html
+++ b/website/src/components/Screengrabs/atmos-completion-powershell.html
@@ -243,3 +243,4 @@
}
Register-ArgumentCompleter -CommandName 'atmos' -ScriptBlock ${__atmosCompleterBlock}
+
diff --git a/website/src/components/Screengrabs/atmos-completion-zsh.html b/website/src/components/Screengrabs/atmos-completion-zsh.html
index 34d5bb198b..a967bee43c 100644
--- a/website/src/components/Screengrabs/atmos-completion-zsh.html
+++ b/website/src/components/Screengrabs/atmos-completion-zsh.html
@@ -210,3 +210,4 @@
if [ "$funcstack[1]" = "_atmos" ]; then
_atmos
fi
+
diff --git a/website/src/components/Screengrabs/atmos-describe--help.html b/website/src/components/Screengrabs/atmos-describe--help.html
index f0844a9942..6866ede113 100644
--- a/website/src/components/Screengrabs/atmos-describe--help.html
+++ b/website/src/components/Screengrabs/atmos-describe--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command shows configuration for CLI, stacks and components
@@ -16,25 +16,39 @@
Available Commands:
- affected Execute 'describe affected' command
- component Execute 'describe component' command
- config Execute 'describe config' command
- dependents Execute 'describe dependents' command
- stacks Execute 'describe stacks' command
- workflows Execute 'describe workflows' commands
+ affected Execute 'describe affected' command
+ component Execute 'describe component' command
+ config Execute 'describe config' command
+ dependents Execute 'describe dependents' command
+ stacks Execute 'describe stacks' command
+ workflows Execute 'describe workflows' commands
Flags:
- -h, --help help for describe
+ -h, --help help for describe (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos describe [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-describe-affected--help.html b/website/src/components/Screengrabs/atmos-describe-affected--help.html
index f5320ea536..b1d03c7917 100644
--- a/website/src/components/Screengrabs/atmos-describe-affected--help.html
+++ b/website/src/components/Screengrabs/atmos-describe-affected--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command produces a list of the affected Atmos components and stacks given two Git commits: atmos describe affected [options]
@@ -16,21 +16,107 @@
Flags:
- --file string Write the result to the file: atmos describe affected --ref refs/tags/v1.16.0 --file affected.json
- --format string The output format: atmos describe affected --format=json|yaml ('json' is default) (default "json")
- -h, --help help for affected
- --include-spacelift-admin-stacks Include the Spacelift admin stack of any stack that is affected by config changes: atmos describe affected --include-spacelift-admin-stacks=true
- --ref string Git reference with which to compare the current branch: atmos describe affected --ref refs/heads/main. Refer to https://git-scm.com/book/en/v2/Git-Internals-Git-References for more details
- --repo-path string Filesystem path to the already cloned target repository with which to compare the current branch: atmos describe affected --repo-path <path_to_already_cloned_repo>
- --sha string Git commit SHA with which to compare the current branch: atmos describe affected --sha 3a5eafeab90426bd82bf5899896b28cc0bab3073
- --ssh-key string Path to PEM-encoded private key to clone private repos using SSH: atmos describe affected --ssh-key <path_to_ssh_key>
- --ssh-key-password string Encryption password for the PEM-encoded private key if the key contains a password-encrypted PEM block: atmos describe affected --ssh-key <path_to_ssh_key> --ssh-key-password <password>
- --verbose Print more detailed output when cloning and checking out the Git repository: atmos describe affected --verbose=true
+ --clone-target-ref Clone the target reference with
+ which to compare the current branch:
+ atmos describe affected
+ --clone-target-ref=true
+ If set to 'false' (default), the
+ target reference will be checked out
+ instead
+ This requires that the target
+ reference is already cloned by Git,
+ and the information about it exists
+ in the '.git' directory (default
+ "false")
+
+ --file string Write the result to the file: atmos
+ describe affected --ref
+ refs/tags/v1.75.0 --file
+ affected.json
+
+ --format string The output format: atmos describe
+ affected --format=json|yaml ('json'
+ is default) (default "json")
+
+ -h, --help help for affected (default "false")
+
+ --include-dependents Include the dependent components and
+ stacks: atmos describe affected
+ --include-dependents=true (default
+ "false")
+
+ --include-settings Include the 'settings' section for
+ each affected component: atmos
+ describe affected
+ --include-settings=true (default
+ "false")
+
+ --include-spacelift-admin-stacks Include the Spacelift admin stack of
+ any stack that is affected by config
+ changes: atmos describe affected
+ --include-spacelift-admin-stacks=true
+ (default "false")
+
+ --ref string Git reference with which to compare
+ the current branch: atmos describe
+ affected --ref refs/heads/main.
+ Refer to
+ https://git-scm.com/book/en/v2/Git-Internals-Git-References
+ for more details
+
+ --repo-path string Filesystem path to the already
+ cloned target repository with which
+ to compare the current branch: atmos
+ describe affected --repo-path
+ <path_to_already_cloned_repo>
+
+ --sha string Git commit SHA with which to compare
+ the current branch: atmos describe
+ affected --sha
+ 3a5eafeab90426bd82bf5899896b28cc0bab3073
+
+ --ssh-key string Path to PEM-encoded private key to
+ clone private repos using SSH: atmos
+ describe affected --ssh-key
+ <path_to_ssh_key>
+
+ --ssh-key-password string Encryption password for the
+ PEM-encoded private key if the key
+ contains a password-encrypted PEM
+ block: atmos describe affected
+ --ssh-key <path_to_ssh_key>
+ --ssh-key-password <password>
+
+ -s, --stack string atmos describe affected -s <stack>
+
+ --upload Upload the affected components and
+ stacks to a specified HTTP endpoint:
+ atmos describe affected
+ --upload=true (default "false")
+
+ --verbose Print more detailed output when
+ cloning and checking out the Git
+ repository: atmos describe affected
+ --verbose=true (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-describe-component--help.html b/website/src/components/Screengrabs/atmos-describe-component--help.html
index 556c13292b..1ac4c1b728 100644
--- a/website/src/components/Screengrabs/atmos-describe-component--help.html
+++ b/website/src/components/Screengrabs/atmos-describe-component--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command shows configuration for an Atmos component in an Atmos stack: atmos describe component <component> -s <stack>
@@ -16,15 +16,41 @@
Flags:
- --file string Write the result to the file: atmos describe component <component> -s <stack> --file component.yaml
- -f, --format string The output format: atmos describe component <component> -s <stack> --format=yaml|json ('yaml' is default) (default "yaml")
- -h, --help help for component
- -s, --stack string atmos describe component <component> -s <stack>
+ --file string Write the result to the file: atmos describe
+ component <component> -s <stack> --file
+ component.yaml
+
+ -f, --format string The output format: atmos describe component
+ <component> -s <stack> --format=yaml|json ('yaml'
+ is default) (default "yaml")
+
+ -h, --help help for component (default "false")
+
+ --process-templates Enable/disable Go template processing in Atmos
+ stack manifests when executing the command: atmos
+ describe component <component> -s <stack>
+ --process-templates=false (default "true")
+
+ -s, --stack string atmos describe component <component> -s <stack>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-describe-config--help.html b/website/src/components/Screengrabs/atmos-describe-config--help.html
index b9f89157dd..c94dc78bd8 100644
--- a/website/src/components/Screengrabs/atmos-describe-config--help.html
+++ b/website/src/components/Screengrabs/atmos-describe-config--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command shows the final (deep-merged) CLI configuration: atmos describe config
@@ -16,13 +16,29 @@
Flags:
- -f, --format string The output format: atmos describe config -f json|yaml (default "json")
- -h, --help help for config
+ -f, --format string The output format: atmos describe config -f json|yaml
+ (default "json")
+
+ -h, --help help for config (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-describe-dependents--help.html b/website/src/components/Screengrabs/atmos-describe-dependents--help.html
index 6698cf5161..74a04b7789 100644
--- a/website/src/components/Screengrabs/atmos-describe-dependents--help.html
+++ b/website/src/components/Screengrabs/atmos-describe-dependents--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command produces a list of Atmos components in Atmos stacks that depend on the provided Atmos component: atmos describe dependents [options]
@@ -21,15 +21,36 @@
Flags:
- --file string Write the result to the file: atmos describe dependents <component> -s <stack> --file dependents.yaml
- -f, --format string The output format: atmos describe dependents <component> -s <stack> --format=json|yaml ('json' is default) (default "json")
- -h, --help help for dependents
- -s, --stack string atmos describe dependents <component> -s <stack>
+ --file string Write the result to the file: atmos describe
+ dependents <component> -s <stack> --file
+ dependents.yaml
+
+ -f, --format string The output format: atmos describe dependents
+ <component> -s <stack> --format=json|yaml ('json' is
+ default) (default "json")
+
+ -h, --help help for dependents (default "false")
+
+ -s, --stack string atmos describe dependents <component> -s <stack>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-describe-stacks--help.html b/website/src/components/Screengrabs/atmos-describe-stacks--help.html
index 7243e834aa..5e56a4ddbc 100644
--- a/website/src/components/Screengrabs/atmos-describe-stacks--help.html
+++ b/website/src/components/Screengrabs/atmos-describe-stacks--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command shows configuration for atmos stacks and components in the stacks: atmos describe stacks [options]
@@ -16,19 +16,67 @@
Flags:
- --component-types string Filter by specific component types: atmos describe stacks --component-types=terraform|helmfile. Supported component types: terraform, helmfile
- --components string Filter by specific 'atmos' components: atmos describe stacks --components=<component1>,<component2>
- --file string Write the result to file: atmos describe stacks --file=stacks.yaml
- --format string Specify the output format: atmos describe stacks --format=yaml|json ('yaml' is default) (default "yaml")
- -h, --help help for stacks
- --sections string Output only the specified component sections: atmos describe stacks --sections=vars,settings. Available component sections: backend, backend_type, deps, env, inheritance, metadata, remote_state_backend, remote_state_backend_type, settings, vars
- -s, --stack string Filter by a specific stack: atmos describe stacks -s <stack>
- The filter supports names of the top-level stack manifests (including subfolder paths), and 'atmos' stack names (derived from the context vars)
+ --component-types string Filter by specific component types: atmos
+ describe stacks
+ --component-types=terraform|helmfile.
+ Supported component types: terraform,
+ helmfile
+
+ --components string Filter by specific 'atmos' components: atmos
+ describe stacks
+ --components=<component1>,<component2>
+
+ --file string Write the result to file: atmos describe
+ stacks --file=stacks.yaml
+
+ --format string Specify the output format: atmos describe
+ stacks --format=yaml|json ('yaml' is
+ default) (default "yaml")
+
+ -h, --help help for stacks (default "false")
+
+ --include-empty-stacks Include stacks with no components in the
+ output: atmos describe stacks
+ --include-empty-stacks (default "false")
+
+ --process-templates Enable/disable Go template processing in
+ Atmos stack manifests when executing the
+ command: atmos describe stacks
+ --process-templates=false (default "true")
+
+ --sections string Output only the specified component
+ sections: atmos describe stacks
+ --sections=vars,settings. Available
+ component sections: backend, backend_type,
+ deps, env, inheritance, metadata,
+ remote_state_backend,
+ remote_state_backend_type, settings, vars
+
+ -s, --stack string Filter by a specific stack: atmos describe
+ stacks -s <stack>
+ The filter supports names of the top-level
+ stack manifests (including subfolder paths),
+ and 'atmos' stack names (derived from the
+ context vars)
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-describe-workflows--help.html b/website/src/components/Screengrabs/atmos-describe-workflows--help.html
index b5f3d7c6a9..0edd1d186d 100644
--- a/website/src/components/Screengrabs/atmos-describe-workflows--help.html
+++ b/website/src/components/Screengrabs/atmos-describe-workflows--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes 'atmos describe workflows' CLI command
@@ -27,14 +27,34 @@
Flags:
- -f, --format string Specify the output format: atmos describe workflows --format=<yaml|json> ('yaml' is default) (default "yaml")
- -h, --help help for workflows
- -o, --output string Specify the output type: atmos describe workflows --output=<list|map|all> ('list' is default) (default "list")
+ -f, --format string Specify the output format: atmos describe workflows
+ --format=<yaml|json> ('yaml' is default) (default
+ "yaml")
+
+ -h, --help help for workflows (default "false")
+
+ -o, --output string Specify the output type: atmos describe workflows
+ --output=<list|map|all> ('list' is default) (default
+ "list")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-docs--help.html b/website/src/components/Screengrabs/atmos-docs--help.html
index 5dfd23dca8..1235d4d300 100644
--- a/website/src/components/Screengrabs/atmos-docs--help.html
+++ b/website/src/components/Screengrabs/atmos-docs--help.html
@@ -1,12 +1,12 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
-This command opens the Atmos docs
+This command opens the Atmos docs or displays the documentation for a specified Atmos component.
Usage:
@@ -16,17 +16,31 @@
Examples:
-atmos docs
+atmos docs vpc
Flags:
- -h, --help help for docs
+ -h, --help help for docs (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+
diff --git a/website/src/components/Screengrabs/atmos-helmfile--help.html b/website/src/components/Screengrabs/atmos-helmfile--help.html
index f12135d13b..cf0bbfeeef 100644
--- a/website/src/components/Screengrabs/atmos-helmfile--help.html
+++ b/website/src/components/Screengrabs/atmos-helmfile--help.html
@@ -1,12 +1,12 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
-'atmos' supports all native 'helmfile' commands.
+Atmos supports all native 'helmfile' commands.
In addition, the 'component' argument and 'stack' flag are required to generate the variables and backend config for the component in the stack.
@@ -18,65 +18,4 @@
- 'atmos helmfile' commands support '[global options]' using the command-line flag '--global-options'. Usage: atmos helmfile <command> <component> -s <stack> [command options] [arguments] --global-options="--no-color --namespace=test"
- before executing the 'helmfile' commands, 'atmos' runs 'aws eks update-kubeconfig' to read kubeconfig from the EKS cluster and use it to authenticate with the cluster. This can be disabled in 'atmos.yaml' CLI config by setting 'components.helmfile.use_eks' to 'false'
- double-dash '--' can be used to signify the end of the options for Atmos and the start of the additional native arguments and flags for the 'helmfile' commands
-
-Declaratively deploy your Kubernetes manifests, Kustomize configs, and Charts as Helm releases in one shot
-V1 mode = false
-YAML library = gopkg.in/yaml.v3
-
-Usage:
- helmfile [command]
-
-Available Commands:
- apply Apply all resources from state file only when there are changes
- build Build all resources from state file
- cache Cache management
- charts DEPRECATED: sync releases from state file (helm upgrade --install)
- completion Generate the autocompletion script for the specified shell
- delete DEPRECATED: delete releases from state file (helm delete)
- deps Update charts based on their requirements
- destroy Destroys and then purges releases
- diff Diff releases defined in state file
- fetch Fetch charts from state file
- help Help about any command
- init Initialize the helmfile, includes version checking and installation of helm and plug-ins
- lint Lint charts from state file (helm lint)
- list List releases defined in state file
- repos Add chart repositories defined in state file
- status Retrieve status of releases in state file
- sync Sync releases defined in state file
- template Template releases defined in state file
- test Test charts from state file (helm test)
- version Print the CLI version
- write-values Write values files for releases. Similar to `helmfile template`, write values files instead of manifests.
-
-Flags:
- --allow-no-matching-release Do not exit with an error code if the provided selector has no matching releases.
- -c, --chart string Set chart. Uses the chart set in release by default, and is available in template as {{ .Chart }}
- --color Output with color
- --debug Enable verbose output for Helm and set log-level to debug, this disables --quiet/-q effect
- --disable-force-update do not force helm repos to update when executing "helm repo add"
- --enable-live-output Show live output from the Helm binary Stdout/Stderr into Helmfile own Stdout/Stderr.
- It only applies for the Helm CLI commands, Stdout/Stderr for Hooks are still displayed only when it's execution finishes.
- -e, --environment string specify the environment name. Overrides "HELMFILE_ENVIRONMENT" OS environment variable when specified. defaults to "default"
- -f, --file helmfile.yaml load config from file or directory. defaults to "helmfile.yaml" or "helmfile.yaml.gotmpl" or "helmfile.d" (means "helmfile.d/*.yaml" or "helmfile.d/*.yaml.gotmpl") in this preference. Specify - to load the config from the standard input.
- -b, --helm-binary string Path to the helm binary (default "helm")
- -h, --help help for helmfile
- -i, --interactive Request confirmation before attempting to modify clusters
- --kube-context string Set kubectl context. Uses current context by default
- -k, --kustomize-binary string Path to the kustomize binary (default "kustomize")
- --log-level string Set log level, default info (default "info")
- -n, --namespace string Set namespace. Uses the namespace set in the context by default, and is available in templates as {{ .Namespace }}
- --no-color Output without color
- -q, --quiet Silence output. Equivalent to log-level warn
- -l, --selector stringArray Only run using the releases that match labels. Labels can take the form of foo=bar or foo!=bar.
- A release must match all labels in a group in order to be used. Multiple groups can be specified at once.
- "--selector tier=frontend,tier!=proxy --selector tier=backend" will match all frontend, non-proxy releases AND all backend releases.
- The name of a release can be used as a label: "--selector name=myrelease"
- --skip-deps skip running "helm repo update" and "helm dependency build"
- --state-values-file stringArray specify state values in a YAML file. Used to override .Values within the helmfile template (not values template).
- --state-values-set stringArray set state values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2). Used to override .Values within the helmfile template (not values template).
- --state-values-set-string stringArray set state STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2). Used to override .Values within the helmfile template (not values template).
- --strip-args-values-on-exit-error Strip the potential secret values of the helm command args contained in a helmfile error message (default true)
- -v, --version version for helmfile
-
-Use "helmfile [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-helmfile-generate--help.html b/website/src/components/Screengrabs/atmos-helmfile-generate--help.html
index 7af724d39a..2adce40b4f 100644
--- a/website/src/components/Screengrabs/atmos-helmfile-generate--help.html
+++ b/website/src/components/Screengrabs/atmos-helmfile-generate--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates configurations for helmfile components
@@ -16,21 +16,37 @@
Available Commands:
- varfile Execute 'helmfile generate varfile' command
+ varfile Execute 'helmfile generate varfile' command
Flags:
- -h, --help help for generate
+ -h, --help help for generate (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
- -s, --stack string atmos helmfile <helmfile_command> <component> -s <stack>
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+ -s, --stack string atmos helmfile <helmfile_command>
+ <component> -s <stack>
Use "atmos helmfile generate [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-helmfile-generate-varfile--help.html b/website/src/components/Screengrabs/atmos-helmfile-generate-varfile--help.html
index 86064bc93c..cae4d1117c 100644
--- a/website/src/components/Screengrabs/atmos-helmfile-generate-varfile--help.html
+++ b/website/src/components/Screengrabs/atmos-helmfile-generate-varfile--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates a varfile for an atmos helmfile component: atmos helmfile generate varfile <component> -s <stack> -f <file>
@@ -16,14 +16,31 @@
Flags:
- -f, --file string atmos helmfile generate varfile <component> -s <stack> -f <file>
- -h, --help help for varfile
- -s, --stack string atmos helmfile generate varfile <component> -s <stack>
+ -f, --file string atmos helmfile generate varfile <component> -s <stack>
+ -f <file>
+
+ -h, --help help for varfile (default "false")
+
+ -s, --stack string atmos helmfile generate varfile <component> -s <stack>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-pro-lock--help.html b/website/src/components/Screengrabs/atmos-pro-lock--help.html
new file mode 100644
index 0000000000..8757de8ee3
--- /dev/null
+++ b/website/src/components/Screengrabs/atmos-pro-lock--help.html
@@ -0,0 +1,51 @@
+
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
+
+This command calls the atmos pro API and locks a stack
+
+
+Usage:
+
+ atmos pro lock [flags]
+
+
+Flags:
+
+ -c, --component string Specify the Atmos component to lock
+
+ -h, --help help for lock (default "false")
+
+ -m, --message string The lock message to display if someone else tries
+ to lock the stack. Defaults to 'Locked by Atmos'
+
+ -s, --stack string Specify the Atmos stack to lock
+
+ -t, --ttl int32 The amount of time in seconds to lock the stack
+ for. Defaults to 30 (default "0")
+
+
+Global Flags:
+
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+
diff --git a/website/src/components/Screengrabs/atmos-pro-unlock--help.html b/website/src/components/Screengrabs/atmos-pro-unlock--help.html
new file mode 100644
index 0000000000..2ea5e95487
--- /dev/null
+++ b/website/src/components/Screengrabs/atmos-pro-unlock--help.html
@@ -0,0 +1,45 @@
+
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
+
+This command calls the atmos pro API and unlocks a stack
+
+
+Usage:
+
+ atmos pro unlock [flags]
+
+
+Flags:
+
+ -c, --component string Specify the Atmos component to lock
+
+ -h, --help help for unlock (default "false")
+
+ -s, --stack string Specify the Atmos stack to lock
+
+
+Global Flags:
+
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+
diff --git a/website/src/components/Screengrabs/atmos-terraform--help.html b/website/src/components/Screengrabs/atmos-terraform--help.html
index 5142abd4e0..004a288eab 100644
--- a/website/src/components/Screengrabs/atmos-terraform--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform--help.html
@@ -1,12 +1,12 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
-'atmos' supports all native 'terraform' commands.
+Atmos supports all native 'terraform' commands.
In addition, the 'component' argument and 'stack' flag are required to generate the variables and backend config for the component in the stack.
@@ -20,8 +20,13 @@
- 'atmos terraform deploy' command supports '--deploy-run-init=true/false' flag to enable/disable running 'terraform init' before executing the command
- 'atmos terraform apply' and 'atmos terraform deploy' commands support '--from-plan' flag. If the flag is specified, the commands will use the planfile previously generated by 'atmos terraform plan' command instead of generating a new planfile
- 'atmos terraform apply' and 'atmos terraform deploy' commands commands support '--planfile' flag to specify the path to a planfile. The '--planfile' flag should be used instead of the planfile argument in the native 'terraform apply <planfile>' command
- - 'atmos terraform clean' command deletes the '.terraform' folder, '.terraform.lock.hcl' lock file, and the previously generated 'planfile', 'varfile' and 'backend.tf.json' file for the specified component and stack. Use --skip-lock-file flag to skip deleting the lock file.
- - 'atmos terraform clean' command supports '--everything' flag to delete all the Terraform state files and directories for all components and stacks . Use --force flag to skip the confirmation prompt.
+ - 'atmos terraform clean' command deletes the '.terraform' folder, '.terraform.lock.hcl' lock file, and the previously generated 'planfile', 'varfile', and 'backend.tf.json' file for the specified component and stack. Use the --everything flag to also delete the Terraform state files and directories for the component. Note: State files store the local state of your infrastructure and should be handled with care, if not using a remote backend.
+
+Additional flags:
+ --force Forcefully delete Terraform state files and directories without interaction
+ --skip-lock-file Skip deleting the '.terraform.lock.hcl' file
+
+If no component or stack is specified, the clean operation will apply globally to all components.
- 'atmos terraform workspace' command first runs 'terraform init -reconfigure', then 'terraform workspace select', and if the workspace was not created before, it then runs 'terraform workspace new'
- 'atmos terraform import' command searches for 'region' in the variables for the specified component and stack, and if it finds it, sets 'AWS_REGION=<region>' ENV var before executing the command
- 'atmos terraform generate backend' command generates a backend config file for an 'atmos' component in a stack
@@ -29,44 +34,7 @@
- 'atmos terraform generate varfile' command generates a varfile for an 'atmos' component in a stack
- 'atmos terraform generate varfiles' command generates varfiles for all 'atmos' components in all stacks
- 'atmos terraform shell' command configures an environment for an 'atmos' component in a stack and starts a new shell allowing executing all native terraform commands inside the shell without using atmos-specific arguments and flags
- - `--append-user-agent` flag allows you to customize the User-Agent string appended to Terraform requests for enhanced observability and traceability.
- double-dash '--' can be used to signify the end of the options for Atmos and the start of the additional native arguments and flags for the 'terraform' commands. For example: atmos terraform plan <component> -s <stack> -- -refresh=false -lock=false
+ - '--append-user-agent' flag sets the TF_APPEND_USER_AGENT environment variable to customize the User-Agent string in Terraform provider requests. Example: 'Atmos/1.130.0 (Cloud Posse; +https://atmos.tools)'. If not specified, defaults to 'atmos 1.130.0'
-Usage: terraform [global options] <subcommand> [args]
-
-The available commands for execution are listed below.
-The primary workflow commands are given first, followed by
-less common or more advanced commands.
-
-Main commands:
- init Prepare your working directory for other commands
- validate Check whether the configuration is valid
- plan Show changes required by the current configuration
- apply Create or update infrastructure
- destroy Destroy previously-created infrastructure
-
-All other commands:
- console Try Terraform expressions at an interactive command prompt
- fmt Reformat your configuration in the standard style
- force-unlock Release a stuck lock on the current workspace
- get Install or upgrade remote Terraform modules
- graph Generate a Graphviz graph of the steps in an operation
- import Associate existing infrastructure with a Terraform resource
- login Obtain and save credentials for a remote host
- logout Remove locally-stored credentials for a remote host
- output Show output values from your root module
- providers Show the providers required for this configuration
- refresh Update the state to match remote systems
- show Show the current state or a saved plan
- state Advanced state management
- taint Mark a resource instance as not fully functional
- test Experimental support for module integration testing
- untaint Remove the 'tainted' state from a resource instance
- version Show the current Terraform version
- workspace Workspace management
-
-Global options (use these before the subcommand, if any):
- -chdir=DIR Switch to a different working directory before executing the
- given subcommand.
- -help Show this help output, or the help for a specified subcommand.
- -version An alias for the "version" subcommand.
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-clean--help.html b/website/src/components/Screengrabs/atmos-terraform-clean--help.html
index 7d5710b438..93b854a64e 100644
--- a/website/src/components/Screengrabs/atmos-terraform-clean--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-clean--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
'atmos terraform clean' command deletes the following folders and files from the component's directory:
@@ -15,10 +15,20 @@
- generated varfile for the component in the stack
- generated planfile for the component in the stack
- generated 'backend.tf.json' file
+ - 'terraform.tfstate.d' folder (if '--everything' flag is used)
Usage: atmos terraform clean <component> -s <stack> <flags>
-Use '--everything' flag to delete all the files and folders mentioned above. '--force' to delete the files without confirmation.
-Use '--skip-lock-file' flag to skip deleting the lock file.
+
+Use '--everything' flag to also delete the Terraform state files and and directories with confirm message.
+
+Use --force to forcefully delete Terraform state files and directories for the component.
+
+- If no component is specified, the command will apply to all components and stacks.
+- If no stack is specified, the command will apply to all stacks for the specified component.
+Use '--skip-lock-file' flag to skip deleting the '.terraform.lock.hcl' file.
+
+If no component or stack is specified, the clean operation will apply globally to all components.
For more details refer to https://atmos.tools/cli/commands/terraform/clean
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-deploy--help.html b/website/src/components/Screengrabs/atmos-terraform-deploy--help.html
index ca020814ad..4789ded1da 100644
--- a/website/src/components/Screengrabs/atmos-terraform-deploy--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-deploy--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
'atmos terraform deploy' command executes 'terraform apply -auto-approve' on an Atmos component in an Atmos stack.
@@ -23,3 +23,4 @@
For more details refer to https://atmos.tools/cli/commands/terraform/deploy
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-generate--help.html b/website/src/components/Screengrabs/atmos-terraform-generate--help.html
index 95ea75078d..cc4874b962 100644
--- a/website/src/components/Screengrabs/atmos-terraform-generate--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-generate--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates configurations for terraform components
@@ -16,24 +16,40 @@
Available Commands:
- backend Execute 'terraform generate backend' command
- backends Execute 'terraform generate backends' command
- varfile Execute 'terraform generate varfile' command
- varfiles Execute 'terraform generate varfiles' command
+ backend Execute 'terraform generate backend' command
+ backends Execute 'terraform generate backends' command
+ varfile Execute 'terraform generate varfile' command
+ varfiles Execute 'terraform generate varfiles' command
Flags:
- -h, --help help for generate
+ -h, --help help for generate (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
- -s, --stack string atmos terraform <terraform_command> <component> -s <stack>
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+ -s, --stack string atmos terraform <terraform_command>
+ <component> -s <stack>
Use "atmos terraform generate [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-generate-backend--help.html b/website/src/components/Screengrabs/atmos-terraform-generate-backend--help.html
index 8df2f180e1..59a87e8c32 100644
--- a/website/src/components/Screengrabs/atmos-terraform-generate-backend--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-generate-backend--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates the backend config for a terraform component: atmos terraform generate backend <component> -s <stack>
@@ -16,13 +16,29 @@
Flags:
- -h, --help help for backend
- -s, --stack string atmos terraform generate backend <component> -s <stack>
+ -h, --help help for backend (default "false")
+
+ -s, --stack string atmos terraform generate backend <component> -s
+ <stack>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-generate-backends--help.html b/website/src/components/Screengrabs/atmos-terraform-generate-backends--help.html
index 55ae2d5d54..b55c9e149e 100644
--- a/website/src/components/Screengrabs/atmos-terraform-generate-backends--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-generate-backends--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates backend configs for all terraform components
@@ -16,35 +16,94 @@
Flags:
- --components string Only generate the backend files for the specified 'atmos' components (comma-separated values).
- atmos terraform generate backends --file-template <file_template> --components <component1>,<component2>
- --file-template string Backend file template (the file path, file name, and file extension).
- Supports absolute and relative paths.
- Supports context tokens: {namespace}, {tenant}, {environment}, {region}, {stage}, {base-component}, {component}, {component-path}.
- atmos terraform generate backends --file-template {component-path}/{tenant}/{environment}-{stage}.tf.json --format json
- atmos terraform generate backends --file-template {component-path}/backends/{tenant}-{environment}-{stage}.tf.json --format json
- atmos terraform generate backends --file-template backends/{tenant}/{environment}/{region}/{component}.tf --format hcl
- atmos terraform generate backends --file-template backends/{tenant}-{environment}-{stage}-{component}.tf
- atmos terraform generate backends --file-template /{tenant}/{stage}/{region}/{component}.tf
- atmos terraform generate backends --file-template backends/{tenant}-{environment}-{stage}-{component}.tfbackend --format backend-config
- All subdirectories in the path will be created automatically
- If '--file-template' flag is not specified, all backend config files will be written to the corresponding terraform component folders.
- --format string Output format.
- Supported formats: 'hcl', 'json', 'backend-config' ('hcl' is default).
- atmos terraform generate backends --format=hcl|json|backend-config (default "hcl")
- -h, --help help for backends
- --stacks string Only process the specified stacks (comma-separated values).
- atmos terraform generate backends --file-template <file_template> --stacks <stack1>,<stack2>
- The filter can contain names of the top-level stack manifests (including subfolder paths), and 'atmos' stack names (derived from the context vars)
- atmos terraform generate backends --stacks orgs/cp/tenant1/staging/us-east-2,orgs/cp/tenant2/dev/us-east-2
- atmos terraform generate backends --stacks tenant1-ue2-staging,tenant1-ue2-prod
- atmos terraform generate backends --stacks orgs/cp/tenant1/staging/us-east-2,tenant1-ue2-prod
+ --components string Only generate the backend files for the
+ specified 'atmos' components (comma-separated
+ values).
+ atmos terraform generate backends
+ --file-template <file_template> --components
+ <component1>,<component2>
+
+ --file-template string Backend file template (the file path, file
+ name, and file extension).
+ Supports absolute and relative paths.
+ Supports context tokens: {namespace},
+ {tenant}, {environment}, {region}, {stage},
+ {base-component}, {component},
+ {component-path}.
+ atmos terraform generate backends
+ --file-template
+ {component-path}/{tenant}/{environment}-{stage}.tf.json
+ --format json
+ atmos terraform generate backends
+ --file-template
+ {component-path}/backends/{tenant}-{environment}-{stage}.tf.json
+ --format json
+ atmos terraform generate backends
+ --file-template
+ backends/{tenant}/{environment}/{region}/{component}.tf
+ --format hcl
+ atmos terraform generate backends
+ --file-template
+ backends/{tenant}-{environment}-{stage}-{component}.tf
+ atmos terraform generate backends
+ --file-template
+ /{tenant}/{stage}/{region}/{component}.tf
+ atmos terraform generate backends
+ --file-template
+ backends/{tenant}-{environment}-{stage}-{component}.tfbackend
+ --format backend-config
+ All subdirectories in the path will be created
+ automatically
+ If '--file-template' flag is not specified,
+ all backend config files will be written to
+ the corresponding terraform component folders.
+
+ --format string Output format.
+ Supported formats: 'hcl', 'json',
+ 'backend-config' ('hcl' is default).
+ atmos terraform generate backends
+ --format=hcl|json|backend-config (default
+ "hcl")
+
+ -h, --help help for backends (default "false")
+
+ --stacks string Only process the specified stacks
+ (comma-separated values).
+ atmos terraform generate backends
+ --file-template <file_template> --stacks
+ <stack1>,<stack2>
+ The filter can contain names of the top-level
+ stack manifests (including subfolder paths),
+ and 'atmos' stack names (derived from the
+ context vars)
+ atmos terraform generate backends --stacks
+ orgs/cp/tenant1/staging/us-east-2,orgs/cp/tenant2/dev/us-east-2
+ atmos terraform generate backends --stacks
+ tenant1-ue2-staging,tenant1-ue2-prod
+ atmos terraform generate backends --stacks
+ orgs/cp/tenant1/staging/us-east-2,tenant1-ue2-prod
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
- -s, --stack string atmos terraform <terraform_command> <component> -s <stack>
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+ -s, --stack string atmos terraform <terraform_command>
+ <component> -s <stack>
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-generate-varfile--help.html b/website/src/components/Screengrabs/atmos-terraform-generate-varfile--help.html
index b3d5976658..c3f57c2545 100644
--- a/website/src/components/Screengrabs/atmos-terraform-generate-varfile--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-generate-varfile--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates a varfile for an atmos terraform component: atmos terraform generate varfile <component> -s <stack> -f <file>
@@ -16,14 +16,32 @@
Flags:
- -f, --file string atmos terraform generate varfile <component> -s <stack> -f <file>
- -h, --help help for varfile
- -s, --stack string atmos terraform generate varfile <component> -s <stack>
+ -f, --file string atmos terraform generate varfile <component> -s
+ <stack> -f <file>
+
+ -h, --help help for varfile (default "false")
+
+ -s, --stack string atmos terraform generate varfile <component> -s
+ <stack>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-generate-varfiles--help.html b/website/src/components/Screengrabs/atmos-terraform-generate-varfiles--help.html
index 07651bd3bc..dde99b8c2e 100644
--- a/website/src/components/Screengrabs/atmos-terraform-generate-varfiles--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-generate-varfiles--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command generates varfiles for all atmos terraform components in all stacks
@@ -16,31 +16,79 @@
Flags:
- --components string Generate Terraform '.tfvar' files only for the specified 'atmos' components (use comma-separated values to specify multiple components).
- atmos terraform generate varfiles --file-template <file_template> --components <component1>,<component2>
- --file-template string Varfile template (the file path, file name, and file extension).
- Supports absolute and relative paths.
- Supports context tokens: {namespace}, {tenant}, {environment}, {region}, {stage}, {base-component}, {component}, {component-path}.
- atmos terraform generate varfiles --file-template {component-path}/{environment}-{stage}.tfvars.json
- atmos terraform generate varfiles --file-template /configs/{tenant}/{environment}/{stage}/{component}.json
- atmos terraform generate varfiles --file-template /{tenant}/{stage}/{region}/{component}.yaml
- All subdirectories in the path will be created automatically.
- --format string Output format.
- Supported formats: json, yaml, hcl ('json' is default).
- atmos terraform generate varfiles --file-template <file_template> --format=json|yaml|hcl (default "json")
- -h, --help help for varfiles
- --stacks string Only process the specified stacks (comma-separated values).
- atmos terraform generate varfiles --file-template <file_template> --stacks <stack1>,<stack2>
- The filter can contain names of the top-level stack manifests (including subfolder paths), and 'atmos' stack names (derived from the context vars)
- atmos terraform generate varfiles --stacks orgs/cp/tenant1/staging/us-east-2,orgs/cp/tenant2/dev/us-east-2
- atmos terraform generate varfiles --stacks tenant1-ue2-staging,tenant1-ue2-prod
- atmos terraform generate varfiles --stacks orgs/cp/tenant1/staging/us-east-2,tenant1-ue2-prod
+ --components string Generate Terraform '.tfvar' files only for the
+ specified 'atmos' components (use
+ comma-separated values to specify multiple
+ components).
+ atmos terraform generate varfiles
+ --file-template <file_template> --components
+ <component1>,<component2>
+
+ --file-template string Varfile template (the file path, file name,
+ and file extension).
+ Supports absolute and relative paths.
+ Supports context tokens: {namespace},
+ {tenant}, {environment}, {region}, {stage},
+ {base-component}, {component},
+ {component-path}.
+ atmos terraform generate varfiles
+ --file-template
+ {component-path}/{environment}-{stage}.tfvars.json
+ atmos terraform generate varfiles
+ --file-template
+ /configs/{tenant}/{environment}/{stage}/{component}.json
+ atmos terraform generate varfiles
+ --file-template
+ /{tenant}/{stage}/{region}/{component}.yaml
+ All subdirectories in the path will be created
+ automatically.
+
+ --format string Output format.
+ Supported formats: json, yaml, hcl ('json' is
+ default).
+ atmos terraform generate varfiles
+ --file-template <file_template>
+ --format=json|yaml|hcl (default "json")
+
+ -h, --help help for varfiles (default "false")
+
+ --stacks string Only process the specified stacks
+ (comma-separated values).
+ atmos terraform generate varfiles
+ --file-template <file_template> --stacks
+ <stack1>,<stack2>
+ The filter can contain names of the top-level
+ stack manifests (including subfolder paths),
+ and 'atmos' stack names (derived from the
+ context vars)
+ atmos terraform generate varfiles --stacks
+ orgs/cp/tenant1/staging/us-east-2,orgs/cp/tenant2/dev/us-east-2
+ atmos terraform generate varfiles --stacks
+ tenant1-ue2-staging,tenant1-ue2-prod
+ atmos terraform generate varfiles --stacks
+ orgs/cp/tenant1/staging/us-east-2,tenant1-ue2-prod
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
- -s, --stack string atmos terraform <terraform_command> <component> -s <stack>
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
+ -s, --stack string atmos terraform <terraform_command>
+ <component> -s <stack>
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-shell--help.html b/website/src/components/Screengrabs/atmos-terraform-shell--help.html
index c96375fd06..cfba4652da 100644
--- a/website/src/components/Screengrabs/atmos-terraform-shell--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-shell--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
'atmos terraform shell' command starts a new SHELL configured with the environment for an Atmos component in a Stack to allow executing all native terraform commands
@@ -22,3 +22,4 @@
For more details refer to https://atmos.tools/cli/commands/terraform/shell
+
diff --git a/website/src/components/Screengrabs/atmos-terraform-workspace--help.html b/website/src/components/Screengrabs/atmos-terraform-workspace--help.html
index f9cb24ab5d..26ab65f7b4 100644
--- a/website/src/components/Screengrabs/atmos-terraform-workspace--help.html
+++ b/website/src/components/Screengrabs/atmos-terraform-workspace--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
'atmos terraform workspace' command calculates the Terraform workspace for an Atmos component,
@@ -15,3 +15,4 @@
For more details refer to https://atmos.tools/cli/commands/terraform/workspace
+
diff --git a/website/src/components/Screengrabs/atmos-validate--help.html b/website/src/components/Screengrabs/atmos-validate--help.html
index 258efa72d2..5644653f27 100644
--- a/website/src/components/Screengrabs/atmos-validate--help.html
+++ b/website/src/components/Screengrabs/atmos-validate--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command validates stacks and components
@@ -16,21 +16,35 @@
Available Commands:
- component Execute 'validate component' command
- stacks Execute 'validate stacks' command
+ component Execute 'validate component' command
+ stacks Execute 'validate stacks' command
Flags:
- -h, --help help for validate
+ -h, --help help for validate (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos validate [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-validate-component--help.html b/website/src/components/Screengrabs/atmos-validate-component--help.html
index db7d2c7cde..53285edda3 100644
--- a/website/src/components/Screengrabs/atmos-validate-component--help.html
+++ b/website/src/components/Screengrabs/atmos-validate-component--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command validates an atmos component in a stack using Json Schema or OPA policies: atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type <jsonschema|opa>
@@ -23,17 +23,47 @@
Flags:
- -h, --help help for component
- --module-paths strings atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type opa --module-paths catalog
- --schema-path string atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type <jsonschema|opa>
- --schema-type string atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type <jsonschema|opa>
- -s, --stack string atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type <jsonschema|opa>
- --timeout int Validation timeout in seconds: atmos validate component <component> -s <stack> --timeout 15
+ -h, --help help for component (default "false")
+
+ --module-paths stringSlice atmos validate component <component> -s
+ <stack> --schema-path <schema_path>
+ --schema-type opa --module-paths catalog
+ (default "[]")
+
+ --schema-path string atmos validate component <component> -s
+ <stack> --schema-path <schema_path>
+ --schema-type <jsonschema|opa>
+
+ --schema-type string atmos validate component <component> -s
+ <stack> --schema-path <schema_path>
+ --schema-type <jsonschema|opa>
+
+ -s, --stack string atmos validate component <component> -s
+ <stack> --schema-path <schema_path>
+ --schema-type <jsonschema|opa>
+
+ --timeout int Validation timeout in seconds: atmos
+ validate component <component> -s <stack>
+ --timeout 15 (default "0")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-validate-stacks--help.html b/website/src/components/Screengrabs/atmos-validate-stacks--help.html
index 5201eff9bc..024dab114b 100644
--- a/website/src/components/Screengrabs/atmos-validate-stacks--help.html
+++ b/website/src/components/Screengrabs/atmos-validate-stacks--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command validates stack manifest configurations: atmos validate stacks
@@ -21,13 +21,30 @@
Flags:
- -h, --help help for stacks
- --schemas-atmos-manifest string atmos validate stacks --schemas-atmos-manifest <path-to-atmos-json-schema>
+ -h, --help help for stacks (default "false")
+
+ --schemas-atmos-manifest string atmos validate stacks
+ --schemas-atmos-manifest
+ <path-to-atmos-json-schema>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-vendor--help.html b/website/src/components/Screengrabs/atmos-vendor--help.html
index f1a6a70653..8458aab58c 100644
--- a/website/src/components/Screengrabs/atmos-vendor--help.html
+++ b/website/src/components/Screengrabs/atmos-vendor--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes 'atmos vendor' CLI commands
@@ -16,20 +16,34 @@
Available Commands:
- pull Execute 'vendor pull' commands
+ pull Execute 'vendor pull' commands
Flags:
- -h, --help help for vendor
+ -h, --help help for vendor (default "false")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
Use "atmos vendor [command] --help" for more information about a command.
+
diff --git a/website/src/components/Screengrabs/atmos-vendor-pull--help.html b/website/src/components/Screengrabs/atmos-vendor-pull--help.html
index 5bd864b6d8..f69e697442 100644
--- a/website/src/components/Screengrabs/atmos-vendor-pull--help.html
+++ b/website/src/components/Screengrabs/atmos-vendor-pull--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes 'atmos vendor pull' CLI commands
@@ -16,17 +16,44 @@
Flags:
- -c, --component string Only vendor the specified component: atmos vendor pull --component <component>
- --dry-run atmos vendor pull --component <component> --dry-run
- -h, --help help for pull
- -s, --stack string Only vendor the specified stack: atmos vendor pull --stack <stack>
- --tags string Only vendor the components that have the specified tags: atmos vendor pull --tags=dev,test
- -t, --type string atmos vendor pull --component <component> --type=terraform|helmfile (default "terraform")
+ -c, --component string Only vendor the specified component: atmos vendor
+ pull --component <component>
+
+ --dry-run atmos vendor pull --component <component>
+ --dry-run (default "false")
+
+ --everything Vendor all components: atmos vendor pull
+ --everything (default "false")
+
+ -h, --help help for pull (default "false")
+
+ -s, --stack string Only vendor the specified stack: atmos vendor pull
+ --stack <stack>
+
+ --tags string Only vendor the components that have the specified
+ tags: atmos vendor pull --tags=dev,test
+
+ -t, --type string atmos vendor pull --component <component>
+ --type=terraform|helmfile (default "terraform")
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/atmos-version.html b/website/src/components/Screengrabs/atmos-version.html
index 27592995dd..13b15dc7bc 100644
--- a/website/src/components/Screengrabs/atmos-version.html
+++ b/website/src/components/Screengrabs/atmos-version.html
@@ -1,21 +1,11 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
-👽 Atmos 1.62.0 on darwin/arm64
-
-
-Your version of Atmos is out of date. The latest version is 1.63.0
-
-To upgrade Atmos, refer to the following links and documents:
-
-Atmos Releases:
-https://github.com/cloudposse/atmos/releases
-
-Install Atmos:
-https://atmos.tools/install
+👽 Atmos 1.130.0 on linux/amd64
+
diff --git a/website/src/components/Screengrabs/atmos-workflow--help.html b/website/src/components/Screengrabs/atmos-workflow--help.html
index a0a594519c..5a4c65b4da 100644
--- a/website/src/components/Screengrabs/atmos-workflow--help.html
+++ b/website/src/components/Screengrabs/atmos-workflow--help.html
@@ -1,10 +1,10 @@
- █████ ████████ ███ ███ ██████ ███████
-██ ██ ██ ████ ████ ██ ██ ██
-███████ ██ ██ ████ ██ ██ ██ ███████
-██ ██ ██ ██ ██ ██ ██ ██ ██
-██ ██ ██ ██ ██ ██████ ███████
-
+ █████ ████████ ███ ███ ██████ ███████
+██ ██ ██ ████ ████ ██ ██ ██
+███████ ██ ██ ████ ██ ██ ██ ███████
+██ ██ ██ ██ ██ ██ ██ ██ ██
+██ ██ ██ ██ ██ ██████ ███████
+
This command executes a workflow: atmos workflow <name> -f <file>
@@ -19,21 +19,46 @@
atmos workflow
atmos workflow <name> -f <file>
atmos workflow <name> -f <file> -s <stack>
-atmos workflow <name> -f <file> --from-step <step-name>
+atmos workflow <name> -f <file> --from-step <step-name>
+
+To resume the workflow from this step, run:
+atmos workflow deploy-infra -f workflow1 --from-step deploy-vpc
+
+For more details refer to https://atmos.tools/cli/commands/workflow/
Flags:
- --dry-run atmos workflow <name> -f <file> --dry-run
- -f, --file string atmos workflow <name> -f <file>
- --from-step string atmos workflow <name> -f <file> --from-step <step-name>
- -h, --help help for workflow
- -s, --stack string atmos workflow <name> -f <file> -s <stack>
+ --dry-run atmos workflow <name> -f <file> --dry-run (default
+ "false")
+
+ -f, --file string atmos workflow <name> -f <file>
+
+ --from-step string atmos workflow <name> -f <file> --from-step
+ <step-name>
+
+ -h, --help help for workflow (default "false")
+
+ -s, --stack string atmos workflow <name> -f <file> -s <stack>
Global Flags:
- --logs-file string The file to write Atmos logs to. Logs can be written to any file or any standard file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default "/dev/stdout")
- --logs-level string Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log level is set to Off, Atmos will not log any messages (default "Info")
- --redirect-stderr string File descriptor to redirect 'stderr' to. Errors can be redirected to any file or any standard file descriptor (including '/dev/null'): atmos <command> --redirect-stderr /dev/stdout
+ --logs-file string The file to write Atmos logs to. Logs can be
+ written to any file or any standard file
+ descriptor, including '/dev/stdout',
+ '/dev/stderr' and '/dev/null' (default
+ "/dev/stdout")
+
+ --logs-level string Logs level. Supported log levels are Trace,
+ Debug, Info, Warning, Off. If the log level
+ is set to Off, Atmos will not log any
+ messages (default "Info")
+
+ --redirect-stderr string File descriptor to redirect 'stderr' to.
+ Errors can be redirected to any file or any
+ standard file descriptor (including
+ '/dev/null'): atmos <command>
+ --redirect-stderr /dev/stdout
+
diff --git a/website/src/components/Screengrabs/demo-stacks/define-your-stacks.html b/website/src/components/Screengrabs/demo-stacks/define-your-stacks.html
index f0fba42dd4..a0321d8717 100644
--- a/website/src/components/Screengrabs/demo-stacks/define-your-stacks.html
+++ b/website/src/components/Screengrabs/demo-stacks/define-your-stacks.html
@@ -1,102 +1,50 @@
->
-> # Here's how simple it is to organize your environments.
-> # (but it's entirely configurable).
->
-> tree stacks
-
-stacks/
-├── catalog/
-│ └── myapp.yaml
-└── deploy/
- ├── dev.yaml
- ├── prod.yaml
- └── staging.yaml
-
-2 directories, 4 files
-
-
->
-> # Start by defining the baseline configuration for myapp.
-> # This is the configuration that you want to import anytime you deploy your component.
->
-> cat stacks/catalog/myapp.yaml
-
-
- File: stacks/catalog/myapp.yaml
- 1 components:
- 2 terraform:
- 3 myapp:
- 4 vars:
- 5 location: Los Angeles
- 6 lang: en
- 7 format: ''
- 8 options: '0'
- 9 units: m
-
-
-
->
-> # Then we define each environment importing that baseline configuration.
-> # Here's how the configuration for the 'dev' environment looks like...
->
-> cat stacks/deploy/dev.yaml
-
-
- File: stacks/deploy/dev.yaml
- 1 vars:
- 2 stage: dev
- 3
- 4 import:
- 5 - catalog/myapp
- 6
- 7 components:
- 8 terraform:
- 9 myapp:
- 10 vars:
- 11 location: Stockholm
- 12 lang: se
-
-
-
->
-> # Define the configuration for the 'staging' environment.
->
-> cat stacks/deploy/staging.yaml
-
-
- File: stacks/deploy/staging.yaml
- 1 vars:
- 2 stage: staging
- 3
- 4 import:
- 5 - catalog/myapp
- 6
- 7 components:
- 8 terraform:
- 9 myapp:
- 10 vars:
- 11 location: Los Angeles
- 12 lang: en
-
-
-
->
-> # Finally, define the configuration for the 'prod' environment...
->
-> cat stacks/deploy/prod.yaml
-
-
- File: stacks/deploy/prod.yaml
- 1 vars:
- 2 stage: prod
- 3
- 4 import:
- 5 - catalog/myapp
- 6
- 7 components:
- 8 terraform:
- 9 myapp:
- 10 vars:
- 11 location: Los Angeles
- 12 lang: en
+>
+> # Here's how simple it is to organize your environments.
+> # (but it's entirely configurable).
+>
+> tree stacks
+
+stacks/
+├── catalog/
+│ └── myapp.yaml
+└── deploy/
+ ├── dev.yaml
+ ├── prod.yaml
+ └── staging.yaml
+
+3 directories, 4 files
+
+
+>
+> # Start by defining the baseline configuration for myapp.
+> # This is the configuration that you want to import anytime you deploy your component.
+>
+> cat stacks/catalog/myapp.yaml
+
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
+
+>
+> # Then we define each environment importing that baseline configuration.
+> # Here's how the configuration for the 'dev' environment looks like...
+>
+> cat stacks/deploy/dev.yaml
+
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
+
+>
+> # Define the configuration for the 'staging' environment.
+>
+> cat stacks/deploy/staging.yaml
+
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
+
+>
+> # Finally, define the configuration for the 'prod' environment...
+>
+> cat stacks/deploy/prod.yaml
+
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
diff --git a/website/src/components/Screengrabs/demo-stacks/deploy-dev.html b/website/src/components/Screengrabs/demo-stacks/deploy-dev.html
index e92299ebfb..e086286bec 100644
--- a/website/src/components/Screengrabs/demo-stacks/deploy-dev.html
+++ b/website/src/components/Screengrabs/demo-stacks/deploy-dev.html
@@ -2,87 +2,6 @@
>
> atmos terraform deploy myapp --stack dev
-
-Initializing the backend...
-
-Initializing provider plugins...
-
-
-Terraform has been successfully initialized!
-data.http.weather: Reading...
-data.http.weather: Read complete after 1s
- [id=https://wttr.in/Stockholm?0&format=&lang=se&u=m]
-
-Terraform used the selected providers to generate the following execution plan.
- + create
-
-Terraform will perform the following actions:
-
- # local_file.cache will be created
- + resource "local_file" "cache" {
- + content =
-
- Weather report: Stockholm
-
- Overcast
- .--. +2(-1) °C
- .-( ). ↑ 11 km/h
- (___.__)__) 6 km
- 0.0 mm
-
-
- + content_base64sha256 = (known after apply)
- + content_base64sha512 = (known after apply)
- + content_md5 = (known after apply)
- + content_sha1 = (known after apply)
- + content_sha256 = (known after apply)
- + content_sha512 = (known after apply)
- + directory_permission = "0777"
- + file_permission = "0777"
- + filename = "cache.dev.txt"
- + id = (known after apply)
- }
-
-Plan: 1 to add, 0 to change, 0 to destroy.
-
-Changes to Outputs:
- + lang = "se"
- + location = "Stockholm"
- + stage = "dev"
- + units = "m"
- + url = "https://wttr.in/Stockholm?0&format=&lang=se&u=m"
- + weather =
-
- Weather report: Stockholm
-
- Overcast
- .--. +2(-1) °C
- .-( ). ↑ 11 km/h
- (___.__)__) 6 km
- 0.0 mm
-
-
-local_file.cache: Creating...
-local_file.cache: Creation complete after 0s
-
-Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-
-Outputs:
-
-lang = "se"
-location = "Stockholm"
-stage = "dev"
-units = "m"
-url = "https://wttr.in/Stockholm?0&format=&lang=se&u=m"
-weather =
-
-Weather report: Stockholm
-
- Overcast
- .--. +2(-1) °C
- .-( ). ↑ 11 km/h
- (___.__)__) 6 km
- 0.0 mm
-
+exec: "terraform": executable file not found in $PATH
+
-
diff --git a/website/src/components/Screengrabs/demo-stacks/deploy-prod.html b/website/src/components/Screengrabs/demo-stacks/deploy-prod.html
index 88be45f1ab..96751d023e 100644
--- a/website/src/components/Screengrabs/demo-stacks/deploy-prod.html
+++ b/website/src/components/Screengrabs/demo-stacks/deploy-prod.html
@@ -2,87 +2,6 @@
>
> atmos terraform deploy myapp --stack prod
-
-Initializing the backend...
-
-Initializing provider plugins...
-
-
-Terraform has been successfully initialized!
-data.http.weather: Reading...
-data.http.weather: Read complete after 0s
- [id=https://wttr.in/Los+Angeles?0&format=&lang=en&u=m]
-
-Terraform used the selected providers to generate the following execution plan.
- + create
-
-Terraform will perform the following actions:
-
- # local_file.cache will be created
- + resource "local_file" "cache" {
- + content =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
- + content_base64sha256 = (known after apply)
- + content_base64sha512 = (known after apply)
- + content_md5 = (known after apply)
- + content_sha1 = (known after apply)
- + content_sha256 = (known after apply)
- + content_sha512 = (known after apply)
- + directory_permission = "0777"
- + file_permission = "0777"
- + filename = "cache.prod.txt"
- + id = (known after apply)
- }
-
-Plan: 1 to add, 0 to change, 0 to destroy.
-
-Changes to Outputs:
- + lang = "en"
- + location = "Los Angeles"
- + stage = "prod"
- + units = "m"
- + url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
- + weather =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
-local_file.cache: Creating...
-local_file.cache: Creation complete after 0s
-
-Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-
-Outputs:
-
-lang = "en"
-location = "Los Angeles"
-stage = "prod"
-units = "m"
-url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
-weather =
-
-Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
+exec: "terraform": executable file not found in $PATH
+
-
diff --git a/website/src/components/Screengrabs/demo-stacks/deploy-staging.html b/website/src/components/Screengrabs/demo-stacks/deploy-staging.html
index 60c0de89e9..c60a9ce25f 100644
--- a/website/src/components/Screengrabs/demo-stacks/deploy-staging.html
+++ b/website/src/components/Screengrabs/demo-stacks/deploy-staging.html
@@ -2,87 +2,6 @@
>
> atmos terraform deploy myapp --stack staging
-
-Initializing the backend...
-
-Initializing provider plugins...
-
-
-Terraform has been successfully initialized!
-data.http.weather: Reading...
-data.http.weather: Read complete after 1s
- [id=https://wttr.in/Los+Angeles?0&format=&lang=en&u=m]
-
-Terraform used the selected providers to generate the following execution plan.
- + create
-
-Terraform will perform the following actions:
-
- # local_file.cache will be created
- + resource "local_file" "cache" {
- + content =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
- + content_base64sha256 = (known after apply)
- + content_base64sha512 = (known after apply)
- + content_md5 = (known after apply)
- + content_sha1 = (known after apply)
- + content_sha256 = (known after apply)
- + content_sha512 = (known after apply)
- + directory_permission = "0777"
- + file_permission = "0777"
- + filename = "cache.staging.txt"
- + id = (known after apply)
- }
-
-Plan: 1 to add, 0 to change, 0 to destroy.
-
-Changes to Outputs:
- + lang = "en"
- + location = "Los Angeles"
- + stage = "staging"
- + units = "m"
- + url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
- + weather =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
-local_file.cache: Creating...
-local_file.cache: Creation complete after 0s
-
-Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-
-Outputs:
-
-lang = "en"
-location = "Los Angeles"
-stage = "staging"
-units = "m"
-url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
-weather =
-
-Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
+exec: "terraform": executable file not found in $PATH
+
-
diff --git a/website/src/components/Screengrabs/demo-stacks/deploy.html b/website/src/components/Screengrabs/demo-stacks/deploy.html
index 6af9c2f5d0..87b4d39f77 100644
--- a/website/src/components/Screengrabs/demo-stacks/deploy.html
+++ b/website/src/components/Screengrabs/demo-stacks/deploy.html
@@ -5,90 +5,8 @@
>
> atmos terraform deploy myapp --stack dev
-
-Initializing the backend...
-
-Initializing provider plugins...
-
-
-Terraform has been successfully initialized!
-data.http.weather: Reading...
-data.http.weather: Read complete after 1s
- [id=https://wttr.in/Stockholm?0&format=&lang=se&u=m]
-
-Terraform used the selected providers to generate the following execution plan.
- + create
-
-Terraform will perform the following actions:
-
- # local_file.cache will be created
- + resource "local_file" "cache" {
- + content =
-
- Weather report: Stockholm
-
- Overcast
- .--. +2(-1) °C
- .-( ). ↑ 11 km/h
- (___.__)__) 6 km
- 0.0 mm
-
-
- + content_base64sha256 = (known after apply)
- + content_base64sha512 = (known after apply)
- + content_md5 = (known after apply)
- + content_sha1 = (known after apply)
- + content_sha256 = (known after apply)
- + content_sha512 = (known after apply)
- + directory_permission = "0777"
- + file_permission = "0777"
- + filename = "cache.dev.txt"
- + id = (known after apply)
- }
-
-Plan: 1 to add, 0 to change, 0 to destroy.
-
-Changes to Outputs:
- + lang = "se"
- + location = "Stockholm"
- + stage = "dev"
- + units = "m"
- + url = "https://wttr.in/Stockholm?0&format=&lang=se&u=m"
- + weather =
-
- Weather report: Stockholm
-
- Overcast
- .--. +2(-1) °C
- .-( ). ↑ 11 km/h
- (___.__)__) 6 km
- 0.0 mm
-
-
-local_file.cache: Creating...
-local_file.cache: Creation complete after 0s
-
-Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-
-Outputs:
-
-lang = "se"
-location = "Stockholm"
-stage = "dev"
-units = "m"
-url = "https://wttr.in/Stockholm?0&format=&lang=se&u=m"
-weather =
-
-Weather report: Stockholm
-
- Overcast
- .--. +2(-1) °C
- .-( ). ↑ 11 km/h
- (___.__)__) 6 km
- 0.0 mm
-
-
-
+exec: "terraform": executable file not found in $PATH
+
@@ -98,90 +16,8 @@
>
> atmos terraform deploy myapp --stack staging
-
-Initializing the backend...
-
-Initializing provider plugins...
-
-
-Terraform has been successfully initialized!
-data.http.weather: Reading...
-data.http.weather: Read complete after 1s
- [id=https://wttr.in/Los+Angeles?0&format=&lang=en&u=m]
-
-Terraform used the selected providers to generate the following execution plan.
- + create
-
-Terraform will perform the following actions:
-
- # local_file.cache will be created
- + resource "local_file" "cache" {
- + content =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
- + content_base64sha256 = (known after apply)
- + content_base64sha512 = (known after apply)
- + content_md5 = (known after apply)
- + content_sha1 = (known after apply)
- + content_sha256 = (known after apply)
- + content_sha512 = (known after apply)
- + directory_permission = "0777"
- + file_permission = "0777"
- + filename = "cache.staging.txt"
- + id = (known after apply)
- }
-
-Plan: 1 to add, 0 to change, 0 to destroy.
-
-Changes to Outputs:
- + lang = "en"
- + location = "Los Angeles"
- + stage = "staging"
- + units = "m"
- + url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
- + weather =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
-local_file.cache: Creating...
-local_file.cache: Creation complete after 0s
-
-Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-
-Outputs:
-
-lang = "en"
-location = "Los Angeles"
-stage = "staging"
-units = "m"
-url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
-weather =
-
-Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
-
+exec: "terraform": executable file not found in $PATH
+
@@ -191,87 +27,6 @@
>
> atmos terraform deploy myapp --stack prod
-
-Initializing the backend...
-
-Initializing provider plugins...
-
-
-Terraform has been successfully initialized!
-data.http.weather: Reading...
-data.http.weather: Read complete after 1s
- [id=https://wttr.in/Los+Angeles?0&format=&lang=en&u=m]
-
-Terraform used the selected providers to generate the following execution plan.
- + create
-
-Terraform will perform the following actions:
-
- # local_file.cache will be created
- + resource "local_file" "cache" {
- + content =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
- + content_base64sha256 = (known after apply)
- + content_base64sha512 = (known after apply)
- + content_md5 = (known after apply)
- + content_sha1 = (known after apply)
- + content_sha256 = (known after apply)
- + content_sha512 = (known after apply)
- + directory_permission = "0777"
- + file_permission = "0777"
- + filename = "cache.prod.txt"
- + id = (known after apply)
- }
-
-Plan: 1 to add, 0 to change, 0 to destroy.
-
-Changes to Outputs:
- + lang = "en"
- + location = "Los Angeles"
- + stage = "prod"
- + units = "m"
- + url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
- + weather =
-
- Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
+exec: "terraform": executable file not found in $PATH
+
-
-local_file.cache: Creating...
-local_file.cache: Creation complete after 0s
-
-Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-
-Outputs:
-
-lang = "en"
-location = "Los Angeles"
-stage = "prod"
-units = "m"
-url = "https://wttr.in/Los+Angeles?0&format=&lang=en&u=m"
-weather =
-
-Weather report: Los+Angeles
-
- \ / Sunny
- .-. 17 °C
- ― ( ) ― ↗ 4 km/h
- `-’ 16 km
- / \ 0.0 mm
-
-
-
diff --git a/website/src/components/Screengrabs/demo-stacks/start-your-project.html b/website/src/components/Screengrabs/demo-stacks/start-your-project.html
index 88f6f1d510..1e4509f6f2 100644
--- a/website/src/components/Screengrabs/demo-stacks/start-your-project.html
+++ b/website/src/components/Screengrabs/demo-stacks/start-your-project.html
@@ -1,55 +1,33 @@
->
-> # Here's a simple way to organize environments.
->
-> tree -I *.tf .
-
-./
-├── atmos.yaml
-├── components/
-│ └── terraform/
-│ └── myapp/
-│ └── README.md
-└── stacks/
- ├── catalog/
- │ └── myapp.yaml
- └── deploy/
- ├── dev.yaml
- ├── prod.yaml
- └── staging.yaml
-
-6 directories, 6 files
-
-
->
-> # Customize how to organize environments in the atmos.yaml file.
-> # Pay special attention to the name_pattern, which is how Atmos knows
-> # where to find the stacks.
->
-> cat atmos.yaml
-
-
- File: atmos.yaml
- 1 base_path: "./"
- 2
- 3 components:
- 4 terraform:
- 5 base_path: "components/terraform"
- 6 apply_auto_approve: false
- 7 deploy_run_init: true
- 8 init_run_reconfigure: true
- 9 auto_generate_backend_file: false
- 10
- 11 stacks:
- 12 base_path: "stacks"
- 13 included_paths:
- 14 - "deploy/**/*"
- 15 excluded_paths:
- 16 - "**/_defaults.yaml"
- 17 name_pattern: "{stage}"
- 18
- 19 logs:
- 20 file: "/dev/stdout"
- 21 level: Info
-
-
+>
+> # Here's a simple way to organize environments.
+>
+> tree -I *.tf .
+
+./
+├── atmos.yaml
+├── components/
+│ └── terraform/
+│ └── myapp/
+│ └── README.md
+└── stacks/
+ ├── catalog/
+ │ └── myapp.yaml
+ └── deploy/
+ ├── dev.yaml
+ ├── prod.yaml
+ └── staging.yaml
+
+7 directories, 6 files
+
+
+>
+> # Customize how to organize environments in the atmos.yaml file.
+> # Pay special attention to the name_pattern, which is how Atmos knows
+> # where to find the stacks.
+>
+> cat atmos.yaml
+
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
+
diff --git a/website/src/components/Screengrabs/demo-stacks/write-your-components.html b/website/src/components/Screengrabs/demo-stacks/write-your-components.html
index 39eab8db2d..18e28ed302 100644
--- a/website/src/components/Screengrabs/demo-stacks/write-your-components.html
+++ b/website/src/components/Screengrabs/demo-stacks/write-your-components.html
@@ -4,13 +4,13 @@
components/
└── terraform/
└── myapp/
- ├── README.md
├── main.tf
├── outputs.tf
+ ├── README.md
├── variables.tf
└── versions.tf
-2 directories, 5 files
+3 directories, 5 files
> # Let's take a look at myapp terraform 'root' module...
@@ -20,116 +20,27 @@
>
> cat components/terraform/myapp/main.tf
-
File: components/terraform/myapp/main.tf
- 1
- 2
- 3 locals {
- 4 url = format("https://wttr.in/%v?%v&format=%v&lang=%v&u=%v",
- 5 urlencode(var.location),
- 6 urlencode(var.options),
- 7 urlencode(var.format),
- 8 urlencode(var.lang),
- 9 urlencode(var.units))
- 10 }
- 11
- 12 data "http" "weather" {
- 13 url = local.url
- 14 request_headers = {
- 15 User-Agent = "curl"
- 16 }
- 17 }
- 18
- 19 # Now write this to a file (as an example of a resource)
- 20 resource "local_file" "cache" {
- 21 filename = "cache.${var.stage}.txt"
- 22 content = data.http.weather.body
- 23 }
-
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
> # Then we define all the variables we plan to accept.
> # Generally, we recommend avoiding defaults here and using baseline stack configurations.
>
> cat components/terraform/myapp/variables.tf
-
File: components/terraform/myapp/variables.tf
- 1 variable "stage" {
- 2 description = "Stage where it will be deployed"
- 3 type = string
- 4 }
- 5
- 6 variable "location" {
- 7 description = "Location for which the weather."
- 8 type = string
- 9 default = "Los Angeles"
- 10 }
- 11
- 12 variable "options" {
- 13 description = "Options to customize the output."
- 14 type = string
- 15 default = "0T"
- 16 }
- 17
- 18 variable "format" {
- 19 description = "Format of the output."
- 20 type = string
- 21 default = "v2"
- 22 }
- 23
- 24 variable "lang" {
- 25 description = "Language in which the weather is displayed."
- 26 type = string
- 27 default = "en"
- 28 }
- 29
- 30 variable "units" {
- 31 description = "Units in which the weather is displayed."
- 32 type = string
- 33 default = "m"
- 34 }
-
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
> # Then let's provide some outputs that can be used by other components.
>
> cat components/terraform/myapp/outputs.tf
-
File: components/terraform/myapp/outputs.tf
- 1 output "weather" {
- 2 value = data.http.weather.body
- 3 }
- 4
- 5 output "url" {
- 6 value = local.url
- 7 }
- 8
- 9 output "stage" {
- 10 value = var.stage
- 11 description = "Stage where it was deployed"
- 12 }
- 13
- 14 output "location" {
- 15 value = var.location
- 16 description = "Location of the weather report."
- 17 }
- 18
- 19 output "lang" {
- 20 value = var.lang
- 21 description = "Language which the weather is displayed."
- 22 }
- 23
- 24 output "units" {
- 25 value = var.units
- 26 description = "Units the weather is displayed."
- 27 }
-
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
> # It's a best practice to pin versions, so let's do that.
>
> cat components/terraform/myapp/versions.tf
-
File: components/terraform/myapp/versions.tf
- 1 terraform {
- 2 required_version = ">= 1.0.0"
- 3
- 4 required_providers {}
- 5 }
-
\ No newline at end of file
+/home/runner/work/atmos/atmos/demo/screengrabs/scripts/demo-stacks/.demo.rc: line 39: bat: command not found
+
diff --git a/website/src/components/Screengrabs/tree-CAF--gitignore.html b/website/src/components/Screengrabs/tree-CAF--gitignore.html
index 30a6b3bfc6..e516034a67 100644
--- a/website/src/components/Screengrabs/tree-CAF--gitignore.html
+++ b/website/src/components/Screengrabs/tree-CAF--gitignore.html
@@ -3,11 +3,9 @@
├──@components/
│@@@└──@terraform/
│@@@@@@@└──@myapp/
-│@@@@@@@@@@@├──@README.md
-│@@@@@@@@@@@├──@cache.txt*
│@@@@@@@@@@@├──@main.tf
│@@@@@@@@@@@├──@outputs.tf
-│@@@@@@@@@@@├──@terraform.tfstate.d/
+│@@@@@@@@@@@├──@README.md
│@@@@@@@@@@@├──@variables.tf
│@@@@@@@@@@@└──@versions.tf
└──@stacks/
@@ -18,4 +16,5 @@
@@@@@@@@├──@prod.yaml
@@@@@@@@└──@staging.yaml
-7 directories, 11 files
+7 directories, 10 files
+
diff --git a/website/src/components/Screengrabs/tree.html b/website/src/components/Screengrabs/tree.html
index 233711b250..37babf7764 100644
--- a/website/src/components/Screengrabs/tree.html
+++ b/website/src/components/Screengrabs/tree.html
@@ -3,16 +3,9 @@
├── components
│ └── terraform
│ └── myapp
-│ ├── README.md
-│ ├── cache.dev.txt
-│ ├── cache.prod.txt
-│ ├── cache.staging.txt
-│ ├── cache.txt
│ ├── main.tf
│ ├── outputs.tf
-│ ├── terraform.tfstate.d
-│ │ └── prod
-│ │ └── terraform.tfstate
+│ ├── README.md
│ ├── variables.tf
│ └── versions.tf
└── stacks
@@ -23,4 +16,5 @@
├── prod.yaml
└── staging.yaml
-8 directories, 15 files
+7 directories, 10 files
+