Skip to content

Commit 4fdb719

Browse files
authored
doc: Update Managed Grafana instructions (#51)
* Update README.md * Update README.md * Add Grafana workspace id as output * Fix instructions
1 parent fcc5b90 commit 4fdb719

File tree

5 files changed

+20
-1
lines changed

5 files changed

+20
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ If you are interested in contributing to EKS Blueprints, see the [Contribution g
178178
| <a name="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version) | EKS Cluster version |
179179
| <a name="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 |
180180
| <a name="output_managed_grafana_workspace_endpoint"></a> [managed\_grafana\_workspace\_endpoint](#output\_managed\_grafana\_workspace\_endpoint) | Amazon Managed Grafana workspace endpoint |
181+
| <a name="output_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#output\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana workspace ID |
181182
| <a name="output_managed_prometheus_workspace_endpoint"></a> [managed\_prometheus\_workspace\_endpoint](#output\_managed\_prometheus\_workspace\_endpoint) | Amazon Managed Prometheus workspace endpoint |
182183
| <a name="output_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#output\_managed\_prometheus\_workspace\_id) | Amazon Managed Prometheus workspace ID |
183184
| <a name="output_managed_prometheus_workspace_region"></a> [managed\_prometheus\_workspace\_region](#output\_managed\_prometheus\_workspace\_region) | Amazon Managed Prometheus workspace region |

examples/existing-cluster-with-base-and-infra/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,13 @@ If you don't specify anything a new workspace will be created for you.
6060

6161
6. Amazon Managed Grafana workspace
6262

63-
If you have an existing workspace, create an environment variable `export TF_VAR_managed_grafana_workspace_id=g-xxx`.
63+
To run this example you need an Amazon Managed Grafana workspace. If you have an existing workspace, create an environment variable `export TF_VAR_managed_grafana_workspace_id=g-xxx`.
64+
65+
To create a new one, within this example's Terraform state (sharing the same lifecycle with all the other resources):
66+
67+
- Edit main.tf and set `enable_managed_grafana = true`
68+
- Run `terraform apply -target "module.eks_observability_accelerator.module.managed_grafana[0].aws_grafana_workspace.this[0]"`.
69+
- Run `export TF_VAR_managed_grafana_workspace_id=$(terraform output --raw managed_grafana_workspace_id)`.
6470

6571
7. <a name="apikey"></a> Grafana API Key
6672

@@ -181,6 +187,7 @@ terraform destroy -var-file=terraform.tfvars
181187
| <a name="output_eks_cluster_id"></a> [eks\_cluster\_id](#output\_eks\_cluster\_id) | EKS Cluster Id |
182188
| <a name="output_eks_cluster_version"></a> [eks\_cluster\_version](#output\_eks\_cluster\_version) | EKS Cluster version |
183189
| <a name="output_grafana_dashboard_urls"></a> [grafana\_dashboard\_urls](#output\_grafana\_dashboard\_urls) | URLs for dashboards created |
190+
| <a name="output_managed_grafana_workspace_id"></a> [managed\_grafana\_workspace\_id](#output\_managed\_grafana\_workspace\_id) | Amazon Managed Grafana workspace ID |
184191
| <a name="output_managed_prometheus_workspace_endpoint"></a> [managed\_prometheus\_workspace\_endpoint](#output\_managed\_prometheus\_workspace\_endpoint) | Amazon Managed Prometheus workspace endpoint |
185192
| <a name="output_managed_prometheus_workspace_id"></a> [managed\_prometheus\_workspace\_id](#output\_managed\_prometheus\_workspace\_id) | Amazon Managed Prometheus workspace ID |
186193
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/existing-cluster-with-base-and-infra/outputs.tf

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ output "managed_prometheus_workspace_id" {
2323
value = module.eks_observability_accelerator.managed_prometheus_workspace_id
2424
}
2525

26+
output "managed_grafana_workspace_id" {
27+
description = "Amazon Managed Grafana workspace ID"
28+
value = module.eks_observability_accelerator.managed_grafana_workspace_id
29+
}
30+
2631
output "grafana_dashboard_urls" {
2732
description = "URLs for dashboards created"
2833
value = module.workloads_infra.grafana_dashboard_urls

locals.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ locals {
2626
# if grafana_workspace_id is supplied, we infer the endpoint from
2727
# computed region, else we create a new workspace
2828
amg_ws_endpoint = var.managed_grafana_workspace_id == "" ? "https://${module.managed_grafana[0].workspace_endpoint}" : "https://${data.aws_grafana_workspace.this[0].endpoint}"
29+
amg_ws_id = var.managed_grafana_workspace_id == "" ? split(".", module.managed_grafana[0].workspace_endpoint)[0] : var.managed_grafana_workspace_id
2930

3031
context = {
3132
aws_caller_identity_account_id = data.aws_caller_identity.current.account_id

outputs.tf

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ output "managed_grafana_workspace_endpoint" {
3333
value = local.amg_ws_endpoint
3434
}
3535

36+
output "managed_grafana_workspace_id" {
37+
description = "Amazon Managed Grafana workspace ID"
38+
value = local.amg_ws_id
39+
}
40+
3641
output "grafana_dashboards_folder_id" {
3742
description = "Grafana folder ID for automatic dashboards. Required by workload modules"
3843
value = grafana_folder.this.id

0 commit comments

Comments
 (0)