Skip to content

Commit

Permalink
Update docs links (#122)
Browse files Browse the repository at this point in the history
* Update links in doc

* Update broken link

* Apply consistency
  • Loading branch information
bonclay7 authored Feb 20, 2023
1 parent daed34d commit 96fd88b
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ v2+ releases introduces couple of breaking changes compared to previous versions

- `modules/workloads/infra` module moves to `modules/eks-monitoring`
- All EKS configuration options moves from the base module to the `eks-monitoring` module
- All EKS workload modules `modules/workloads/{java,nginx}` merge into `eks-monitoring` as configuration options (patterns), see [examples](./examples) to provide a more complete visiblity.
- All EKS workload modules `modules/workloads/{java,nginx}` merge into `eks-monitoring` as configuration options (patterns), see [examples](./examples) to provide a more complete visiblity
- All examples have been updated to reflect these changes

### Base Module
Expand Down
3 changes: 2 additions & 1 deletion docs/eks/destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ terraform state rm "module.eks_observability_accelerator.aws_prometheus_workspac
```

!!! note
To view all the features proposed by this module, visit the [module documentation](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/workloads/infra).
To view all the features proposed by this module,
visit the [module documentation](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring).
2 changes: 1 addition & 1 deletion docs/eks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This example demonstrates how to monitor your Amazon Elastic Kubernetes Service
(Amazon EKS) cluster with the Observability Accelerator's EKS
[infrastructure module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/feat/modules-composition/modules/eks-monitoring).
[infrastructure module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring).

Monitoring Amazon Elastic Kubernetes Service (Amazon EKS) for metrics has two categories:
the control plane and the Amazon EKS nodes (with Kubernetes objects).
Expand Down
4 changes: 2 additions & 2 deletions docs/eks/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

!!! note
Since v2.x, Java based applications monitoring on EKS has been merged within
the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/feat/modules-composition/modules/eks-monitoring)
the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring)
to allow visibility both on the cluster and the workloads, [#59](https://github.com/aws-observability/terraform-aws-observability-accelerator/issues/59).

In addition to EKS infrastructure monitoring, the current example provides
Expand All @@ -24,7 +24,7 @@ module "eks_monitoring" {
}
```

You can further customize the Java pattern by providing `java_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/feat/modules-composition/modules/eks-monitoring/README.md#input_java_config).
You can further customize the Java pattern by providing `java_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/modules/eks-monitoring/README.md#input_java_config).

### 2. Grafana API key

Expand Down
4 changes: 2 additions & 2 deletions docs/eks/nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

!!! note
Since v2.x, NGINX based applications monitoring on EKS has been merged within
the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/feat/modules-composition/modules/eks-monitoring)
the [eks-monitoring module](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/eks-monitoring)
to allow visibility both on the cluster and the workloads, [#59](https://github.com/aws-observability/terraform-aws-observability-accelerator/issues/59).

In addition to EKS infrastructure monitoring, the current example provides
Expand All @@ -24,7 +24,7 @@ module "eks_monitoring" {
}
```

You can further customize the NGINX pattern by providing `nginx_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/feat/modules-composition/modules/eks-monitoring/README.md#input_nginx_config).
You can further customize the NGINX pattern by providing `nginx_config` [options](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/modules/eks-monitoring/README.md#input_nginx_config).

### 2. Grafana API key

Expand Down

0 comments on commit 96fd88b

Please sign in to comment.