Skip to content

Commit

Permalink
Improve docs readability (#127)
Browse files Browse the repository at this point in the history
* Improve docs readability

* Fix numerotation that renders 1s
  • Loading branch information
bonclay7 authored Feb 24, 2023
1 parent 77d7bf2 commit 6634045
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/eks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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`

Expand All @@ -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.

Expand Down
22 changes: 12 additions & 10 deletions docs/helpers/new-eks-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# (mandatory) AWS Region where your resources will be located
aws_region = "eu-central-1"
aws_region = ""

# (mandatory) EKS Cluster name
eks_cluster_id = "eks-cluster-with-vpc"
Expand Down

0 comments on commit 6634045

Please sign in to comment.