refactor(runners): rename variable enabled_userdata -> enable_userdata (

#2784)

* Rename variable enabled_userdata -> enable_userdata

* Fix escaped occurrences of enabled_userdata

* Reformat terraform code

README.md

@@ -458,7 +458,7 @@ We welcome any improvement to the standard module to make the default as secure
 | <a name="input_enable_ssm_on_runners"></a> [enable\_ssm\_on\_runners](#input\_enable\_ssm\_on\_runners) | Enable to allow access the runner instances for debugging purposes via SSM. Note that this adds additional permissions to the runner instances. | `bool` | `false` | no |
 | <a name="input_enable_user_data_debug_logging_runner"></a> [enable\_user\_data\_debug\_logging\_runner](#input\_enable\_user\_data\_debug\_logging\_runner) | Option to enable debug logging for user-data, this logs all secrets as well. | `bool` | `false` | no |
 | <a name="input_enable_workflow_job_events_queue"></a> [enable\_workflow\_job\_events\_queue](#input\_enable\_workflow\_job\_events\_queue) | Enabling this experimental feature will create a secondory sqs queue to wich a copy of the workflow\_job event will be delivered. | `bool` | `false` | no |
-| <a name="input_enabled_userdata"></a> [enabled\_userdata](#input\_enabled\_userdata) | Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI. | `bool` | `true` | no |
+| <a name="input_enable_userdata"></a> [enable\_userdata](#input\_enable\_userdata) | Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI. | `bool` | `true` | no |
 | <a name="input_environment"></a> [environment](#input\_environment) | DEPRECATED, no longer used. See `prefix` | `string` | `null` | no |
 | <a name="input_fifo_build_queue"></a> [fifo\_build\_queue](#input\_fifo\_build\_queue) | Enable a FIFO queue to remain the order of events received by the webhook. Suggest to set to true for repo level runners. | `bool` | `false` | no |
 | <a name="input_ghes_ssl_verify"></a> [ghes\_ssl\_verify](#input\_ghes\_ssl\_verify) | GitHub Enterprise SSL verification. Set to 'false' when custom certificate (chains) is used for GitHub Enterprise Server (insecure). | `bool` | `true` | no |

examples/ephemeral/main.tf

@@ -70,7 +70,7 @@ module "runners" {
   enable_job_queued_check = true
 
   # configure your pre-built AMI
-  # enabled_userdata = false
+  # enable_userdata = false
   # ami_filter       = { name = ["github-runner-amzn2-x86_64-*"] }
   # data "aws_caller_identity" "current" {}
   # ami_owners       = [data.aws_caller_identity.current.account_id]

examples/prebuilt/README.md

@@ -62,7 +62,7 @@ module "runners" {
   # provide the owner id of
   ami_owners        = ["<your owner id>"]
 
-  enabled_userdata = false
+  enable_userdata = false
   ...
 }
 ```

examples/prebuilt/main.tf

@@ -41,9 +41,9 @@ module "runners" {
   runner_os = var.runner_os
 
   # configure your pre-built AMI
-  enabled_userdata = false
-  ami_filter       = { name = [var.ami_name_filter] }
-  ami_owners       = [data.aws_caller_identity.current.account_id]
+  enable_userdata = false
+  ami_filter      = { name = [var.ami_name_filter] }
+  ami_owners      = [data.aws_caller_identity.current.account_id]
 
   # Look up runner AMI ID from an AWS SSM parameter (overrides ami_filter at instance launch time)
   # NOTE: the parameter must be managed outside of this module (e.g. in a runner AMI build workflow)

examples/ubuntu/main.tf

@@ -98,7 +98,7 @@ module "runners" {
   # Uncomment to enable ephemeral runners
   # delay_webhook_event      = 0
   # enable_ephemeral_runners = true
-  # enabled_userdata         = true
+  # enable_userdata         = true
 
   # Uncommet idle config to have idle runners from 9 to 5 in time zone Amsterdam
   # idle_config = [{

images/README.md

@@ -33,5 +33,5 @@ ami_filter        = { name = ["github-runner-amzn2-x86_64-2021*"] }
 # provide the owner id of 
 ami_owners        = ["<your owner id>"]
 
-enabled_userdata = false
+enable_userdata = false
 ```

main.tf

@@ -244,7 +244,7 @@ module "runners" {
   role_path                 = var.role_path
   role_permissions_boundary = var.role_permissions_boundary
 
-  enabled_userdata               = var.enabled_userdata
+  enable_userdata                = var.enable_userdata
   enable_user_data_debug_logging = var.enable_user_data_debug_logging_runner
   userdata_template              = var.userdata_template
   userdata_pre_install           = var.userdata_pre_install

modules/multi-runner/runners.tf

@@ -74,7 +74,7 @@ module "runners" {
   role_path                 = var.role_path
   role_permissions_boundary = var.role_permissions_boundary
 
-  enabled_userdata      = each.value.runner_config.enabled_userdata
+  enable_userdata       = each.value.runner_config.enable_userdata
   userdata_template     = each.value.runner_config.userdata_template
   userdata_pre_install  = each.value.runner_config.userdata_pre_install
   userdata_post_install = each.value.runner_config.userdata_post_install

modules/multi-runner/variables.tf

@@ -46,7 +46,7 @@ variable "multi_runner_config" {
       enable_organization_runners             = optional(bool, false)
       enable_runner_binaries_syncer           = optional(bool, true)
       enable_ssm_on_runners                   = optional(bool, false)
-      enabled_userdata                        = optional(bool, true)
+      enable_userdata                         = optional(bool, true)
       instance_allocation_strategy            = optional(string, "lowest-price")
       instance_max_spot_price                 = optional(string, null)
       instance_target_capacity_type           = optional(string, "spot")
@@ -136,7 +136,7 @@ variable "multi_runner_config" {
         enable_organization_runners: "Register runners to organization, instead of repo level"
         enable_runner_binaries_syncer: "Option to disable the lambda to sync GitHub runner distribution, useful when using a pre-build AMI."
         enable_ssm_on_runners: "Enable to allow access the runner instances for debugging purposes via SSM. Note that this adds additional permissions to the runner instances."
-        enabled_userdata: "Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI."
+        enable_userdata: "Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI."
         instance_allocation_strategy: "The allocation strategy for spot instances. AWS recommends to use `capacity-optimized` however the AWS default is `lowest-price`."
         instance_max_spot_price: "Max price price for spot intances per hour. This variable will be passed to the create fleet as max spot price for the fleet."
         instance_target_capacity_type: "Default lifecycle used for runner instances, can be either `spot` or `on-demand`."

modules/runners/README.md

@@ -138,7 +138,7 @@ yarn run dist
 | <a name="input_enable_runner_detailed_monitoring"></a> [enable\_runner\_detailed\_monitoring](#input\_enable\_runner\_detailed\_monitoring) | Enable detailed monitoring for runners | `bool` | `false` | no |
 | <a name="input_enable_ssm_on_runners"></a> [enable\_ssm\_on\_runners](#input\_enable\_ssm\_on\_runners) | Enable to allow access to the runner instances for debugging purposes via SSM. Note that this adds additional permissions to the runner instances. | `bool` | n/a | yes |
 | <a name="input_enable_user_data_debug_logging"></a> [enable\_user\_data\_debug\_logging](#input\_enable\_user\_data\_debug\_logging) | Option to enable debug logging for user-data, this logs all secrets as well. | `bool` | `false` | no |
-| <a name="input_enabled_userdata"></a> [enabled\_userdata](#input\_enabled\_userdata) | Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI | `bool` | `true` | no |
+| <a name="input_enable_userdata"></a> [enable\_userdata](#input\_enable\_userdata) | Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI | `bool` | `true` | no |
 | <a name="input_environment"></a> [environment](#input\_environment) | A name that identifies the environment, used as prefix and for tagging. | `string` | `null` | no |
 | <a name="input_ghes_ssl_verify"></a> [ghes\_ssl\_verify](#input\_ghes\_ssl\_verify) | GitHub Enterprise SSL verification. Set to 'false' when custom certificate (chains) is used for GitHub Enterprise Server (insecure). | `bool` | `true` | no |
 | <a name="input_ghes_url"></a> [ghes\_url](#input\_ghes\_url) | GitHub Enterprise Server URL. DO NOT SET IF USING PUBLIC GITHUB | `string` | `null` | no |

modules/runners/main.tf

@@ -135,7 +135,7 @@ resource "aws_launch_template" "runner" {
     )
   }
 
-  user_data = var.enabled_userdata ? base64encode(templatefile(local.userdata_template, {
+  user_data = var.enable_userdata ? base64encode(templatefile(local.userdata_template, {
     enable_debug_logging            = var.enable_user_data_debug_logging
     s3_location_runner_distribution = local.s3_location_runner_distribution
     pre_install                     = var.userdata_pre_install

modules/runners/variables.tf

@@ -142,7 +142,7 @@ variable "ami_id_ssm_parameter_name" {
   default     = null
 }
 
-variable "enabled_userdata" {
+variable "enable_userdata" {
   description = "Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI"
   type        = bool
   default     = true

variables.tf

@@ -208,7 +208,7 @@ variable "enable_runner_detailed_monitoring" {
   default     = false
 }
 
-variable "enabled_userdata" {
+variable "enable_userdata" {
   description = "Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI."
   type        = bool
   default     = true