Refactor, update docs

Author: npalm

examples/default/main.tf

@@ -1,16 +1,10 @@
 locals {
-  environment = "test.default"
+  environment = "default-action-runners"
   aws_region  = "eu-west-1"
 }
 
-resource "random_string" "random" {
-  length  = 24
-  special = false
-  upper   = false
-}
-
 module "runners" {
-  source = "../../modules/runners"
+  source = "../../"
 
   aws_region = local.aws_region
   vpc_id     = module.vpc.vpc_id
@@ -19,6 +13,6 @@ module "runners" {
   tags = {
     Project = "ProjectX"
   }
-  distribution_bucket_name = random_string.random.result
+
 }
 

examples/default/outputs.tf

@@ -1,8 +1,5 @@
-output "runners" {
+output "action_runners" {
   value = {
-    launch_template_name       = module.runners.launch_template.name
-    launch_template_id         = module.runners.launch_template.id
-    launch_template_version    = module.runners.launch_template.latest_version
-    action_runner_distribution = module.runners.s3_location_runner_distribution
+    runners = module.runners.runners
   }
 }

main.tf

@@ -0,0 +1,17 @@
+resource "random_string" "random" {
+  length  = 24
+  special = false
+  upper   = false
+}
+
+module "runners" {
+  source = "./modules/runners"
+
+  aws_region = var.aws_region
+  vpc_id     = var.vpc_id
+
+  environment              = var.environment
+  tags                     = var.tags
+  distribution_bucket_name = random_string.random.result
+}
+

modules/runners/README.md

@@ -0,0 +1,9 @@
+# Action runner module
+
+The module create resources to facilitate the `orchestrator labmda` to recreate action runners.
+
+- *launch template* : A launch template is creates that can crate an action runner, by default a spot instance is requested. For configuration parameters SSM is used. 
+- *security group* : Security groups attached to the action runner.
+- *s3 bucket* : To avoid the action runner distribution have to be download a cached version is expected in a S3 bucket.
+- *policies and roles* : Policies and roles for the action runner. By default the session manager is enabled
+

modules/runners/templates/user-data.sh

@@ -41,11 +41,11 @@ while [[ $(aws ssm get-parameters --names ${environment}-$INSTANCE_ID --with-dec
     echo Waiting for configuration ...
     sleep 1
 done
-config=$(aws ssm get-parameters --names ${environment}-$INSTANCE_ID --with-decryption --region $REGION | jq -r ".Parameters | .[0] | .Value")
-aws ssm delete-parameter --names ${environment}-$INSTANCE_ID --with-decryption --region $REGION
+CONFIG=$(aws ssm get-parameters --names ${environment}-$INSTANCE_ID --with-decryption --region $REGION | jq -r ".Parameters | .[0] | .Value")
+aws ssm delete-parameter --name ${environment}-$INSTANCE_ID --region $REGION
 
 export RUNNER_ALLOW_RUNASROOT=1
-./config.sh --unattended --name $INSTANCE_ID --work "_work" $config
+./config.sh --unattended --name $INSTANCE_ID --work "_work" $CONFIG
 
 chown -R ec2-user:ec2-user .
 ./svc.sh install ec2-user

modules/runners/variables.tf

@@ -4,10 +4,10 @@ variable "aws_region" {
 }
 
 variable "vpc_id" {
-  description = "The VPC to spin up instances in"
+  description = "The VPC for the security groupss."
+  type        = string
 }
 
-
 variable "overrides" {
   description = "This maps provides the possibility to override some defaults. The following attributes are supported: `name_sg` overwrite the `Name` tag for all security groups created by this module. `name_runner_agent_instance` override the `Name` tag for the ec2 instance defined in the auto launch configuration. `name_docker_machine_runners` ovverrid the `Name` tag spot instances created by the runner agent."
   type        = map(string)
@@ -29,7 +29,8 @@ variable "environment" {
 }
 
 variable "distribution_bucket_name" {
-  type = string
+  description = "Bucket for storing the action runner distribution."
+  type        = string
 }
 
 variable "block_device_mappings" {
@@ -39,25 +40,24 @@ variable "block_device_mappings" {
 }
 
 variable "market_options" {
-  default = "spot"
+  description = "Market options for the action runner instances."
+  type        = string
+  default     = "spot"
 }
 
 variable "instance_type" {
-  default = "m5.large"
-}
-
-variable "associate_public_ip_address" {
-  type    = bool
-  default = false
+  description = "Default instance type for the action runner."
+  type        = string
+  default     = "m5.large"
 }
 
 variable "action_runner_dist_bucket_location" {
-  default = "actions-runner-linux.tar.gz"
+  description = "Default location action runner distribution."
+  default     = "actions-runner-linux.tar.gz"
 }
 
-
 variable "ami_filter" {
-  description = "List of maps used to create the AMI filter for the runner AMI. Currently Amazon Linux 2 `amzn2-ami-hvm-2.0.????????-x86_64-ebs` looks to *not* be working for this configuration."
+  description = "List of maps used to create the AMI filter for the action runner AMI."
   type        = map(list(string))
 
   default = {
@@ -66,7 +66,7 @@ variable "ami_filter" {
 }
 
 variable "ami_owners" {
-  description = "The list of owners used to select the AMI of runner instances."
+  description = "The list of owners used to select the AMI of action runner instances."
   type        = list(string)
   default     = ["amazon"]
 }

outputs.tf

@@ -0,0 +1,8 @@
+output "runners" {
+  value = {
+    launch_template_name       = module.runners.launch_template.name
+    launch_template_id         = module.runners.launch_template.id
+    launch_template_version    = module.runners.launch_template.latest_version
+    action_runner_distribution = module.runners.s3_location_runner_distribution
+  }
+}

variables.tf

@@ -0,0 +1,21 @@
+variable "aws_region" {
+  description = "AWS region."
+  type        = string
+}
+
+variable "vpc_id" {
+  description = "The VPC for security groups of the action runners."
+  type        = string
+}
+
+variable "tags" {
+  description = "Map of tags that will be added to created resources. By default resources will be tagged with name and environment."
+  type        = map(string)
+  default     = {}
+}
+
+variable "environment" {
+  description = "A name that identifies the environment, used as prefix and for tagging."
+  type        = string
+}
+