storytold/terraform-aws-observability-accelerator
2
0
Fork 0
mirror of https://github.com/storytold/terraform-aws-observability-accelerator.git synced 2026-10-09 00:09:43 +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/workloads/java.md
+8 -7
View File
@@ -7,8 +7,8 @@ configuration options on the cluster infrastructure.
## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
before proceeding.
!!! note
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
## 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">
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
!!! note
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
@@ -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
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
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
from your terraform state before running the destroy command.
!!! warning
Be careful, this command will removing everything created by Terraform. If you wish
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
terraform destroy
docs/workloads/managed-prometheus.md
+4 -4
View File
@@ -7,10 +7,10 @@ workspace dashboard.
## Prerequisites
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`).
!!! note
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`).
## Setup
docs/workloads/nginx.md
+8 -7
View File
@@ -8,8 +8,8 @@ configuration options on the cluster infrastructure.
## Prerequisites
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites)
before proceeding.
!!! note
Make sure to complete the [prerequisites section](https://aws-observability.github.io/terraform-aws-observability-accelerator/concepts/#prerequisites) before proceeding.
## 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">
To setup your alert receiver, with Amazon SNS, follow [this documentation](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-receiver.html)
!!! note
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
@@ -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
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
to keep your Amazon Managed Grafana or Amazon Managed Service for Prometheus workspaces. Remove them
from your terraform state before running the destroy command.
!!! warning
Be careful, this command will removing everything created by Terraform. If you wish
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
terraform destroy