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/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
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.
You should restrict instead to the ARNs when applicable.
!!! warning
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
@@ -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
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
@@ -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
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.
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