feat(terraform): vol5223 add eventbridge scheduling for batch jobs (#197

)

* feat(terraform): vol5223 initial setup of eventbridge module for batch

* feat(terraform): add schedules block in locals

* docs: update Terraform docs

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* docs: update Terraform docs

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): create eventbridge module with temp hardcoded example

* feat(terraform): add if statement to scheduled jobs

* feat(terraform): add if statement to scheduled jobs

* docs: update Terraform docs

* feat(terraform): add if statement to scheduled jobs

* docs: update Terraform docs

* feat(terraform): add if statement to scheduled jobs

* feat(terraform): add if statement to scheduled jobs

* feat(terraform): fix local schedules

* feat(terraform): add if statement to scheduled jobs

* feat(terraform): add if statement to scheduled jobs

* feat(terraform): add if statement to scheduled jobs

* feat(terraform): add conditional for scheduled jobs only

* feat(terraform): add conditional for scheduled jobs only

* feat(terraform): add conditional for scheduled jobs only

* feat(terraform): add variables for region and account number

* docs: update Terraform docs

* feat(terraform): tidy up formatting for eventbridge module

* feat(terraform): linting fixes

* docs: update Terraform docs

* feat(terraform): less strict versioning and cleaner if statement on eventbridge module

* feat(terraform): attempt logical reference in eventbridge batch input

* feat(terraform): fix merge conflict and remove unsued data calls

* docs: update Terraform docs

* feat(terraform): ammend job name and description

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

infra/terraform/environments/dev/main.tf

