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

…unatlantis#3755) * docs(using-atlantis): add usage for -destroy flag in atlantis plan Signed-off-by: Abdulla Mulail Mohamed <[email protected]> * docs(using-atlantis): add closing to caution note Signed-off-by: Abdulla Mulail Mohamed <[email protected]> * Update runatlantis.io/docs/using-atlantis.md Co-authored-by: PePe Amengual <[email protected]> * Update runatlantis.io/docs/using-atlantis.md Co-authored-by: PePe Amengual <[email protected]> * chore(atlantis): add example Signed-off-by: Abdulla Mulail Mohamed <[email protected]> --------- Signed-off-by: Abdulla Mulail Mohamed <[email protected]> Co-authored-by: PePe Amengual <[email protected]>
gocardless · Feb 13, 2024 · d1c0f3b · d1c0f3b
1 parent efd475e
commit d1c0f3b
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/runatlantis.io/docs/using-atlantis.md b/runatlantis.io/docs/using-atlantis.md
@@ -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