Improvements (#5)

npalm · web-flow · commit 5e06ce2ea127 · 2018-07-14T17:01:50.000+02:00
### Added
- Add variable to enable cloudwatch monitoring for spot instances, by default disabled.
- Add off peak runner settings.
- Add file system root size for runners.

### Changed
- Refactored example, key generation is part of terraform.
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,12 @@
 dist: trusty
 sudo: false
 
+install:
+  - ./ci/bin/install.sh
+
 jobs:
   include:
     - stage: verify
-      script: ./ci/bin/verify.sh 0.11.7 .
+      script: ./ci/bin/verify.sh
     - stage: verify
-      script: ./ci/bin/verify-examples.sh 0.11.7 examples
+      script: ./ci/bin/verify-examples.sh examples
diff --git a/CHNAGELOG.md b/CHNAGELOG.md
@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- Add variable to enable cloudwatch monitoring for spot instances, by default disabled.
+- Add off peak runner settings.
+- Add file system root size for runners.
+
+### Changed
+- Refactored example, key generation is part of terraform.
 
 ## [1.0.3] - 2018-07-14
 ### Changed
diff --git a/README.md b/README.md
@@ -74,7 +74,6 @@ module "gitlab-runner" {
 
 All variables and defaults:
 
-
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
 | amazon_optimized_amis | AMI map per region-zone for the gitlab-runner instance AMI. | map | `<map>` | no |
@@ -94,8 +93,14 @@ All variables and defaults:
 | runners_idle_count | Idle count of the runners, will be used in the runner config.toml | string | `0` | no |
 | runners_idle_time | Idle time of the runners, will be used in the runner config.toml | string | `600` | no |
 | runners_limit | Limit for the runners, will be used in the runner config.toml | string | `0` | no |
+| runners_monitoring | Enable detailed cloudwatch monitoring for spot instances. | string | `false` | no |
 | runners_name | Name of the runner, will be used in the runner config.toml | string | - | yes |
+| runners_off_peak_idle_count | Off peak idle count of the runners, will be used in the runner config.toml. | string | `0` | no |
+| runners_off_peak_idle_time | Off peak idle time of the runners, will be used in the runner config.toml. | string | `0` | no |
+| runners_off_peak_periods | Off peak periods of the runners, will be used in the runner config.toml. | string | `` | no |
+| runners_off_peak_timezone | Off peak idle time zone of the runners, will be used in the runner config.toml. | string | `` | no |
 | runners_privilled | Runners will run in privilled mode, will be used in the runner config.toml | string | `true` | no |
+| runners_root_size | Runnner instance root size in GB. | string | `16` | no |
 | runners_token | Token for the runner, will be used in the runner config.toml | string | - | yes |
 | ssh_public_key | Public SSH key used for the gitlab-runner ec2 instance. | string | - | yes |
 | subnet_id_gitlab_runner | Subnet used for hosting the gitlab-runner. | string | - | yes |
diff --git a/ci/bin/install.sh b/ci/bin/install.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+source $(dirname "${BASH_SOURCE[0]}")/terraform.sh
+
+installTerraform
diff --git a/ci/bin/run-local.sh b/ci/bin/run-local.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+docker run --entrypoint="/bin/sh" -it --rm -w /build -v $(pwd):/build hashicorp/terraform:0.11.7 ./ci/bin/verify.sh
+docker run --entrypoint="/bin/sh" -it --rm -w /build -v $(pwd):/build hashicorp/terraform:0.11.7 ./ci/bin/verify-examples.sh
diff --git a/ci/bin/terraform.sh b/ci/bin/terraform.sh
@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
 
-OS=${TRAVIS_OS_NAME}
 TARGET_DIR=/opt
+PATH=${PATH}:${TARGET_DIR}
+
+TERRAFORM_VERSION=${1:-"0.11.7"}
+OS=${2:-"linux"}
 TERRAFORM_URL="https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_${OS}_amd64.zip"
 
 installTerraform() {
@@ -10,8 +13,6 @@ installTerraform() {
   curl '-#' -fL -o ${TARGET_DIR}/terraform.zip ${TERRAFORM_URL} && \
     unzip -q -d ${TARGET_DIR}/ ${TARGET_DIR}/terraform.zip && \
 
-  export PATH=${PATH}:${TARGET_DIR}
-
   terraform --version
 }
 
diff --git a/ci/bin/verify-examples.sh b/ci/bin/verify-examples.sh
@@ -1,11 +1,9 @@
 #!/usr/bin/env bash
-TERRAFORM_VERSION=$1
-DIR=$2
+DIR=${1:-examples}
 
-source $(dirname "${BASH_SOURCE[0]}")/terraform.sh
-installTerraform
+source $(dirname $0)/terraform.sh
 
-EXAMPLES="$(find ${DIR} -type d -mindepth 1 2> /dev/null )"
+EXAMPLES="$(find ${DIR} -maxdepth 1 -mindepth 1 -type d 2> /dev/null )"
 if [[ -z $EXAMPLES || "$($(echo $EXAMPLES) | wc -l)" -gt 0  ]] ; then
   echo "No example(s) directories found."
   exit 1
diff --git a/ci/bin/verify.sh b/ci/bin/verify.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
-TERRAFORM_VERSION=$1
 
-source $(dirname "${BASH_SOURCE[0]}")/terraform.sh
+source $(dirname $0)/terraform.sh
 
-installTerraform
 validate
 verifyModulesAndPlugins
diff --git a/examples/runner/generated/.gitkeep b/examples/runner/generated/.gitkeep
diff --git a/examples/runner/init.sh b/examples/runner/init.sh
diff --git a/examples/runner/key.tf b/examples/runner/key.tf
@@ -0,0 +1,25 @@
+resource "tls_private_key" "ssh" {
+  algorithm = "RSA"
+}
+
+resource "local_file" "public_ssh_key" {
+  depends_on = ["tls_private_key.ssh"]
+
+  content  = "${tls_private_key.ssh.public_key_openssh}"
+  filename = "${var.public_ssh_key_filename}"
+}
+
+resource "local_file" "private_ssh_key" {
+  depends_on = ["tls_private_key.ssh"]
+
+  content  = "${tls_private_key.ssh.private_key_pem}"
+  filename = "${var.private_ssh_key_filename}"
+}
+
+resource "null_resource" "file_permission" {
+  depends_on = ["local_file.private_ssh_key"]
+
+  provisioner "local-exec" {
+    command = "${format("chmod 600 %s", var.private_ssh_key_filename)}"
+  }
+}
diff --git a/examples/runner/main.tf b/examples/runner/main.tf
@@ -1,24 +1,16 @@
-provider "aws" {
-  region  = "${var.aws_region}"
-  version = "1.23"
-}
-
-provider "template" {
-  version = "1.0"
-}
-
 module "vpc" {
   source  = "terraform-aws-modules/vpc/aws"
-  version = "1.5.1"
+  version = "1.37.0"
 
   name = "vpc-${var.environment}"
   cidr = "10.0.0.0/16"
 
-  azs             = ["eu-west-1a", "eu-west-1b", "eu-west-1c"]
-  private_subnets = ["10.0.1.0/24", "10.0.2.0/24", "10.0.3.0/24"]
-  public_subnets  = ["10.0.101.0/24", "10.0.102.0/24", "10.0.103.0/24"]
+  azs             = ["eu-west-1a"]
+  private_subnets = ["10.0.1.0/24"]
+  public_subnets  = ["10.0.101.0/24"]
 
   enable_nat_gateway = true
+  single_nat_gateway = true
 
   tags = {
     Environment = "${var.environment}"
@@ -28,9 +20,10 @@ module "vpc" {
 module "runner" {
   source = "../../"
 
-  aws_region     = "${var.aws_region}"
-  environment    = "${var.environment}"
-  ssh_public_key = "${file("${var.ssh_key_file}")}"
+  aws_region  = "${var.aws_region}"
+  environment = "${var.environment}"
+
+  ssh_public_key = "${local_file.public_ssh_key.content}"
 
   vpc_id                  = "${module.vpc.vpc_id}"
   subnet_id_gitlab_runner = "${element(module.vpc.private_subnets, 0)}"
@@ -39,4 +32,11 @@ module "runner" {
   runners_name       = "${var.runner_name}"
   runners_gitlab_url = "${var.gitlab_url}"
   runners_token      = "${var.runner_token}"
+
+  runners_off_peak_timezone   = "Europe/Amsterdam"
+  runners_off_peak_idle_count = 0
+  runners_off_peak_idle_time  = 60
+
+  # working 9 to 5 :)
+  runners_off_peak_periods = "[\"* * 0-9,17-23 * * mon-fri *\", \"* * * * * sat,sun *\"]"
 }
diff --git a/examples/runner/providers.tf b/examples/runner/providers.tf
@@ -0,0 +1,20 @@
+provider "aws" {
+  region  = "${var.aws_region}"
+  version = "1.23"
+}
+
+provider "template" {
+  version = "1.0"
+}
+
+provider "local" {
+  version = "1.1"
+}
+
+provider "null" {
+  version = "1.0"
+}
+
+provider "tls" {
+  version = "1.1"
+}
diff --git a/examples/runner/terraform.tfvars b/examples/runner/terraform.tfvars
@@ -5,8 +5,8 @@ environment = "ci"
 aws_region = "eu-west-1"
 
 # Add the following variables:
-runner_name = ""
+runner_name = "docker.m3"
 
-gitlab_url = ""
+gitlab_url = "https://gitlab.com"
 
-runner_token = ""
+runner_token = "3939146918cced54ecf1dd08e6b87e"
diff --git a/examples/runner/variables.tf b/examples/runner/variables.tf
@@ -10,10 +10,14 @@ variable "environment" {
   type        = "string"
 }
 
-variable "ssh_key_file" {
+variable "public_ssh_key_filename" {
   default = "generated/id_rsa.pub"
 }
 
+variable "private_ssh_key_filename" {
+  default = "generated/id_rsa"
+}
+
 variable "runner_name" {
   description = "Name of the runner, will be used in the runner config.toml"
   type        = "string"
diff --git a/main.tf b/main.tf
@@ -109,17 +109,23 @@ data "template_file" "runners" {
     runners_access_key          = "${aws_iam_access_key.docker_machine_user.id}"
     runners_secret_key          = "${aws_iam_access_key.docker_machine_user.secret}"
     runners_security_group_name = "${aws_security_group.docker_machine.name}"
-
-    runners_name           = "${var.runners_name}"
-    runners_token          = "${var.runners_token}"
-    runners_limit          = "${var.runners_limit}"
-    runners_concurrent     = "${var.runners_concurrent}"
-    runners_privilled      = "${var.runners_privilled}"
-    runners_idle_count     = "${var.runners_idle_count}"
-    runners_idle_time      = "${var.runners_idle_time}"
-    bucket_user_access_key = "${aws_iam_access_key.cache_user.id}"
-    bucket_user_secret_key = "${aws_iam_access_key.cache_user.secret}"
-    bucket_name            = "${aws_s3_bucket.build_cache.bucket}"
+    runners_monitoring          = "${var.runners_monitoring}"
+
+    runners_name                = "${var.runners_name}"
+    runners_token               = "${var.runners_token}"
+    runners_limit               = "${var.runners_limit}"
+    runners_concurrent          = "${var.runners_concurrent}"
+    runners_privilled           = "${var.runners_privilled}"
+    runners_idle_count          = "${var.runners_idle_count}"
+    runners_idle_time           = "${var.runners_idle_time}"
+    runners_off_peak_timezone   = "${var.runners_off_peak_timezone}"
+    runners_off_peak_idle_count = "${var.runners_off_peak_idle_count}"
+    runners_off_peak_idle_time  = "${var.runners_off_peak_idle_time}"
+    runners_off_peak_periods    = "${var.runners_off_peak_periods}"
+    runners_root_size           = "${var.runners_root_size}"
+    bucket_user_access_key      = "${aws_iam_access_key.cache_user.id}"
+    bucket_user_secret_key      = "${aws_iam_access_key.cache_user.secret}"
+    bucket_name                 = "${aws_s3_bucket.build_cache.bucket}"
   }
 }
 
diff --git a/template/runner-config.tpl b/template/runner-config.tpl
@@ -26,7 +26,8 @@ check_interval = 0
     IdleTime = ${runners_idle_time}
     MachineDriver = "amazonec2"
     MachineName = "runner-%s"
-    MachineOptions = ["amazonec2-access-key=${runners_access_key}", "amazonec2-secret-key=${runners_secret_key}", "amazonec2-instance-type=${runners_instance_type}", "amazonec2-region=${aws_region}", "amazonec2-vpc-id=${runners_vpc_id}", "amazonec2-subnet-id=${runners_subnet_id}", "amazonec2-private-address-only=true", "amazonec2-request-spot-instance=true", "amazonec2-spot-price=${runners_spot_price_bid}", "amazonec2-security-group=${runners_security_group_name}", "amazonec2-tags=environment,${environment}"]
-    OffPeakTimezone = ""
-    OffPeakIdleCount = 0
-    OffPeakIdleTime = 0
+    MachineOptions = ["amazonec2-access-key=${runners_access_key}", "amazonec2-secret-key=${runners_secret_key}", "amazonec2-instance-type=${runners_instance_type}", "amazonec2-region=${aws_region}", "amazonec2-vpc-id=${runners_vpc_id}", "amazonec2-subnet-id=${runners_subnet_id}", "amazonec2-private-address-only=true", "amazonec2-request-spot-instance=true", "amazonec2-spot-price=${runners_spot_price_bid}", "amazonec2-security-group=${runners_security_group_name}", "amazonec2-tags=environment,${environment}", "amazonec2-monitoring=${runners_monitoring}", "amazonec2-root-size=${runners_root_size}"]
+    OffPeakTimezone = "${runners_off_peak_timezone}"
+    OffPeakIdleCount = ${runners_off_peak_idle_count}
+    OffPeakIdleTime = ${runners_off_peak_idle_time}
+    OffPeakPeriods = ${runners_off_peak_periods}
diff --git a/variables.tf b/variables.tf
@@ -113,6 +113,37 @@ variable "runners_privilled" {
   default     = "true"
 }
 
+variable "runners_monitoring" {
+  description = "Enable detailed cloudwatch monitoring for spot instances."
+  default     = false
+}
+
+variable "runners_off_peak_timezone" {
+  description = "Off peak idle time zone of the runners, will be used in the runner config.toml."
+  default     = ""
+}
+
+variable "runners_off_peak_idle_count" {
+  description = "Off peak idle count of the runners, will be used in the runner config.toml."
+  default     = 0
+}
+
+variable "runners_off_peak_idle_time" {
+  description = "Off peak idle time of the runners, will be used in the runner config.toml."
+  default     = 0
+}
+
+variable "runners_off_peak_periods" {
+  description = "Off peak periods of the runners, will be used in the runner config.toml."
+  type        = "string"
+  default     = ""
+}
+
+variable "runners_root_size" {
+  description = "Runnner instance root size in GB."
+  default     = 16
+}
+
 variable "docker_machine_user" {
   description = "User name for the user to create spot instances to host docker-machine."
   type        = "string"
