Merge branch 'release/4.11.0'

.github/pull_request_template.md

@@ -8,4 +8,4 @@ YES | NO - If yes please describe the migration.
 Please mention the examples you have verified.
 
 ## Documentation
-Please ensure you update the README in `_docs/README.md`. The README.md in the root can be updated by running the script `ci/bin/autodocs.sh`
+Please ensure you update the README in `_docs/README.md`. The README.md in the root can be updated by running the script `ci/bin/autodocs.sh`, requires `terraform-docs` version 0.8+

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## 4.11.0 - 2020-02-25
+- Change: Update terraform-docs to support 0.8.x #185
+- Change: Support Amazon Linux #184 by @chludwig-haufe
+- Change: Bump gitlab runner version to 12.7.1 from 12.6.0 #183 @loustler 
+- Fix: Fix error create bucket false #182 @katiatalh w
+- Change: Add inputs for EBS-optimized #181 @chrizkim
+- Change: Added agent- and runner-only tags #179 @Glen-Moonpig
+- Change: Improving Spot Cancelation script. #174 @pshuman-heb
+- Change: Forcing updates of Instances on Config change. #173 @pshuman-heb
+
 ## 4.10.0 - 2019-12-24
 - Change: default version of the runner to 12.6.0
 - Fix: External references from destroy provisioners are deprecated (examples)
@@ -266,8 +276,9 @@ Module is available as Terraform 0.11 module, pin module to version 3.x. Please
 - Update default AMI's to The latest Amazon Linux AMI 2017.09.1 - released on 2018-01-17.
 - Minor updates in the example
 
-[Unreleased]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.10.0...HEAD
+[Unreleased]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.11.0...HEAD
 [4.10.0]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.9.0...4.10.0
+[4.11.0]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.10.0...4.11.0
 [4.9.0]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.8.0...4.9.0
 [4.8.0]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.7.0...4.8.0
 [4.7.0]: https://github.com/npalm/terraform-aws-gitlab-runner/compare/4.6.0...4.7.0

_docs/README.md

@@ -57,7 +57,7 @@ In this scenario *not* docker machine is used but docker to schedule the builds.
 
 Ensure you have Terraform installed the modules is based on Terraform 0.11, see `.terraform-version` for the used version. A handy tool to mange your Terraform version is [tfenv](https://github.com/kamatama41/tfenv).
 
-On macOS it is simple to install `tfenv` using brew.
+On macOS it is simple to install `tfenv` using `brew`.
 
 ``` sh
 brew install tfenv
@@ -71,7 +71,17 @@ tfenv install <version>
 
 ### AWS
 
-Ensure you have setup you AWS credentials. The module requires access to IAM, EC2, CloudWatch, S3 and SSM.
+Ensure you have setup your AWS credentials. The module requires access to IAM, EC2, CloudWatch, S3 and SSM.
+
+### JQ & AWS CLI
+
+In order to be able to destroy the module, you will need to run from a host with both `jq` and `aws` installed and accessible in the environment.
+
+On macOS it is simple to install them using `brew`.
+
+``` sh
+brew install jq awscli
+```
 
 ### Service linked roles
 
@@ -94,7 +104,7 @@ resource "aws_iam_service_linked_role" "autoscaling" {
 
 ### GitLab runner token configuration
 
-By default the runner is registered on initial deployment. In previous versions of this module this was a manual process. The manual process is still supported but will be removed in future releases. The runner token will be stored in the parameter store. See [example](examples/runner-pre-registered/) for more details.
+By default the runner is registered on initial deployment. In previous versions of this module this was a manual process. The manual process is still supported but will be removed in future releases. The runner token will be stored in the AWS SSM parameter store. See [example](examples/runner-pre-registered/) for more details.
 
 To register the runner automatically set the variable `gitlab_runner_registration_config["token"]`. This token value can be found in your GitLab project, group, or global settings. For a generic runner you can find the token in the admin section. By default the runner will be locked to the target project, not run untagged. Below is an example of the configuration map.
 
@@ -110,7 +120,7 @@ gitlab_runner_registration_config = {
 }
 ```
 
-For migration to the new setup simply add the runner token to the parameter store. Once the runner is started it will lookup the required values via the parameter store. If the value is `null` a new runner will be created.
+For migration to the new setup simply add the runner token to the parameter store. Once the runner is started it will lookup the required values via the parameter store. If the value is `null` a new runner will be registered and a new token created/stored.
 
 ``` sh
 # set the following variables, look up the variables in your Terraform config.
@@ -153,7 +163,7 @@ gitlab_url   = "GITLAB_URL"
 runner_token = "RUNNER_TOKEN"
 ```
 
-The base image used to host the GitLab Runner agent is the latest available Amazon Linux HVM EBS AMI. In previous versions of this module a hard coded list of AMIs per region was provided. This list has been replaced by a search filter to find the latest AMI. Setting the filter to `amzn-ami-hvm-2018.03.0.20180622-x86_64-ebs` will allow you to version lock the target AMI.
+The base image used to host the GitLab Runner agent is the latest available Amazon Linux 2 HVM EBS AMI. In previous versions of this module a hard coded list of AMIs per region was provided. This list has been replaced by a search filter to find the latest AMI. Setting the filter to `amzn2-ami-hvm-2.0.20200207.1-x86_64-ebs` will allow you to version lock the target AMI.
 
 ### Usage module