Skip to content

Commit 02967b9

Browse files
aknyshaknysh
committed
updates
1 parent 0dc369b commit 02967b9

File tree

1 file changed

+157
-29
lines changed

1 file changed

+157
-29
lines changed

‎website/docs/cli/commands/describe/describe-affected.mdx‎

Lines changed: 157 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -200,26 +200,129 @@ Affected components and stacks:
200200

201201
## Flags
202202

203-
| Flag | Description | Required |
204-
|:-----------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|
205-
| `--ref` | [Git Reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References) with which to compare the current working branch | no |
206-
| `--sha` | Git commit SHA with which to compare the current working branch | no |
207-
| `--file` | If specified, write the result to the file | no |
208-
| `--format` | Specify the output format: `json` or `yaml` (`json` is default) | no |
209-
| `--ssh-key` | Path to PEM-encoded private key to clone private repos using SSH | no |
210-
| `--ssh-key-password` | Encryption password for the PEM-encoded private key if the key contains<br/>a password-encrypted PEM block | no |
211-
| `--repo-path` | Path to the already cloned target repository with which to compare the current branch.<br/>Conflicts with `--ref`, `--sha`, `--ssh-key` and `--ssh-key-password` | no |
212-
| `--verbose` | Print more detailed output when cloning and checking out the target<br/>Git repository and processing the result | no |
213-
| `--include-spacelift-admin-stacks` | Include the Spacelift admin stack of any stack<br/>that is affected by config changes | no |
214-
| `--clone-target-ref` | Clone the target reference with which to compare the current branch.<br/>`atmos describe affected --clone-target-ref=true`<br/><br/>If set to `false` (default), the target reference will be checked out instead<br/>This requires that the target reference is already cloned by Git,<br/>and the information about it exists in the `.git` directory | no |
215-
| `--stack` | Only show results for the specific stack.<br/>`atmos describe affected --stack=plat-ue2-prod` | no |
216-
| `--include-dependents` | Include the dependent components and stacks.<br/>`atmos describe affected --include-dependents=true` | no |
217-
| `--include-settings` | Include the `settings` section for each affected component.<br/>`atmos describe affected --include-settings=true` | no |
218-
| `--upload` | Upload the affected components and stacks to a specified HTTP endpoint.<br/><br/>`atmos describe affected --upload=true`<br/><br/>Atmos will perform an HTTP POST request<br/>to the URL `${ATMOS_PRO_BASE_URL}/${ATMOS_PRO_ENDPOINT}`,<br/>where the base URL is defined by the `ATMOS_PRO_BASE_URL` environment variable,<br/>and the URL path is defined by the `ATMOS_PRO_ENDPOINT`environment variable. | no |
219-
| `--query` | Query the results of the command using `yq` expressions.<br/><br/>`atmos describe affected --query=<yq-expression>`.<br/><br/>For more details, refer to https://mikefarah.gitbook.io/yq | no |
220-
| `--process-templates` | Enable/disable processing of all `Go` templates<br/>in Atmos stacks manifests when executing the command.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe affected --process-templates=false` | | no |
221-
| `--process-functions` | Enable/disable processing of all Atmos YAML functions<br/>in Atmos stacks manifests when executing the command.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe affected --process-functions=false` | | no |
222-
| `--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 affected --skip=terraform.output --skip=include`<br/>`atmos describe affected --skip=terraform.output,include` | | no |
203+
<dl>
204+
<dt>`--ref`</dt>
205+
<dd>
206+
[Git Reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References) with which to compare the current working branch
207+
</dd>
208+
209+
<dt>`--sha`</dt>
210+
<dd>
211+
Git commit SHA with which to compare the current working branch
212+
</dd>
213+
214+
<dt>`--file`</dt>
215+
<dd>
216+
If specified, write the result to the file
217+
</dd>
218+
219+
<dt>`--format`</dt>
220+
<dd>
221+
Specify the output format: `json` or `yaml` (`json` is default)
222+
</dd>
223+
224+
<dt>`--ssh-key`</dt>
225+
<dd>
226+
Path to PEM-encoded private key to clone private repos using SSH
227+
</dd>
228+
229+
<dt>`--ssh-key-password`</dt>
230+
<dd>
231+
Encryption password for the PEM-encoded private key if the key contains a password-encrypted PEM block
232+
</dd>
233+
234+
<dt>`--repo-path`</dt>
235+
<dd>
236+
Path to the already cloned target repository with which to compare the current branch. Conflicts with `--ref`, `--sha`, `--ssh-key` and `--ssh-key-password`
237+
</dd>
238+
239+
<dt>`--verbose`</dt>
240+
<dd>
241+
Print more detailed output when cloning and checking out the target Git repository and processing the result
242+
</dd>
243+
244+
<dt>`--include-spacelift-admin-stacks`</dt>
245+
<dd>
246+
Include the Spacelift admin stack of any stack that is affected by config changes
247+
</dd>
248+
249+
<dt>`--clone-target-ref`</dt>
250+
<dd>
251+
Clone the target reference with which to compare the current branch.
252+
253+
`atmos describe affected --clone-target-ref=true`
254+
255+
If set to `false` (default), the target reference will be checked out instead.
256+
This requires that the target reference is already cloned by Git, and the information about it exists in the `.git` directory
257+
</dd>
258+
259+
<dt>`--stack`</dt>
260+
<dd>
261+
Only show results for the specific stack.
262+
263+
`atmos describe affected --stack=plat-ue2-prod`
264+
</dd>
265+
266+
<dt>`--include-dependents`</dt>
267+
<dd>
268+
Include the dependent components and stacks.
269+
270+
`atmos describe affected --include-dependents=true`
271+
</dd>
272+
273+
<dt>`--include-settings`</dt>
274+
<dd>
275+
Include the `settings` section for each affected component.
276+
277+
`atmos describe affected --include-settings=true`
278+
</dd>
279+
280+
<dt>`--query`</dt>
281+
<dd>
282+
Query the results of the command using `yq` expressions.
283+
284+
`atmos describe affected --query=<yq-expression>`
285+
286+
For more details, refer to [YQ - a lightweight and portable command-line YAML processor](https://mikefarah.gitbook.io/yq)
287+
</dd>
288+
289+
<dt>`--process-templates`</dt>
290+
<dd>
291+
Enable/disable processing of all `Go` templates in Atmos stacks manifests when executing the command.
292+
If the flag is not provided, it's set to `true` by default.
293+
294+
`atmos describe affected --process-templates=false`
295+
</dd>
296+
297+
<dt>`--process-functions`</dt>
298+
<dd>
299+
Enable/disable processing of all Atmos YAML functions in Atmos stacks manifests when executing the command.
300+
If the flag is not provided, it's set to `true` by default.
301+
302+
`atmos describe affected --process-functions=false`
303+
</dd>
304+
305+
<dt>`--skip`</dt>
306+
<dd>
307+
Skip processing a specific Atmos YAML function in Atmos stacks manifests when executing the command.
308+
To specify more than one function, use multiple `--skip` flags, or separate the functions with a comma:
309+
310+
`atmos describe affected --skip=terraform.output --skip=include`
311+
312+
`atmos describe affected --skip=terraform.output,include`
313+
</dd>
314+
315+
<dt>`--upload`</dt>
316+
<dd>
317+
Upload the affected components and stacks to a specified HTTP endpoint.
318+
319+
`atmos describe affected --upload=true`
320+
321+
Atmos will perform an HTTP POST request to the URL `${ATMOS_PRO_BASE_URL}/${ATMOS_PRO_ENDPOINT}`,
322+
where the base URL is defined by the `ATMOS_PRO_BASE_URL` environment variable,
323+
and the URL path is defined by the `ATMOS_PRO_ENDPOINT`environment variable
324+
</dd>
325+
</dl>
223326

224327
## Output
225328

@@ -537,15 +640,40 @@ where:
537640

538641
where:
539642

540-
- `affected` shows that the Atmos component's `metadata` section was changed
541-
(since the component is new and the `metadata` section is the first section that Atmos processes)
542-
543-
- `affected_all` shows all the affected sections and attributes:
544-
- `component` - the Terraform component (Terraform configuration) was affected (since it was just added)
545-
- `stack.metadata` - the Atmos component's `metadata` section was changed
546-
- `stack.vars` - the Atmos component's `vars` section was changed
547-
- `stack.env` - the Atmos component's `env` section was changed
548-
- `stack.settings` - the Atmos component's `settings` section was changed
643+
<dl>
644+
<dt>`affected`</dt>
645+
<dd>
646+
shows that the Atmos component's `metadata` section was changed
647+
(since the component is new and the `metadata` section is the first section that Atmos processes)
648+
</dd>
649+
650+
<dt>`affected_all`</dt>
651+
<dd>
652+
shows all the affected sections and attributes:
653+
<dl>
654+
<dt>`component`</dt>
655+
<dd>
656+
the Terraform component (Terraform configuration) was affected (since it was just added)
657+
</dd>
658+
<dt>`stack.metadata`</dt>
659+
<dd>
660+
the Atmos component's `metadata` section was changed
661+
</dd>
662+
<dt>`stack.vars`</dt>
663+
<dd>
664+
the Atmos component's `vars` section was changed
665+
</dd>
666+
<dt>`stack.env`</dt>
667+
<dd>
668+
the Atmos component's `env` section was changed
669+
</dd>
670+
<dt>`stack.settings`</dt>
671+
<dd>
672+
the Atmos component's `settings` section was changed
673+
</dd>
674+
</dl>
675+
</dd>
676+
</dl>
549677

550678
:::note
551679

0 commit comments

Comments
 (0)