Skip to content

Commit fb8ad2a

Browse files
author
Miguel Varela Ramos
authored
Document volume deletion for Grafana (#1887)
1 parent de47939 commit fb8ad2a

File tree

2 files changed

+40
-12
lines changed

2 files changed

+40
-12
lines changed

docs/clusters/aws/uninstall.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ cortex cluster down
66

77
## Delete metadata and log groups
88

9-
Since you may wish to have access to your data after spinning down your cluster, Cortex's bucket, log groups, and Prometheus volume are not automatically deleted when running `cortex cluster down`.
9+
Since you may wish to have access to your data after spinning down your cluster, Cortex's bucket, log groups, and
10+
Prometheus volume are not automatically deleted when running `cortex cluster down`.
1011

1112
To delete them:
1213

@@ -25,24 +26,45 @@ aws s3 rb --force s3://<bucket>
2526
aws logs describe-log-groups --log-group-name-prefix=<cluster_name> --query logGroups[*].[logGroupName] --output text | xargs -I {} aws logs delete-log-group --log-group-name {}
2627
```
2728

28-
To delete the Prometheus volume, navigate to the [EC2 volumes page](https://console.aws.amazon.com/ec2/v2/home?#Volumes) in the AWS console (be sure to set the appropriate region), select the volume, and click "Actions" and then "Delete Volume". A Prometheus volume that Cortex created has a name that starts with `kubernetes-dynamic-pvc`, the `kubernetes.io/cluster/<cluster name>` tag is set to `owned`, and the `kubernetes.io/created-for/pvc/name` tag starts with `prometheus-`.
29+
## Delete Volumes
2930

30-
If you've configured a custom domain for your APIs, you can remove the SSL Certificate and Hosted Zone for the domain by following these [instructions](networking/custom-domain.md#cleanup).
31+
The volumes used by Cortex's Prometheus and Grafana instances are not deleted by default, as they might contain important
32+
information. If these volumes are not required anymore, you can delete them in the AWS console.
33+
34+
To delete the volumes, navigate to the [EC2 volumes page](https://console.aws.amazon.com/ec2/v2/home?#Volumes)
35+
in the AWS console (be sure to set the appropriate region), select the volumes, click "Actions" and then "Delete Volume"
36+
. Both volumes for Prometheus and Grafana that Cortex created have a name that starts with `kubernetes-dynamic-pvc`,
37+
the `kubernetes.io/cluster/<cluster name>` tag is set to `owned`, and the `kubernetes.io/created-for/pvc/name` tag start
38+
with `prometheus-` and `grafana-` respectively.
39+
40+
## Delete Certificates
41+
42+
If you've configured a custom domain for your APIs, you can remove the SSL Certificate and Hosted Zone for the domain by
43+
following these [instructions](networking/custom-domain.md#cleanup).
3144

3245
## Troubleshooting
3346

34-
On rare occasions, `cortex cluster down` may not be able to spin down your Cortex cluster. When this happens, follow these steps:
47+
On rare occasions, `cortex cluster down` may not be able to spin down your Cortex cluster. When this happens, follow
48+
these steps:
3549

36-
1. If you've manually created any AWS networking resources that are pointed to the cluster or its VPC (e.g. API Gateway VPC links, custom domains, etc), delete them from the AWS console.
50+
1. If you've manually created any AWS networking resources that are pointed to the cluster or its VPC (e.g. API Gateway
51+
VPC links, custom domains, etc), delete them from the AWS console.
3752

38-
1. Replace "<region>" and "<cluster_name>" in the following URL, and open it in your browser: `https://console.aws.amazon.com/cloudformation/home?region=<region>#/stacks?filteringText=eksctl-<cluster_name>-`
53+
1. Replace "<region>" and "<cluster_name>" in the following URL, and open it in your
54+
browser: `https://console.aws.amazon.com/cloudformation/home?region=<region>#/stacks?filteringText=eksctl-<cluster_name>-`
3955

40-
![image](https://user-images.githubusercontent.com/808475/97790394-963b4880-1b85-11eb-8e27-ba5a551606b3.png)
56+
![image](https://user-images.githubusercontent.com/808475/97790394-963b4880-1b85-11eb-8e27-ba5a551606b3.png)
4157

4258
1. For each CloudFormation stack which contains the word "nodegroup", select the stack and click "Delete".
4359

4460
1. Select the final stack (the one that ends in "-cluster") and click "Delete".
4561

46-
If deleting the stack fails, navigate to the EC2 dashboard in the AWS console, delete the load balancers that are associated with the cluster, and try again (you can determine which load balancers are associated with the cluster by setting the correct region in the console and checking the `cortex.dev/cluster-name` tag on all load balancers). If the problem still persists, delete any other AWS resources that are blocking the stack deletion and try again.
62+
If deleting the stack fails, navigate to the EC2 dashboard in the AWS console, delete the load balancers that are
63+
associated with the cluster, and try again (you can determine which load balancers are associated with the cluster by
64+
setting the correct region in the console and checking the `cortex.dev/cluster-name` tag on all load balancers). If
65+
the problem still persists, delete any other AWS resources that are blocking the stack deletion and try again.
4766

48-
1. In rare cases, you may need to delete other AWS resources associated with your Cortex cluster. For each the following resources, go to the appropriate AWS Dashboard (in the region that your cluster was in), and confirm that there are no resources left behind by the cluster: CloudWatch Dashboard, SQS Queues, S3 Bucket, and CloudWatch LogGroups (the Cortex bucket and log groups are not deleted by `cluster down` in order to preserve your data).
67+
1. In rare cases, you may need to delete other AWS resources associated with your Cortex cluster. For each the following
68+
resources, go to the appropriate AWS Dashboard (in the region that your cluster was in), and confirm that there are
69+
no resources left behind by the cluster: CloudWatch Dashboard, SQS Queues, S3 Bucket, and CloudWatch LogGroups (the
70+
Cortex bucket and log groups are not deleted by `cluster down` in order to preserve your data).

docs/clusters/gcp/uninstall.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@
44
cortex cluster-gcp down
55
```
66

7-
The `cortex cluster-gcp down` command doesn't wait for the cluster to spin down. You can ensure that the cluster has spun down by checking the GKE console.
7+
The `cortex cluster-gcp down` command doesn't wait for the cluster to spin down. You can ensure that the cluster has
8+
spun down by checking the GKE console.
89

9-
## Delete Prometheus Volume
10+
## Delete Volumes
1011

11-
The volume used by Cortex's Prometheus instance is not deleted by default, as it might contain important information. If this volume is not required anymore, you can delete it in the GCP console. Navigate to the [Disks](https://console.cloud.google.com/compute/disks) page (be sure to set the appropriate project), select the volume, and click "Delete". A Prometheus volume that Cortex created has a name that starts with `gke-<cluster name>-`, and the `kubernetes.io/created-for/pvc/name` tag starts with `prometheus-`.
12+
The volumes used by Cortex's Prometheus and Grafana instances are not deleted by default, as they might contain important
13+
information. If these volumes are not required anymore, you can delete them in the GCP console. Navigate to
14+
the [Disks](https://console.cloud.google.com/compute/disks) page (be sure to set the appropriate project), select the
15+
volumes, and click "Delete". The Prometheus and Grafana volumes that Cortex created have a name that starts
16+
with `gke-<cluster name>-`, and the `kubernetes.io/created-for/pvc/name` tag starts with `prometheus-` and `grafana-`
17+
respectively.

0 commit comments

Comments
 (0)