You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The sections below demonstrate how you can leverage AWS Observability Accelerator
29
29
to enable monitoring to an existing EKS cluster.
30
30
31
+
### v2.x changes
32
+
33
+
v2+ releases introduces couple of breaking changes compared to previous versions:
34
+
35
+
-`modules/workloads/infra` module moves to `modules/eks-monitoring`
36
+
- All EKS configuration options moves from the base module to the `eks-monitoring` module
37
+
- 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.
38
+
- All examples have been updated to reflect these changes
39
+
31
40
### Base Module
32
41
33
42
The base module allows you to configure the AWS Observability services for your cluster and
@@ -38,15 +47,15 @@ and ADOT Operator deployed for you and ready to receive your data.
38
47
The base module serve as an anchor to the workload modules and cannot run on its own.
39
48
40
49
```hcl
41
-
module "eks_observability_accelerator" {
50
+
module "aws_observability_accelerator" {
42
51
# use release tags and check for the latest versions
| <aname="input_aws_region"></a> [aws\_region](#input\_aws\_region)| AWS Region |`string`| n/a | yes |
167
-
| <aname="input_eks_cluster_id"></a> [eks\_cluster\_id](#input\_eks\_cluster\_id)| Name of the EKS cluster |`string`| n/a | yes |
168
171
| <aname="input_enable_alertmanager"></a> [enable\_alertmanager](#input\_enable\_alertmanager)| Creates Amazon Managed Service for Prometheus AlertManager for all workloads |`bool`|`false`| no |
169
-
| <aname="input_enable_amazon_eks_adot"></a> [enable\_amazon\_eks\_adot](#input\_enable\_amazon\_eks\_adot)| Enables the ADOT Operator on the EKS Cluster |`bool`|`true`| no |
170
-
| <aname="input_enable_cert_manager"></a> [enable\_cert\_manager](#input\_enable\_cert\_manager)| Allow reusing an existing installation of cert-manager |`bool`|`true`| no |
171
172
| <aname="input_enable_managed_grafana"></a> [enable\_managed\_grafana](#input\_enable\_managed\_grafana)| Creates a new Amazon Managed Grafana Workspace |`bool`|`true`| no |
172
173
| <aname="input_enable_managed_prometheus"></a> [enable\_managed\_prometheus](#input\_enable\_managed\_prometheus)| Creates a new Amazon Managed Service for Prometheus Workspace |`bool`|`true`| no |
173
174
| <aname="input_grafana_api_key"></a> [grafana\_api\_key](#input\_grafana\_api\_key)| Grafana API key for the Amazon Managed Grafana workspace |`string`| n/a | yes |
174
-
| <aname="input_irsa_iam_permissions_boundary"></a> [irsa\_iam\_permissions\_boundary](#input\_irsa\_iam\_permissions\_boundary)| IAM permissions boundary for IRSA roles |`string`|`null`| no |
175
-
| <aname="input_irsa_iam_role_path"></a> [irsa\_iam\_role\_path](#input\_irsa\_iam\_role\_path)| IAM role path for IRSA roles |`string`|`"/"`| no |
176
175
| <aname="input_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#input\_managed\_grafana\_workspace\_id)| Amazon Managed Grafana Workspace ID |`string`|`""`| no |
177
176
| <aname="input_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#input\_managed\_prometheus\_workspace\_id)| Amazon Managed Service for Prometheus Workspace ID |`string`|`""`| no |
178
177
| <aname="input_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#input\_managed\_prometheus\_workspace\_region)| Region where Amazon Managed Service for Prometheus is deployed |`string`|`null`| no |
@@ -183,9 +182,8 @@ If you are interested in contributing, see the [Contribution guide](https://gith
183
182
| Name | Description |
184
183
|------|-------------|
185
184
| <aname="output_aws_region"></a> [aws\_region](#output\_aws\_region)| AWS Region |
186
-
| <aname="output_eks_cluster_id"></a> [eks\_cluster\_id](#output\_eks\_cluster\_id)| EKS Cluster Id |
187
-
| <aname="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version)| EKS Cluster version |
188
185
| <aname="output_grafana_dashboards_folder_id"></a> [grafana\_dashboards\_folder\_id](#output\_grafana\_dashboards\_folder\_id)| Grafana folder ID for automatic dashboards. Required by workload modules |
186
+
| <aname="output_grafana_prometheus_datasource_test"></a> [grafana\_prometheus\_datasource\_test](#output\_grafana\_prometheus\_datasource\_test)| Grafana save & test URL for Amazon Managed Prometheus workspace |
@@ -83,7 +95,7 @@ View all the configuration options in the [module's documentation](https://githu
83
95
84
96
Workloads modules are focused Terraform modules provided in this repository. They essentially provide curated metrics collection, alerts and Grafana dashboards according to the use case. Most of those modules require the base module.
85
97
86
-
You can check the full workload modules list and their documentation [here](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/workloads).
98
+
You can check the full workload modules list and their documentation [here](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/modules/).
87
99
88
100
All the modules come with end-to-end deployable examples.
Copy file name to clipboardExpand all lines: docs/eks/destroy.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,11 +15,9 @@ terraform destroy
15
15
To remove resources from your Terraform state, run
16
16
17
17
```bash
18
-
# grafana workspace
19
-
terraform state rm "module.eks_observability_accelerator.module.managed_grafana[0].aws_grafana_workspace.this[0]"
20
-
21
18
# prometheus workspace
22
19
terraform state rm "module.eks_observability_accelerator.aws_prometheus_workspace.this[0]"
23
20
```
24
21
25
-
> **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).
22
+
!!! note
23
+
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 run this example you need an Amazon Managed Grafana workspace. If you have an existing workspace, edit and run:
75
+
To run this example you need an Amazon Managed Grafana workspace. If you have an existing workspace, create an environment variable as described below.
76
+
To create a new workspace, visit our Amazon Managed Grafana [documentation](https://docs.aws.amazon.com/grafana/latest/userguide/getting-started-with-AMG.html).
77
+
Make sure to provide the workspace with Amazon Managed Service for Prometheus read permissions.
76
78
77
-
```bash
78
-
export TF_VAR_managed_grafana_workspace_id=g-xxx
79
-
```
80
-
81
-
To create a new one, within this example's Terraform state (sharing the same lifecycle with all the
82
-
other resources created by Terraform):
83
-
84
-
- Edit main.tf and set `enable_managed_grafana = true`
85
-
- Run
79
+
!!! note
80
+
For the URL `https://g-xyz.grafana-workspace.eu-central-1.amazonaws.com`, the workspace ID would be `g-xyz`
Open your Grafana workspace and under Configuration -> Data sources, you should see `aws-observability-accelerator`. Open and click `Save & test`. You should see a notification confirming that the Amazon Managed Service for Prometheus workspace is ready to be used on Grafana.
110
+
Make sure to open the link in the output. After a successful deployment, this will open
111
+
the Prometheus datasource configuration on Grafana.
112
+
Click `Save & test` and you should see a notification confirming that the Amazon Managed Service for Prometheus workspace is ready to be used on Grafana.
2. Amazon Managed Service for Prometheus rules and alerts
128
+
3. Amazon Managed Service for Prometheus rules and alerts
130
129
131
130
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.
0 commit comments