From 61724c93a234f5e8cf3e8e5cf18c750d57846e41 Mon Sep 17 00:00:00 2001 From: Kayla <165940978+kayla-lcm@users.noreply.github.com> Date: Thu, 7 Nov 2024 09:00:46 -0700 Subject: [PATCH] Documentation and changelog updates (#207) --- CHANGELOG.md | 6 ++++++ maintenance-calendar/README.md | 2 +- maintenance-calendar/modules/ecs_scans/README.md | 2 +- maintenance-calendar/modules/ecs_scans/variables.tf | 2 +- maintenance-calendar/variables.tf | 2 +- 5 files changed, 10 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fb2f7ae..55a3a36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/maintenance-calendar/README.md b/maintenance-calendar/README.md index 6c5ba98..f5f60fc 100644 --- a/maintenance-calendar/README.md +++ b/maintenance-calendar/README.md @@ -67,7 +67,7 @@ module "calendar" { | [create\_github\_inactive\_user\_reminder](#input\_create\_github\_inactive\_user\_reminder) | Determines if the inactive github user reminder will be created | `bool` | `false` | no | | [create\_rds\_snapshots](#input\_create\_rds\_snapshots) | Determines if maintenance calendar tasks for managaing RDS snapshots will be created | `bool` | `false` | no | | [image\_scan\_ignore\_arn](#input\_image\_scan\_ignore\_arn) | ARN of an SSM parameter containing CVEs that can safely be ignored.
This parameter must be created manually if it doesn't already exist.

Parameter format: `[{"name":"CVE-2024-1", "packageName":"cowsay", "packageVersion":["1.2.3", "1.2.4"]},{"name"...}]` | `string` | `null` | no | -| [image\_scan\_snooze\_arn](#input\_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"...}]` | `string` | `null` | no | +| [image\_scan\_snooze\_arn](#input\_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", "snoozeUntil":"2024-10-24"},{"cluster"...}]` | `string` | `null` | no | | [maintenance\_sns\_display\_name](#input\_maintenance\_sns\_display\_name) | (Optional) Display name for the maintenance notifications SNS topic | `string` | `null` | no | | [rds\_instance\_names](#input\_rds\_instance\_names) | A list of RDS instance names we want to manage snapshots for | `list(string)` | `null` | no | | [scan\_ecr\_repositories](#input\_scan\_ecr\_repositories) | Map relating project titles to a list of ECR repository names which ought to be scanned periodically | 
map(
    list(string)
  )
| `{}` | no | diff --git a/maintenance-calendar/modules/ecs_scans/README.md b/maintenance-calendar/modules/ecs_scans/README.md index cd824eb..e515d9f 100644 --- a/maintenance-calendar/modules/ecs_scans/README.md +++ b/maintenance-calendar/modules/ecs_scans/README.md @@ -20,7 +20,7 @@ |------|-------------|------|---------|:--------:| | [account\_id](#input\_account\_id) | The AWS account ID | `string` | n/a | yes | | [image\_scan\_ignore\_arn](#input\_image\_scan\_ignore\_arn) | ARN of an SSM parameter containing CVEs that can safely be ignored.
This parameter must be created manually if it doesn't already exist.

Parameter format: `[{"name":"CVE-2024-1", "packageName":"cowsay", "packageVersion":["1.2.3", "1.2.4"]},{"name"...}]` | `string` | n/a | yes | -| [image\_scan\_snooze\_arn](#input\_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"...}]` | `string` | n/a | yes | +| [image\_scan\_snooze\_arn](#input\_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", "snoozeUntil":"2024-10-24"},{"cluster"...}]` | `string` | n/a | yes | | [publish\_alerts\_policy](#input\_publish\_alerts\_policy) | An IAM policy that allows writing to the SNS topic | `string` | n/a | yes | | [region](#input\_region) | The AWS region | `string` | n/a | yes | | [sns\_topic\_arn](#input\_sns\_topic\_arn) | The SNS topic to send alerts to | `string` | n/a | yes | diff --git a/maintenance-calendar/modules/ecs_scans/variables.tf b/maintenance-calendar/modules/ecs_scans/variables.tf index 784d91d..a6da3a8 100644 --- a/maintenance-calendar/modules/ecs_scans/variables.tf +++ b/maintenance-calendar/modules/ecs_scans/variables.tf @@ -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 } diff --git a/maintenance-calendar/variables.tf b/maintenance-calendar/variables.tf index 5a5efdf..e60ba22 100644 --- a/maintenance-calendar/variables.tf +++ b/maintenance-calendar/variables.tf @@ -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 }