@@ -265,26 +265,31 @@ module "service" {
         name     = "clean-up-variations",
         commands = ["batch:clean-up-variations"],
         timeout  = 43200,
+        schedule = "cron(00 02 * * ? *)",
       },
       {
         name     = "cns",
         commands = ["batch:cns"],
         timeout  = 43200,
+        schedule = "cron(30 18 ? * 7 *)",
       },
       {
         name     = "create-psv-licence-surrender-task",
         commands = ["batch:create-psv-licence-surrender-task"],
         timeout  = 43200,
+        schedule = "cron(00 02 * * ? *)",
       },
       {
         name     = "psv-operator-list-export",
         commands = ["batch:data-gov-uk-export", "-v", "--report-name=psv-operator-list", "--path=/tmp/"],
         timeout  = 43200,
+        schedule = "cron(00 02 ? * 7 *)",
       },
       {
         name     = "international-goods-export",
         commands = ["batch:data-gov-uk-export", "-v", "--report-name=international-goods", "--path=/tmp/"],
         timeout  = 43200,
+        schedule = "cron(00 02 ? * 7 *)",
       },
       {
         name     = "data-retention-populate",
@@ -310,26 +315,31 @@ module "service" {
         name     = "digital-continuation-reminders",
         commands = ["batch:digital-continuation-reminders"],
         timeout  = 43200,
+        schedule = "cron(00 02 * * ? *)",
       },
       {
         name     = "duplicate-vehicle-warning",
         commands = ["batch:duplicate-vehicle-warning"],
         timeout  = 43200,
+        schedule = "cron(0 18 ? * 1-5 *)",
       },
       {
         name     = "enqueue-ch-compare",
         commands = ["batch:enqueue-ch-compare"],
         timeout  = 1800,
+        schedule = "cron(0 21 ? * 3 *)",
       },
       {
         name     = "expire-bus-registration",
         commands = ["batch:expire-bus-registration"],
         timeout  = 43200,
+        schedule = "cron(0 21 ? * 3 *)",
       },
       {
         name     = "flag-urgent-tasks",
         commands = ["batch:flag-urgent-tasks"],
         timeout  = 1800,
+        schedule = "cron(0 * * * ? *)",
       },
       {
         name     = "import-users-from-csv",
@@ -339,21 +349,25 @@ module "service" {
         name     = "inspection-request-email",
         commands = ["batch:inspection-request-email"],
         timeout  = 1800,
+        schedule = "cron(0 00-04 * * ? *)",
       },
       {
         name     = "interim-end-date-enforcement",
         commands = ["batch:interim-end-date-enforcement"],
         timeout  = 43200,
+        schedule = "cron(00 02 * * ? *)",
       },
       {
         name     = "last-tm-letter",
         commands = ["batch:last-tm-letter"],
         timeout  = 43200,
+        schedule = "cron(30 06 * * ? *)",
       },
       {
         name     = "licence-status-rules",
         commands = ["batch:licence-status-rules"],
         timeout  = 1800,
+        schedule = "cron(0 * * * ? *)",
       },
       {
         name     = "process-cl",
@@ -363,21 +377,25 @@ module "service" {
         name     = "process-inbox",
         commands = ["batch:process-inbox"],
         timeout  = 43200,
+        schedule = "cron(45 01 * ? *)",
       },
       {
         name     = "process-ntu",
         commands = ["batch:process-ntu"],
         timeout  = 43200,
+        schedule = "cron(45 01 * ? *)",
       },
       {
         name     = "remove-read-audit",
         commands = ["batch:remove-read-audit"],
         timeout  = 43200,
+        schedule = "cron(0 22 ? * 7 *)",
       },
       {
         name     = "resolve-payments",
         commands = ["batch:resolve-payments"],
         timeout  = 150,
+        schedule = "cron(0/5 * * * ? *)",
       },
       {
         name     = "system-parameter",
@@ -391,81 +409,97 @@ module "service" {
         name     = "close-expired-windows",
         commands = ["permits:close-expired-windows"],
         timeout  = 43200,
+        schedule = "cron(45 00 * * ? *)",
       },
       {
         name     = "mark-expired-permits",
         commands = ["permits:mark-expired-permits"],
         timeout  = 43200,
+        schedule = "cron(15 06 * * ? *)",
       },
       {
         name     = "process-queue-general",
         commands = ["queue:process-queue", "--exclude", "que_typ_ch_compare,que_typ_create_gds_vehicle_list,que_typ_create_psv_vehicle_list,que_typ_disc_printing,que_typ_print,que_typ_disc_printing_print,que_typ_create_com_lic,que_typ_remove_deleted_docs,que_typ_permit_generate,que_typ_permit_print,que_typ_run_ecmt_scoring,que_typ_accept_ecmt_scoring,que_typ_irhp_permits_allocate"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-queue-community-licences",
         commands = ["queue:process-queue", "--type", "que_typ_create_com_lic"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-queue-disc-generation",
         commands = ["queue:process-queue", "--type", "que_typ_create_gds_vehicle_list,que_typ_create_psv_vehicle_list,que_typ_disc_printing"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-queue-disc-print",
         commands = ["queue:process-queue", "--type", "que_typ_disc_printing_print", "--queue-duration", "840"],
         timeout  = 850,
+        schedule = "cron(0/15 * * * ? *)",
       },
       {
         name     = "process-queue-ecmt-accept",
         commands = ["queue:process-queue", "--type", "que_typ_accept_ecmt_scoring"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-queue-irhp-allocate",
         commands = ["queue:process-queue", "--type", "que_typ_run_ecmt_scoring"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-queue-permit-generation",
         commands = ["queue:process-queue", "--type", "que_typ_permit_generate"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-queue-permit-print",
         commands = ["queue:process-queue", "--type", "que_typ_permit_print", "--queue-duration", "840"],
         timeout  = 850,
+        schedule = "cron(0/15 * * * ? *)",
       },
       {
         name     = "process-queue-print",
         commands = ["queue:process-queue", "--type", "que_typ_print"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
       {
         name     = "process-company-profile",
         commands = ["queue:process-company-profile"],
         timeout  = 150,
+        schedule = "cron(0/5 * * * ? *)",
       },
       {
         name     = "company-profile-dlq",
         commands = ["queue:company-profile-dlq"],
         timeout  = 900,
+        schedule = "cron(0/30 * * * ? *)",
       },
       {
         name     = "process-insolvency",
         commands = ["queue:process-insolvency"],
         timeout  = 900,
+        schedule = "cron(0/30 * * * ? *)",
       },
       {
         name     = "process-insolvency-dlq",
         commands = ["queue:process-insolvency-dlq"],
         timeout  = 900,
+        schedule = "cron(0/30 * * * ? *)",
       },
       {
         name     = "transxchange-consumer",
         commands = ["queue:transxchange-consumer"],
         timeout  = 90,
+        schedule = "cron(0/2 * * * ? *)",
       },
     ]
   }

infra/terraform/modules/service/README.md

@@ -21,6 +21,7 @@
 | <a name="module_cloudfront"></a> [cloudfront](#module\_cloudfront) | terraform-aws-modules/cloudfront/aws | ~> 3.4 |
 | <a name="module_ecs_cluster"></a> [ecs\_cluster](#module\_ecs\_cluster) | terraform-aws-modules/ecs/aws//modules/cluster | ~> 5.10 |
 | <a name="module_ecs_service"></a> [ecs\_service](#module\_ecs\_service) | terraform-aws-modules/ecs/aws//modules/service | ~> 5.10 |
+| <a name="module_eventbridge"></a> [eventbridge](#module\_eventbridge) | terraform-aws-modules/eventbridge/aws | ~> 3.7 |
 | <a name="module_log_bucket"></a> [log\_bucket](#module\_log\_bucket) | terraform-aws-modules/s3-bucket/aws | ~> 4.0 |
 | <a name="module_records"></a> [records](#module\_records) | terraform-aws-modules/route53/aws//modules/records | ~> 3.1 |
 | <a name="module_route53_records"></a> [route53\_records](#module\_route53\_records) | terraform-aws-modules/acm/aws | ~> 5.0 |
@@ -46,7 +47,7 @@
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_assets_version"></a> [assets\_version](#input\_assets\_version) | The version of the assets | `string` | n/a | yes |
-| <a name="input_batch"></a> [batch](#input\_batch) | Configuration for the batch process | <pre>object({<br>    version    = string<br>    repository = string<br>    subnet_ids = list(string)<br>    task_iam_role_statements = list(object({<br>      effect    = string<br>      actions   = list(string)<br>      resources = list(string)<br>    }))<br>    jobs = list(object({<br>      name     = string<br>      commands = list(string)<br>      cpu      = optional(number, 1)<br>      memory   = optional(number, 2048)<br>      timeout  = optional(number, 300)<br>    }))<br>  })</pre> | n/a | yes |
+| <a name="input_batch"></a> [batch](#input\_batch) | Configuration for the batch process | <pre>object({<br>    version    = string<br>    repository = string<br>    subnet_ids = list(string)<br>    task_iam_role_statements = list(object({<br>      effect    = string<br>      actions   = list(string)<br>      resources = list(string)<br>    }))<br>    jobs = list(object({<br>      name     = string<br>      commands = list(string)<br>      cpu      = optional(number, 1)<br>      memory   = optional(number, 2048)<br>      timeout  = optional(number, 300)<br>      schedule = optional(string, "")<br>    }))<br>  })</pre> | n/a | yes |
 | <a name="input_domain_name"></a> [domain\_name](#input\_domain\_name) | The domain name for the environment | `string` | n/a | yes |
 | <a name="input_environment"></a> [environment](#input\_environment) | The environment to deploy to | `string` | n/a | yes |
 | <a name="input_legacy_environment"></a> [legacy\_environment](#input\_legacy\_environment) | The legacy environment to deploy use | `string` | n/a | yes |

infra/terraform/modules/service/batch.tf

@@ -74,6 +74,16 @@ locals {
     attempt_duration_seconds = job.timeout
     retry_strategy           = local.default_retry_policy
   } }
+
+  schedules = {
+    for job in var.batch.jobs : job.name => {
+      description         = "Schedule for ${module.batch.job_definitions[job.name].name}"
+      schedule_expression = job.schedule
+      arn                 = "arn:aws:scheduler:::aws-sdk:batch:submitJob"
+      input               = jsonencode({ "jobName" : module.batch.job_definitions[job.name].name, "jobQueue" : module.batch.job_queues.default.arn, "jobDefinition" : module.batch.job_definitions[job.name].arn })
+    }
+    if job.schedule != ""
+  }
 }
 
 module "batch" {
@@ -116,6 +126,16 @@ module "batch" {
   job_definitions = local.jobs
 }
 
+module "eventbridge" {
+  source  = "terraform-aws-modules/eventbridge/aws"
+  version = "~> 3.7"
+
+  create_bus  = false
+  create_role = true
+
+  schedules = local.schedules
+}
+
 resource "aws_cloudwatch_log_group" "this" {
   name              = "/aws/batch/vol-app-${var.environment}"
   retention_in_days = 1

infra/terraform/modules/service/variables.tf

@@ -63,6 +63,7 @@ variable "batch" {
       cpu      = optional(number, 1)
       memory   = optional(number, 2048)
       timeout  = optional(number, 300)
+      schedule = optional(string, "")
     }))
   })
 }