Skip to content

Commit eb055bc

Browse files
MaStr79Copilot
MaStr79
and
Copilot
committed
docs: add terraform-docs, catalog links, and v1.0.0 changelog
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent e2827ef commit eb055bc

2 files changed

Lines changed: 77 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
</p>
3333
</div>
3434

35+
## Documentation
36+
37+
Full auto-generated documentation of inputs, outputs, and resources: [TERRAFORM-DOCS.md](TERRAFORM-DOCS.md)
38+
3539
<!-- TABLE OF CONTENTS -->
3640
<details>
3741
<summary>Table of Contents</summary>

‎TERRAFORM-DOCS.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
3+
4+
## Requirements
5+
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >=1.3 |
11+
12+
## Providers
13+
14+
## Providers
15+
16+
| Name | Version |
17+
|------|---------|
18+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 6.35.1 |
19+
20+
## Resources
21+
22+
## Resources
23+
24+
| Name | Type |
25+
|------|------|
26+
| [aws_cloudwatch_log_group.application_logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
27+
| [aws_cloudwatch_metric_alarm.custom](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_metric_alarm) | resource |
28+
| [aws_cloudwatch_metric_alarm.ec2_high_cpu](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_metric_alarm) | resource |
29+
| [aws_cloudwatch_metric_alarm.ec2_low_cpu](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_metric_alarm) | resource |
30+
| [aws_sns_topic.cloudwatch_alarms](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic) | resource |
31+
| [aws_sns_topic_policy.allow_cloudwatch](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_policy) | resource |
32+
| [aws_sns_topic_subscription.email](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
33+
34+
## Inputs
35+
36+
## Inputs
37+
38+
| Name | Description | Type | Default | Required |
39+
|------|-------------|------|---------|:--------:|
40+
| <a name="input_environment"></a> [environment](#input\_environment) | Environment (e.g., prod, dev, test) | `string` | n/a | yes |
41+
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | Name of the project | `string` | n/a | yes |
42+
| <a name="input_alarm_datapoints_to_alarm"></a> [alarm\_datapoints\_to\_alarm](#input\_alarm\_datapoints\_to\_alarm) | Number of datapoints that must be breaching to trigger the alarm | `number` | `2` | no |
43+
| <a name="input_alarm_evaluation_periods"></a> [alarm\_evaluation\_periods](#input\_alarm\_evaluation\_periods) | Number of periods over which data is compared to the threshold | `number` | `2` | no |
44+
| <a name="input_alarm_period"></a> [alarm\_period](#input\_alarm\_period) | Period in seconds over which the statistic is applied | `number` | `300` | no |
45+
| <a name="input_custom_metrics"></a> [custom\_metrics](#input\_custom\_metrics) | Custom CloudWatch metrics to create alarms for | <pre>map(object({<br/> metric_name = string<br/> namespace = string<br/> threshold = number<br/> statistic = optional(string, "Average")<br/> comparison_operator = optional(string, "GreaterThanThreshold")<br/> evaluation_periods = optional(number, 2)<br/> datapoints_to_alarm = optional(number)<br/> period = optional(number, 300)<br/> description = optional(string, "")<br/> dimensions = optional(map(string), {})<br/> }))</pre> | `{}` | no |
46+
| <a name="input_ec2_high_cpu_threshold"></a> [ec2\_high\_cpu\_threshold](#input\_ec2\_high\_cpu\_threshold) | CPU utilization threshold for high CPU alarm (percentage) | `number` | `80` | no |
47+
| <a name="input_ec2_instance_ids"></a> [ec2\_instance\_ids](#input\_ec2\_instance\_ids) | List of EC2 instance IDs to monitor | `list(string)` | `[]` | no |
48+
| <a name="input_ec2_low_cpu_threshold"></a> [ec2\_low\_cpu\_threshold](#input\_ec2\_low\_cpu\_threshold) | CPU utilization threshold for low CPU alarm (percentage) | `number` | `10` | no |
49+
| <a name="input_enable_application_logs"></a> [enable\_application\_logs](#input\_enable\_application\_logs) | Enable application log group creation | `bool` | `true` | no |
50+
| <a name="input_enable_detailed_monitoring"></a> [enable\_detailed\_monitoring](#input\_enable\_detailed\_monitoring) | Enable detailed monitoring for EC2 instances | `bool` | `false` | no |
51+
| <a name="input_enable_sns_encryption"></a> [enable\_sns\_encryption](#input\_enable\_sns\_encryption) | Enable encryption for SNS topic | `bool` | `true` | no |
52+
| <a name="input_log_group_kms_key_id"></a> [log\_group\_kms\_key\_id](#input\_log\_group\_kms\_key\_id) | The ARN of the KMS Key to use when encrypting log data | `string` | `""` | no |
53+
| <a name="input_log_retention_days"></a> [log\_retention\_days](#input\_log\_retention\_days) | Number of days to retain logs in CloudWatch | `number` | `30` | no |
54+
| <a name="input_name_prefix"></a> [name\_prefix](#input\_name\_prefix) | Prefix for resource names (if not provided, will use project-environment pattern) | `string` | `""` | no |
55+
| <a name="input_sns_email_endpoints"></a> [sns\_email\_endpoints](#input\_sns\_email\_endpoints) | List of email addresses to subscribe to SNS topic | `list(string)` | `[]` | no |
56+
| <a name="input_sns_kms_key_id"></a> [sns\_kms\_key\_id](#input\_sns\_kms\_key\_id) | KMS key ID for SNS topic encryption (if enable\_sns\_encryption=true) | `string` | `"alias/aws/sns"` | no |
57+
| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags for all resources | `map(string)` | `{}` | no |
58+
59+
## Outputs
60+
61+
## Outputs
62+
63+
| Name | Description |
64+
|------|-------------|
65+
| <a name="output_alarm_arns"></a> [alarm\_arns](#output\_alarm\_arns) | Map of CloudWatch alarm names to their ARNs |
66+
| <a name="output_cpu_alarm_ids"></a> [cpu\_alarm\_ids](#output\_cpu\_alarm\_ids) | The IDs of the CPU alarms created |
67+
| <a name="output_custom_alarm_ids"></a> [custom\_alarm\_ids](#output\_custom\_alarm\_ids) | The IDs of the custom alarms created |
68+
| <a name="output_log_group_arn"></a> [log\_group\_arn](#output\_log\_group\_arn) | The ARN of the CloudWatch Log Group |
69+
| <a name="output_log_group_name"></a> [log\_group\_name](#output\_log\_group\_name) | The name of the CloudWatch Log Group |
70+
| <a name="output_low_cpu_alarm_ids"></a> [low\_cpu\_alarm\_ids](#output\_low\_cpu\_alarm\_ids) | The IDs of the low CPU alarms created |
71+
| <a name="output_sns_subscription_arns"></a> [sns\_subscription\_arns](#output\_sns\_subscription\_arns) | Map of SNS email subscription endpoints to their ARNs |
72+
| <a name="output_sns_topic_arn"></a> [sns\_topic\_arn](#output\_sns\_topic\_arn) | The ARN of the SNS topic used for alarms |
73+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)