Skip to content

Commit 6634045

Browse files
authored
Improve docs readability (#127)
* Improve docs readability * Fix numerotation that renders 1s
1 parent 77d7bf2 commit 6634045

File tree

3 files changed

+16
-14
lines changed

3 files changed

+16
-14
lines changed

docs/eks/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ terraform apply
105105

106106
## Visualization
107107

108-
1. Prometheus datasource on Grafana
108+
### 1. Prometheus datasource on Grafana
109109

110110
Make sure to open the link in the output. After a successful deployment, this will open
111111
the Prometheus datasource configuration on Grafana.
@@ -115,7 +115,7 @@ Click `Save & test` and you should see a notification confirming that the Amazon
115115
terraform output grafana_prometheus_datasource_test
116116
```
117117

118-
2. Grafana dashboards
118+
### 2. Grafana dashboards
119119

120120
Go to the Dashboards panel of your Grafana workspace. You should see a list of dashboards under the `Observability Accelerator Dashboards`
121121

@@ -125,7 +125,7 @@ Open a specific dashboard and you should be able to view its visualization
125125

126126
<img width="2056" alt="cluster headlines" src="https://user-images.githubusercontent.com/10175027/199110753-9bc7a9b7-1b45-4598-89d3-32980154080e.png">
127127

128-
3. Amazon Managed Service for Prometheus rules and alerts
128+
### 3. Amazon Managed Service for Prometheus rules and alerts
129129

130130
Open the Amazon Managed Service for Prometheus console and view the details of your workspace. Under the `Rules management` tab, you should find new rules deployed.
131131

docs/helpers/new-eks-cluster.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,18 @@ Specify the AWS Region where the resources will be deployed:
3333
export TF_VAR_aws_region=xxx
3434
```
3535

36-
### 3. Instance Type
36+
## Deploy
37+
38+
Simply run this command to deploy the example
39+
40+
```bash
41+
terraform apply
42+
```
43+
44+
## Additional configuration (optional)
45+
46+
47+
### 1. Instance Type
3748

3849
Depending on your region or limitations in your account, you might need to change to a different instance type.
3950
To do this, you can define the instance type to use:
@@ -48,15 +59,6 @@ You can override the version of the cluster also:
4859
export TF_VAR_eks_version=xxx
4960
```
5061

51-
52-
## Deploy
53-
54-
Simply run this command to deploy the example
55-
56-
```bash
57-
terraform apply
58-
```
59-
6062
## Login to your cluster
6163

6264
EKS Cluster details can be extracted from terraform output or from AWS Console to get the name of cluster.

examples/existing-cluster-with-base-and-infra/terraform.tfvars

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# (mandatory) AWS Region where your resources will be located
2-
aws_region = "eu-central-1"
2+
aws_region = ""
33

44
# (mandatory) EKS Cluster name
55
eks_cluster_id = "eks-cluster-with-vpc"

0 commit comments

Comments
 (0)