-
-
Notifications
You must be signed in to change notification settings - Fork 9
/
README.yaml
72 lines (60 loc) · 2.98 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: terraform-aws-efs-cloudwatch-sns-alarms
# Logo for this project
#logo: docs/logo.png
# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-efs-cloudwatch-sns-alarms
# Badges to display
badges:
- name: Latest Release
image: https://img.shields.io/github/release/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms/releases/latest
- name: Last Updated
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms/commits
- name: Slack Community
image: https://slack.cloudposse.com/for-the-badge.svg
url: https://slack.cloudposse.com
# List any related terraform modules that this module may be used with or that this module depends on.
related:
- name: "terraform-aws-efs-backup"
description: "Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline"
url: "https://github.com/cloudposse/terraform-aws-efs-backup"
- name: "terraform-aws-efs"
description: "Terraform Module to define an EFS Filesystem (aka NFS)"
url: "https://github.com/cloudposse/terraform-aws-efs"
- name: "terraform-aws-sns-lambda-notify-slack"
description: "Terraform module to provision a lambda function that subscribes to SNS and notifies to Slack."
url: "https://github.com/cloudposse/terraform-aws-sns-lambda-notify-slack"
- name: "terraform-aws-sns-topic-notify"
description: "Terraform Module to notify SNS topic."
url: "https://github.com/cloudposse/terraform-aws-sns-topic-notify"
# Short description of this project
description: |-
Create a set of sane EFS CloudWatch alerts for monitoring the health of an EFS resource.
| area | metric | comparison operator | threshold | rationale |
|---------|--------------------|----------------------|-------------------|--------------------------------------------------------------------|
| Storage | BurstCreditBalance | `<` | 192000000000 | 192 GB in Bytes (last hour where you can burst at 100 MB/sec) |
| Storage | PercentIOLimit | `>` | 95 | When the IO limit has been exceeded, the system performance drops. |
# How to use this project
examples: |-
```hcl
resource "aws_efs_file_system" "default" {
creation_token = "app"
}
module "efs_alarms" {
source = "git::https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.git?ref=master"
filesystem_id = "${aws_efs_file_system.default.id}"
}
```
include:
- "docs/targets.md"
- "docs/terraform.md"
# Contributors to this project
contributors: []