storytold/terraform-aws-observability-accelerator
2
0
Fork 0
mirror of https://github.com/storytold/terraform-aws-observability-accelerator.git synced 2026-10-29 08:56:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs prettify (#112)

Browse Source 
* docs admonitions

* removing test files

* Revert "docs admonitions"

This reverts commit a76ce7804e03b6f1a44c31fa2c6933345bfdd836.

* docs improvements

* removing broken links

* updating diagram
This commit is contained in:
Kevin Lewin
2023-02-07 15:27:25 -05:00
committed by GitHub
parent 0c0ac15496
commit 0b2023492f
9 changed files with 51 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/concepts.md
+9 -5
View File
@@ -13,8 +13,9 @@ All examples in this repository require the following tools installed
To run the examples, you need a set of AWS IAM permissions. You can find an example of minimum To run the examples, you need a set of AWS IAM permissions. You can find an example of minimum
permissions required [in this file](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/docs/iam/min-iam-policy.json). permissions required [in this file](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/docs/iam/min-iam-policy.json).
> **Note**: The policy resource is set as `*` to allow all resources, this is not a recommended practice. !!! warning
You should restrict instead to the ARNs when applicable. The policy resource is set as `*` to allow all resources, this is not a recommended practice.
You should restrict instead to the ARNs when applicable.
### Terraform states and variables ### Terraform states and variables
@@ -27,7 +28,8 @@ You can also edit the `terraform.tfvars` files directly and deploy
with `terraform apply -var-file=terraform.tfvars`. Terraform tfvars file can be useful if with `terraform apply -var-file=terraform.tfvars`. Terraform tfvars file can be useful if
you need to track changes as part of a Git repository or CI/CD pipeline. you need to track changes as part of a Git repository or CI/CD pipeline.
> **Note:** When using `tfvars` files, always be careful to not store and commit any secrets (keys, passwords, ...) !!! warning
When using `tfvars` files, always be careful to not store and commit any secrets (keys, passwords, ...)
## Base module ## Base module
@@ -53,7 +55,7 @@ module "eks_observability_accelerator" {
} }
``` ```
You can optionally reuse an existing Amazon Managed Servce for Prometheus Workspace: You can optionally reuse an existing Amazon Managed Service for Prometheus Workspace:
```hcl ```hcl
module "eks_observability_accelerator" { module "eks_observability_accelerator" {
@@ -89,7 +91,9 @@ All the modules come with end-to-end deployable examples.
[Examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples) put modules together in a ready to deploy terraform configuration as a starting point. With little to no configuration, you can run `terraform apply` and use the deployed resources on your AWS Account. [Examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples) put modules together in a ready to deploy terraform configuration as a starting point. With little to no configuration, you can run `terraform apply` and use the deployed resources on your AWS Account.
You can find **workload** examples like [Amazon EKS infrstructure monitoring](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/) or [monitoring your Amazon Managed Service for Prometheus workspace](https://aws-observability.github.io/terraform-aws-observability-accelerator/workloads/managed-prometheus/) and more. You can find **workload** examples like [Amazon EKS infrastructure monitoring](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/) or [monitoring your Amazon Managed Service for Prometheus workspace](https://aws-observability.github.io/terraform-aws-observability-accelerator/workloads/managed-prometheus/) and more.
![example diagram](images/example-diagram.svg)
## Getting started with AWS Observability services ## Getting started with AWS Observability services
docs/eks/destroy.md
+4 -3
View File
@@ -3,9 +3,10 @@
If you leave this stack running, you will continue to incur charges. To remove all resources If you leave this stack running, you will continue to incur charges. To remove all resources
created by Terraform, [refresh your Grafana API key](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/#6-grafana-api-key) and run the command below. created by Terraform, [refresh your Grafana API key](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/#6-grafana-api-key) and run the command below.
Be careful, this command will removing everything created by Terraform. If you wish !!! warning
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them Be careful, this command will removing everything created by Terraform. If you wish
from your terraform state before running the destroy command. to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
from your terraform state before running the destroy command.
```bash ```bash
terraform destroy terraform destroy
docs/eks/index.md
+4 -4
View File
@@ -22,8 +22,8 @@ on your EKS cluster.
## Prerequisites ## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) !!! note
before proceeding. Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
## Setup ## Setup
@@ -132,8 +132,8 @@ Open the Amazon Managed Service for Prometheus console and view the details of y
<img width="1629" alt="image" src="https://user-images.githubusercontent.com/10175027/189301297-4865e75d-2d71-434f-b5d0-9750b3533632.png"> <img width="1629" alt="image" src="https://user-images.githubusercontent.com/10175027/189301297-4865e75d-2d71-434f-b5d0-9750b3533632.png">
!!! note
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html) To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
## Custom metrics collection ## Custom metrics collection
docs/helpers/new-eks-cluster.md
+4 -3
View File
@@ -1,6 +1,7 @@
# Creating a new Amazon EKS cluster with VPC # Creating a new Amazon EKS cluster with VPC
> Note: This example is a subset from [this EKS Blueprint example](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/examples/eks-cluster-with-new-vpc) !!! note
This example is a subset from [this EKS Blueprint example](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/examples/eks-cluster-with-new-vpc)
This example deploys the following: This example deploys the following:
@@ -10,8 +11,8 @@ This example deploys the following:
## Prerequisites ## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) !!! note
before proceeding. Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
## Setup ## Setup
docs/images/example-diagram.svg
+1
View File
File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

docs/index.md
+9 -8
View File
@@ -3,7 +3,7 @@
Welcome to the AWS Observability Accelerator for Terraform! Welcome to the AWS Observability Accelerator for Terraform!
The AWS Observability accelerator is a set of Terraform modules to help you The AWS Observability accelerator is a set of Terraform modules to help you
configure Observability for your container workloads and environemnts with AWS configure Observability for your container workloads and environments with AWS
Observability services. This project proposes a core module to bootstrap Observability services. This project proposes a core module to bootstrap
your Amazon EKS cluster with the AWS Distro for OpenTelemetry (ADOT) Operator for EKS, your Amazon EKS cluster with the AWS Distro for OpenTelemetry (ADOT) Operator for EKS,
Amazon Managed Service for Prometheus, Amazon Managed Grafana. Amazon Managed Service for Prometheus, Amazon Managed Grafana.
@@ -23,19 +23,20 @@ dashboards and alerts for monitoring:
- Java/JMX workloads (running on Amazon EKS) - Java/JMX workloads (running on Amazon EKS)
- Amazon Managed Service for Prometheus workspaces with Amazon CloudWatch - Amazon Managed Service for Prometheus workspaces with Amazon CloudWatch
These modules can be directly configured in your exisiting Terraform configurations or ready These modules can be directly configured in your existing Terraform configurations or ready
to be deployed in our packaged to be deployed in our packaged
[examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples) [examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples)
We have supporting examples for quick setup such as: !!! tip
We have supporting examples for quick setup such as:
- Creating an empty Amazon EKS cluster and a VPC - Creating an empty Amazon EKS cluster and a VPC
- Creating and configure an Amazon Managed Grafana workspace with SSO - Creating and configure an Amazon Managed Grafana workspace with SSO
## Motivation ## Motivation
To gain deep visibility into your workloads and environements, AWS proposes a To gain deep visibility into your workloads and environments, AWS proposes a
set of secure, scalabale, highly available, production-grade managed open set of secure, scalable, highly available, production-grade managed open
source services such as Amazon Managed Service for Prometheus, Amazon Managed source services such as Amazon Managed Service for Prometheus, Amazon Managed
Grafana and Amazon OpenSearch. Grafana and Amazon OpenSearch.
@@ -43,7 +44,7 @@ AWS customers have asked for best-practices and guidance to collect metrics, log
and traces from their containerized applications and microservices with ease of and traces from their containerized applications and microservices with ease of
deployment. Customers can use the AWS Observability Accelerator to configure their deployment. Customers can use the AWS Observability Accelerator to configure their
metrics collection, leveraging [AWS Distro for OpenTelemetry](https://aws-otel.github.io/), metrics collection, leveraging [AWS Distro for OpenTelemetry](https://aws-otel.github.io/),
to have opinionated dashoards and alerts available in only minutes. to have opinionated dashboards and alerts available in only minutes.
## Support & Feedback ## Support & Feedback
docs/workloads/java.md
+8 -7
View File
@@ -7,8 +7,8 @@ configuration options on the cluster infrastructure.
## Prerequisites ## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) !!! note
before proceeding. Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
## Setup ## Setup
@@ -118,8 +118,8 @@ Open the Amazon Managed Service for Prometheus console and view the details of y
<img width="1314" alt="image" src="https://user-images.githubusercontent.com/97046295/194904104-09a28577-d149-478e-b0a1-dc21cb7effc1.png"> <img width="1314" alt="image" src="https://user-images.githubusercontent.com/97046295/194904104-09a28577-d149-478e-b0a1-dc21cb7effc1.png">
!!! note
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html) To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
## Deploy an Example Java Application ## Deploy an Example Java Application
@@ -178,9 +178,10 @@ tomcat-traffic-generator 1/1 Running 0 11s
If you leave this stack running, you will continue to incur charges. To remove all resources If you leave this stack running, you will continue to incur charges. To remove all resources
created by Terraform, [refresh your Grafana API key](#6-grafana-api-key) and run the command below. created by Terraform, [refresh your Grafana API key](#6-grafana-api-key) and run the command below.
Be careful, this command will removing everything created by Terraform. If you wish !!! warning
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them Be careful, this command will removing everything created by Terraform. If you wish
from your terraform state before running the destroy command. to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
from your terraform state before running the destroy command.
```bash ```bash
terraform destroy terraform destroy
docs/workloads/managed-prometheus.md
+4 -4
View File
@@ -7,10 +7,10 @@ workspace dashboard.
## Prerequisites ## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) !!! note
before proceeding. Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
before proceeding.
> This example doesn't require an Amazon EKS cluster and Kubernetes tools (ex. `kubectl`). This example doesn't require an Amazon EKS cluster and Kubernetes tools (ex. `kubectl`).
## Setup ## Setup
docs/workloads/nginx.md
+8 -7
View File
@@ -8,8 +8,8 @@ configuration options on the cluster infrastructure.
## Prerequisites ## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) !!! note
before proceeding. Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
## Setup ## Setup
@@ -118,8 +118,8 @@ Open the Amazon Managed Service for Prometheus console and view the details of y
<img width="1054" alt="image" src="https://user-images.githubusercontent.com/97046295/190665728-ae8bb709-ad93-4629-b845-85c158dd1925.png"> <img width="1054" alt="image" src="https://user-images.githubusercontent.com/97046295/190665728-ae8bb709-ad93-4629-b845-85c158dd1925.png">
!!! note
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html) To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
## Deploy an Example Application to Visualize ## Deploy an Example Application to Visualize
@@ -178,9 +178,10 @@ Log back into your Managed Grafana Workspace and navigate to the dashboard side
If you leave this stack running, you will continue to incur charges. To remove all resources If you leave this stack running, you will continue to incur charges. To remove all resources
created by Terraform, [refresh your Grafana API key](#6-grafana-api-key) and run the command below. created by Terraform, [refresh your Grafana API key](#6-grafana-api-key) and run the command below.
Be careful, this command will removing everything created by Terraform. If you wish !!! warning
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them Be careful, this command will removing everything created by Terraform. If you wish
from your terraform state before running the destroy command. to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
from your terraform state before running the destroy command.
```bash ```bash
terraform destroy terraform destroy