8000 Fix docs to use definition lists by osterman · Pull Request #1318 · cloudposse/atmos · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix docs to use definition lists #1318

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix docs to use definition lists #1318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 33 additions & 14 deletions website/docs/cli/commands/aws/aws-eks-update-kubeconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,39 @@ atmos aws eks update-kubeconfig --verbose=true

## Arguments

| Argument | Description | Required |
|:------------|:----------------|:---------|
| `component` | Atmos component | no |
<dl>
<dt>`component`</dt>
<dd>Atmos component (optional)</dd>
</dl>


## Flags

| Flag | Description | Alias | Required |
|:---------------|:--------------------------------------------------------------------------------------------|:------|:---------|
| `--stack` | Atmos stack | `-s` | no |
| `--profile` | AWS profile to use to authenticate to the EKS cluster | | no |
| `--role-arn` | AWS IAM role ARN to use to authenticate to the EKS cluster | | no |
| `--name` | EKS cluster name | | no |
| `--region` | AWS region | | no |
| `--kubeconfig` | `kubeconfig` filename to append with the configuration | | no |
| `--alias` | Alias for the cluster context name. Defaults to match cluster ARN | | no |
| `--dry-run` | Print the merged kubeconfig to stdout instead of writing it to the specified file | | no |
| `--verbose` | Print more detailed output when writing the kubeconfig file, including the appended entries | | no |
<dl>
<dt>`--stack` (`-s`)</dt>
<dd>Atmos stack (optional)</dd>

<dt>`--profile`</dt>
<dd>AWS profile to use to authenticate to the EKS cluster</dd>

<dt>`--role-arn`</dt>
<dd>AWS IAM role ARN to use to authenticate to the EKS cluster</dd>

<dt>`--name`</dt>
<dd>EKS cluster name</dd>

<dt>`--region`</dt>
<dd>AWS region</dd>

<dt>`--kubeconfig`</dt>
<dd>`kubeconfig` filename to append with the configuration</dd>

<dt>`--alias`</dt>
<dd>Alias for the cluster context name. Defaults to match cluster ARN</dd>

<dt>`--dry-run`</dt>
<dd>Print the merged kubeconfig to stdout instead of writing it to the specified file</dd>

