Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and changelog updates #207

Merged
merged 1 commit into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## [1.0.107] - 2024-11-05

- [Maintenance Calendar]
- Remove definition for reserved lambda environment variable
- Update documentation

## [1.0.106] - 2024-11-01
- [Fargate Ecs] Add Fargate Ecs Module

Expand Down
2 changes: 1 addition & 1 deletion maintenance-calendar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ module "calendar" {
| <a name="input_create_github_inactive_user_reminder"></a> [create\_github\_inactive\_user\_reminder](#input\_create\_github\_inactive\_user\_reminder) | Determines if the inactive github user reminder will be created | `bool` | `false` | no |
| <a name="input_create_rds_snapshots"></a> [create\_rds\_snapshots](#input\_create\_rds\_snapshots) | Determines if maintenance calendar tasks for managaing RDS snapshots will be created | `bool` | `false` | no |
| <a name="input_image_scan_ignore_arn"></a> [image\_scan\_ignore\_arn](#input\_image\_scan\_ignore\_arn) | ARN of an SSM parameter containing CVEs that can safely be ignored.<br/> This parameter must be created manually if it doesn't already exist.<br/><br/> Parameter format: `[{"name":"CVE-2024-1", "packageName":"cowsay", "packageVersion":["1.2.3", "1.2.4"]},{"name"...}]` | `string` | `null` | no |
| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/> This parameter must be created manually if it doesn't already exist.<br/><br/> Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]` | `string` | `null` | no |
| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/> This parameter must be created manually if it doesn't already exist.<br/><br/> Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]` | `string` | `null` | no |
| <a name="input_maintenance_sns_display_name"></a> [maintenance\_sns\_display\_name](#input\_maintenance\_sns\_display\_name) | (Optional) Display name for the maintenance notifications SNS topic | `string` | `null` | no |
| <a name="input_rds_instance_names"></a> [rds\_instance\_names](#input\_rds\_instance\_names) | A list of RDS instance names we want to manage snapshots for | `list(string)` | `null` | no |
| <a name="input_scan_ecr_repositories"></a> [scan\_ecr\_repositories](#input\_scan\_ecr\_repositories) | Map relating project titles to a list of ECR repository names which ought to be scanned periodically | <pre>map(<br/> list(string)<br/> )</pre> | `{}` | no |
Expand Down
2 changes: 1 addition & 1 deletion maintenance-calendar/modules/ecs_scans/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
|------|-------------|------|---------|:--------:|
| <a name="input_account_id"></a> [account\_id](#input\_account\_id) | The AWS account ID | `string` | n/a | yes |
| <a name="input_image_scan_ignore_arn"></a> [image\_scan\_ignore\_arn](#input\_image\_scan\_ignore\_arn) | ARN of an SSM parameter containing CVEs that can safely be ignored.<br/> This parameter must be created manually if it doesn't already exist.<br/><br/> Parameter format: `[{"name":"CVE-2024-1", "packageName":"cowsay", "packageVersion":["1.2.3", "1.2.4"]},{"name"...}]` | `string` | n/a | yes |
| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/> This parameter must be created manually if it doesn't already exist.<br/><br/> Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]` | `string` | n/a | yes |
| <a name="input_image_scan_snooze_arn"></a> [image\_scan\_snooze\_arn](#input\_image\_scan\_snooze\_arn) | ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.<br/> This parameter must be created manually if it doesn't already exist.<br/><br/> Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]` | `string` | n/a | yes |
| <a name="input_publish_alerts_policy"></a> [publish\_alerts\_policy](#input\_publish\_alerts\_policy) | An IAM policy that allows writing to the SNS topic | `string` | n/a | yes |
| <a name="input_region"></a> [region](#input\_region) | The AWS region | `string` | n/a | yes |
| <a name="input_sns_topic_arn"></a> [sns\_topic\_arn](#input\_sns\_topic\_arn) | The SNS topic to send alerts to | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion maintenance-calendar/modules/ecs_scans/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ variable "image_scan_snooze_arn" {
ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.
This parameter must be created manually if it doesn't already exist.

Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]`
Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]`
EOF
}

Expand Down
2 changes: 1 addition & 1 deletion maintenance-calendar/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ variable "image_scan_snooze_arn" {
ARN of an SSM parameter containing ECS cluster names and a date to snooze alerts.
This parameter must be created manually if it doesn't already exist.

Parameter format: `[{"cluster":"ecs-cluster-1", "date":"2024-10-24"},{"cluster"...}]`
Parameter format: `[{"cluster":"ecs-cluster-1", "snoozeUntil":"2024-10-24"},{"cluster"...}]`
EOF
}

Expand Down
Loading