Improve docs readability (#127)

* Improve docs readability

* Fix numerotation that renders 1s
This commit is contained in:
Rodrigue Koffi
2023-02-24 20:33:17 +01:00
committed by GitHub
parent 77d7bf2aa3
commit 663404598a
3 changed files with 16 additions and 14 deletions
+3 -3
View File
@@ -105,7 +105,7 @@ terraform apply
## Visualization
1. Prometheus datasource on Grafana
### 1. Prometheus datasource on Grafana
Make sure to open the link in the output. After a successful deployment, this will open
the Prometheus datasource configuration on Grafana.
@@ -115,7 +115,7 @@ Click `Save & test` and you should see a notification confirming that the Amazon
terraform output grafana_prometheus_datasource_test
```
2. Grafana dashboards
### 2. Grafana dashboards
Go to the Dashboards panel of your Grafana workspace. You should see a list of dashboards under the `Observability Accelerator Dashboards`
@@ -125,7 +125,7 @@ Open a specific dashboard and you should be able to view its visualization
<img width="2056" alt="cluster headlines" src="https://user-images.githubusercontent.com/10175027/199110753-9bc7a9b7-1b45-4598-89d3-32980154080e.png">
3. Amazon Managed Service for Prometheus rules and alerts
### 3. Amazon Managed Service for Prometheus rules and alerts
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.
+12 -10
View File
@@ -33,7 +33,18 @@ Specify the AWS Region where the resources will be deployed:
export TF_VAR_aws_region=xxx
```
### 3. Instance Type
## Deploy
Simply run this command to deploy the example
```bash
terraform apply
```
## Additional configuration (optional)
### 1. Instance Type
Depending on your region or limitations in your account, you might need to change to a different instance type.
To do this, you can define the instance type to use:
@@ -48,15 +59,6 @@ You can override the version of the cluster also:
export TF_VAR_eks_version=xxx
```
## Deploy
Simply run this command to deploy the example
```bash
terraform apply
```
## Login to your cluster
EKS Cluster details can be extracted from terraform output or from AWS Console to get the name of cluster.