Skip to content
New issue

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

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

docs(using-atlantis): add usage for -destroy flag in atlantis plan #3755

Merged
merged 7 commits into from
Sep 11, 2023
Merged

docs(using-atlantis): add usage for -destroy flag in atlantis plan #3755

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3a30fe1
docs(using-atlantis): add usage for -destroy flag in atlantis plan
leylmordor Sep 8, 2023
2cc2516
docs(using-atlantis): add closing to caution note
leylmordor Sep 8, 2023
9c90d4c
Merge branch 'main' into docs/atlantis-plan-documentation
leylmordor Sep 11, 2023
7a31639
Update runatlantis.io/docs/using-atlantis.md
leylmordor Sep 11, 2023
8b3a861
Update runatlantis.io/docs/using-atlantis.md
leylmordor Sep 11, 2023
6474ac4
chore(atlantis): add example
leylmordor Sep 11, 2023
bed5907
Merge branch 'main' into docs/atlantis-plan-documentation
leylmordor Sep 11, 2023
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
12 changes: 12 additions & 0 deletions runatlantis.io/docs/using-atlantis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,18 @@ atlantis plan -d dir -- -var foo='bar'
```
If you always need to append a certain flag, see [Custom Workflow Use Cases](custom-workflows.html#adding-extra-arguments-to-terraform-commands).

### Using the -destroy Flag

#### Example
To perform a destructive plan that will destroy resources in the specified directory, you can use the `-destroy` flag like this:
leylmordor marked this conversation as resolved.
Show resolved Hide resolved

```bash
atlantis plan -d dir -- -destroy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
atlantis plan -d dir -- -destroy
atlantis plan -- -destroy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are cases where users may run on a different directory, so I think atlantis plan -d dir -- -destroy this could also be useful for new users to have

```
::: warning NOTE
The `-destroy` flag initiates resource destruction, which can result in data loss or service disruptions. Ensure that you have thoroughly reviewed your Terraform configuration and intend to remove the specified resources before using this flag.
leylmordor marked this conversation as resolved.
Show resolved Hide resolved
:::

---
## atlantis apply
```bash
Expand Down