<dt>`--verbose`</dt>
<dd>Print more detailed output when writing the kubeconfig file, including the appended entries</dd>
</dl>
7 changes: 4 additions & 3 deletions website/docs/cli/commands/completion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,11 @@ source <(atmos completion bash)
```

## Arguments
<dl>
<dt>`shell_name`</dt>
<dd>Shell name. Valid values are `bash`, `zsh`, `fish` and `powershell` (required)</dd>
</dl>

| Argument | Description | Required |
|:--------------|:--------------------------------------------------------------------|:---------|
| `shell_name ` | Shell name. Valid values are `bash`, `zsh`, `fish` and `powershell` | yes |

:::info
Refer to [Command-line completion](https://en.wikipedia.org/wiki/Command-line_completion) for more details
Expand Down
143 changes: 93 additions & 50 deletions website/docs/cli/commands/describe/describe-component.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,90 +67,133 @@ atmos describe component vpc -s plat-ue2-prod --pager=more

## Flags

| Flag | Description | Alias | Required |
|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------|:---------|
| `--stack` | Atmos stack | `-s` | yes |
| `--format` | Output format: `yaml` or `json` (`yaml` is default) | `-f` | no |
| `--file` | If specified, write the result to the file | | no |
| `--process-templates` | Enable/disable processing of all `Go` templates<br/>in Atmos stacks manifests when executing the command.<br/>Use the flag to see the component configuration<br/>before and after the templates are processed.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe component <c> -s <stack> --process-templates=false` | | no |
| `--process-functions` | Enable/disable processing of all Atmos YAML functions<br/>in Atmos stacks manifests when executing the command.<br/>Use the flag to see the component configuration<br/>before and after the functions are processed.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe component <c> -s <stack> --process-functions=false` | | no |
| `--skip` | Skip processing a specific Atmos YAML function<br/>in Atmos stacks manifests when executing the command.<br/>To specify more than one function,<br/>use multiple `--skip` flags, or separate the functions with a comma:<br/>`atmos describe component <c> -s <stack> --skip=terraform.output --skip=include`<br/>`atmos describe component <c> -s <stack> --skip=terraform.output,include` | | no |
| `--query` | Query the results of the command using `yq` expressions.<br/><br/>`atmos describe component <c> -s <stack> --query .vars.tags`<br/><br/>For more details, refer to https://mikefarah.gitbook.io/yq | `-q` | no |
| `--pager` | Disable/Enable the paging user experience | | |
<dl>
<dt>`--stack` (`-s`)</dt>
<dd>Atmos stack (required)</dd>

<dt>`--format` (`-f`)</dt>
<dd>Output format: `yaml` or `json` (`yaml` is default)</dd>

<dt>`--file`</dt>
<dd>If specified, write the result to the file</dd>

<dt>`--process-templates`</dt>
<dd>Enable/disable processing of all `Go` templates in Atmos stack manifests when executing the command.<br/>Use the flag to see the component configuration before and after the templates are processed.<br/>If the flag is not provided, it's set to `true` by default.</dd>

<dt>`--process-functions`</dt>
<dd>Enable/disable processing of all Atmos YAML functions in Atmos stack manifests when executing the command.<br/>Use the flag to see the component configuration before and after the functions are processed.<br/>If the flag is not provided, it's set to `true` by default.</dd>

<dt>`--skip`</dt>
<dd>Skip processing a specific Atmos YAML function in Atmos stacks manifests when executing the command.<br/>To specify more than one function, use multiple `--skip` flags, or separate the functions with a comma.</dd>

<dt>`--query` (`-q`)</dt>
<dd>Query the results of the command using `yq` expressions.<br/>For more details, refer to https://mikefarah.gitbook.io/yq</dd>

<dt>`--pager`</dt>
<dd>Disable/Enable the paging user experience</dd>
</dl>
## Output

The command outputs the final deep-merged component configuration.

The output contains the following sections:

- `atlantis_project` - Atlantis project name (if [Atlantis Integration](/integrations/atlantis) is configured for the component in the stack)

- `atmos_cli_config` - information about Atmos CLI configuration from `atmos.yaml`

- `atmos_component` - [Atmos component](/core-concepts/components) name
<dl>
<dt>`atlantis_project`</dt>
<dd>Atlantis project name (if Atlantis integration is configured for the component)</dd>

- `atmos_stack` - [Atmos stack](/core-concepts/stacks) name
<dt>`atmos_cli_config`</dt>
<dd>Information about Atmos CLI configuration from `atmos.yaml`</dd>

- `stack` - same as `atmos_stack`
<dt>`atmos_component`</dt>
<dd>The Atmos component name</dd>

- `atmos_stack_file` - the stack manifest where the Atmos stack is defined
<dt>`atmos_stack`</dt>
<dd>The Atmos stack name</dd>

- `atmos_manifest` - same as `atmos_stack_file`
<dt>`stack`</dt>
<dd>Same as `atmos_stack`</dd>

- `backend` - Terraform/OpenTofu backend configuration
<dt>`atmos_stack_file`</dt>
<dd>The stack manifest where the Atmos stack is defined</dd>

- `backend_type` - Terraform/OpenTofu backend type
<dt>`atmos_manifest`</dt>
<dd>Same as `atmos_stack_file`</dd>

- `command` - the binary to execute when provisioning the component (e.g. `terraform`, `terraform-1`, `tofu`, `helmfile`)
<dt>`backend`</dt>
<dd>Terraform/OpenTofu backend configuration</dd>

- `component` - the Terraform/OpenTofu component for which the Atmos component provides configuration
<dt>`backend_type`</dt>
<dd>Terraform/OpenTofu backend type</dd>

- `component_type` - the type of the component (`terraform` or `helmfile`)
<dt>`command`</dt>
<dd>The binary used to provision the component</dd>

- `component_info` - a block describing the Terraform or Helmfile components that the Atmos component manages. The `component_info` block has the
following sections:
- `component_path` - the filesystem path to the Terraform/OpenTofu or Helmfile component
<dt>`component`</dt>
<dd>The Terraform/OpenTofu component name</dd>

- `component_type` - the type of the component (`terraform` or `helmfile`)
<dt>`component_type`</dt>
<dd>The type of the component (`terraform` or `helmfile`)</dd>

- `terraform_config` - if the component type is `terraform`, this sections describes the high-level metadata about the Terraform component from its
source code, including variables, outputs and child Terraform modules (using a Terraform parser from HashiCorp). The file names and line numbers
where the variables, outputs and child modules are defined are also included. Invalid Terraform configurations are also detected, and in case of
any issues, the warnings and errors are shows in the `terraform_config.diagnostics` section
<dt>`component_info`</dt>
<dd>
<dl>
<dt>`component_path`</dt>
<dd>The filesystem path to the Terraform/OpenTofu or Helmfile component</dd>
<dt>`component_type`</dt>
<dd>The type of the component (`terraform` or `helmfile`)</dd>
<dt>`terraform_config`</dt>
<dd>High-level metadata about the Terraform component from its source code, including variables, outputs and child modules</dd>
</dl>
</dd>
</dl>
<dl>
<dt>`env`</dt>
<dd>A map of ENV variables defined for the Atmos component</dd>

- `env` - a map of ENV variables defined for the Atmos component
<dt>`inheritance`</dt>
<dd>Component's <a href="/core-concepts/stacks/inheritance">inheritance chain</a></dd>

- `inheritance` - component's [inheritance chain](/core-concepts/stacks/inheritance)
<dt>`metadata`</dt>
<dd>Component's metadata configuration</dd>

- `metadata` - component's metadata config
<dt>`remote_state_backend`</dt>
<dd>Terraform/OpenTofu backend config for remote state</dd>

- `remote_state_backend` - Terraform/OpenTofu backend config for remote state
<dt>`remote_state_backend_type`</dt>
<dd>Terraform/OpenTofu backend type for remote state</dd>

- `remote_state_backend_type` - Terraform/OpenTofu backend type for remote state
<dt>`settings`</dt>
<dd>Component settings (free-form map)</dd>

- `settings` - component settings (free-form map)
<dt>`sources`</dt>
<dd>Sources of values from the component's sections (`vars`, `env`, `settings`)</dd>

- `sources` - sources of the values from the component's sections (`vars`, `env`, `settings`)
<dt>`spacelift_stack`</dt>
<dd>Spacelift stack name if integration is configured and `workspace_enabled` is true</dd>

- `spacelift_stack` - Spacelift stack name (if [Spacelift Integration](/integrations/spacelift) is configured for the component in the stack
and `settings.spacelift.workspace_enabled` is set to `true`)
<dt>`vars`</dt>
<dd>The final deep-merged component variables provided to Terraform/OpenTofu and Helmfile</dd>

- `vars` - the final deep-merged component variables that are provided to Terraform/OpenTofu and Helmfile when executing
`atmos terraform` and `atmos helmfile` commands
<dt>`workspace`</dt>
<dd>Terraform/OpenTofu workspace for the Atmos component</dd>

- `workspace` - Terraform/OpenTofu workspace for the Atmos component
<dt>`imports`</dt>
<dd>A list of all imports in the Atmos stack (related or not to the component)</dd>

- `imports` - a list of all imports in the Atmos stack (this shows all imports in the stack, related to the component and not)
<dt>`deps_all`</dt>
<dd>A list of all component stack dependencies where the component settings are defined</dd>

- `deps_all` - a list of all component stack dependencies (stack manifests where the component settings are defined, either inline or via imports)
<dt>`deps`</dt>
<dd>A list of component stack dependencies where the final configuration values are defined</dd>

- `deps` - a list of component stack dependencies where the _final_ values of all component configurations are defined
(after the deep-merging and processing all the inheritance chains and all the base components)
<dt>`overrides`</dt>
<dd>A map of overrides for the component</dd>

- `overrides` - a map of overrides for the component. Refer to [Component Overrides](/core-concepts/stacks/overrides) for more details
<dt>`providers`</dt>
<dd>A map of provider configurations for the component</dd>
</dl>

- `providers` - a map of provider configurations for the component

## Difference between `imports`, `deps_all` and `deps` outputs

Expand Down
Loading
Loading
0