Skip to content

Commit

Permalink
docs(using-atlantis): add usage for -destroy flag in atlantis plan (r…
Browse files Browse the repository at this point in the history
…unatlantis#3755)

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

Signed-off-by: Abdulla Mulail Mohamed <mulailmohamed@gmail.com>

* docs(using-atlantis): add closing to caution note

Signed-off-by: Abdulla Mulail Mohamed <mulailmohamed@gmail.com>

* Update runatlantis.io/docs/using-atlantis.md

Co-authored-by: PePe Amengual <jose.amengual@gmail.com>

* Update runatlantis.io/docs/using-atlantis.md

Co-authored-by: PePe Amengual <jose.amengual@gmail.com>

* chore(atlantis): add example

Signed-off-by: Abdulla Mulail Mohamed <mulailmohamed@gmail.com>

---------

Signed-off-by: Abdulla Mulail Mohamed <mulailmohamed@gmail.com>
Co-authored-by: PePe Amengual <jose.amengual@gmail.com>
  • Loading branch information
2 people authored and ijames-gc committed Feb 13, 2024
1 parent 31178fb commit 7e8c252
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions runatlantis.io/docs/using-atlantis.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,19 @@ 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 you can use the `-destroy` flag like this:

```bash
atlantis plan -- -destroy
atlantis plan -d dir -- -destroy
```
::: warning NOTE
The `-destroy` flag generates a destroy plan, If this plan is applied it 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.
:::

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

0 comments on commit 7e8c252

Please sign in to comment.