-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(cobra): update auto-generated documentation
- Loading branch information
1 parent
d5189ad
commit 6c021ad
Showing
2 changed files
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
## cloud-platform environment destroy | ||
|
||
Perform a terraform destroy and kubectl delete for a given namespace | ||
|
||
### Synopsis | ||
|
||
|
||
Perform a kubectl destroy and a terraform delete for a given namespace using either -namespace flag or the | ||
the namespace in the given PR Id/Number | ||
|
||
Along with the mandatory input flag, the below environments variables needs to be set | ||
TF_VAR_cluster_name - e.g. "cp-1902-02" to get the vpc details for some modules like rds, es | ||
TF_VAR_cluster_state_bucket - State where the cluster state is stored | ||
TF_VAR_cluster_state_key - folder name/state key inside the state bucket where cluster state is stored | ||
TF_VAR_github_owner - Github owner: ministryofjustice | ||
TF_VAR_github_token - Personal access token with repo scope to push github action secrets | ||
TF_VAR_kubernetes_cluster - Full name of the Cluster e.g. XXXXXX.gr7.eu-west2.eks.amazonaws.com | ||
PINGDOM_API_TOKEN - API Token to access pingdom | ||
PIPELINE_TERRAFORM_STATE_LOCK_TABLE - DynamoDB table where the state lock is stored | ||
PIPELINE_STATE_BUCKET - State bucket where the environments state is stored e.g cloud-platform-terraform-state | ||
PIPELINE_STATE_KEY_PREFIX - State key/ folder where the environments terraform state is stored e.g cloud-platform-environments | ||
PIPELINE_STATE_REGION - State region of the bucket e.g. eu-west-1 | ||
PIPELINE_CLUSTER - Cluster name/folder inside namespaces/ in cloud-platform-environments | ||
PIPELINE_CLUSTER_STATE - Cluster name/folder inside the state bucket where the environments terraform state is stored | ||
|
||
|
||
``` | ||
cloud-platform environment destroy [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
$ cloud-platform environment destroy -n <namespace> | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--cluster string folder name under namespaces/ inside cloud-platform-environments repo refering to full cluster name | ||
--github-token string Personal access Token from Github | ||
-h, --help help for destroy | ||
--kubecfg string path to kubeconfig file (default "/home/runner/.kube/config") | ||
-n, --namespace string Namespace which you want to perform the destroy | ||
--prNumber int Pull request ID or number to which you want to perform the destroy | ||
--redact Redact the terraform output before printing (default true) | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--skip-version-check don't check for updates | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [cloud-platform environment](cloud-platform_environment.md) - Cloud Platform Environment actions | ||
|