From c739bb0ae34a9c68eb0a5f1b3d40b2371300c510 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Wed, 22 May 2019 16:05:08 +0100 Subject: [PATCH] Build documentation updates --- README.md | 11 ++++++++--- docs/terraform.md | 4 ++-- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c359a76..3cebb7c 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,11 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are ## Usage + +**IMPORTANT:** The `master` branch is used in `source` just as an example. In your code, do not pin to `master` because there may be breaking changes between releases. +Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases](https://github.com/cloudposse/terraform-aws-jenkins/releases). + + For complete examples, see [examples](examples). @@ -303,7 +308,6 @@ Available targets: lint Lint terraform code ``` - ## Inputs | Name | Description | Type | Default | Required | @@ -327,6 +331,7 @@ Available targets: | healthcheck_url | Application Health Check URL. Elastic Beanstalk will call this URL to check the health of the application running on EC2 instances | string | `/login` | no | | image_tag | Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable $IMAGE_TAG when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html | string | `latest` | no | | loadbalancer_certificate_arn | Load Balancer SSL certificate ARN. The certificate must be present in AWS Certificate Manager | string | - | yes | +| loadbalancer_ssl_policy | Load Balancer SSL Security Policy | string | `ELBSecurityPolicy-2016-08` | no | | loadbalancer_type | Load Balancer type, e.g. 'application' or 'classic' | string | `application` | no | | master_instance_type | EC2 instance type for Jenkins master, e.g. 't2.medium' | string | `t2.medium` | no | | name | Solution name, e.g. 'app' or 'jenkins' | string | `jenkins` | no | @@ -339,7 +344,7 @@ Available targets: | ssh_key_pair | Name of SSH key that will be deployed on Elastic Beanstalk and DataPipeline instance. The key should be present in AWS | string | `` | no | | stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | - | yes | | tags | Additional tags (e.g. `map('BusinessUnit`,`XYZ`) | map | `` | no | -| use_efs_ip_address | | string | `false` | no | +| use_efs_ip_address | - | string | `false` | no | | vpc_id | ID of the VPC in which to provision the AWS resources | string | - | yes | | zone_id | Route53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the EB environment and EFS | string | - | yes | @@ -429,7 +434,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. ## Copyright -Copyright © 2017-2018 [Cloud Posse, LLC](https://cpco.io/copyright) +Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright) diff --git a/docs/terraform.md b/docs/terraform.md index 1a9a222..e61dfbd 100644 --- a/docs/terraform.md +++ b/docs/terraform.md @@ -1,4 +1,3 @@ - ## Inputs | Name | Description | Type | Default | Required | @@ -22,6 +21,7 @@ | healthcheck_url | Application Health Check URL. Elastic Beanstalk will call this URL to check the health of the application running on EC2 instances | string | `/login` | no | | image_tag | Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable $IMAGE_TAG when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html | string | `latest` | no | | loadbalancer_certificate_arn | Load Balancer SSL certificate ARN. The certificate must be present in AWS Certificate Manager | string | - | yes | +| loadbalancer_ssl_policy | Load Balancer SSL Security Policy | string | `ELBSecurityPolicy-2016-08` | no | | loadbalancer_type | Load Balancer type, e.g. 'application' or 'classic' | string | `application` | no | | master_instance_type | EC2 instance type for Jenkins master, e.g. 't2.medium' | string | `t2.medium` | no | | name | Solution name, e.g. 'app' or 'jenkins' | string | `jenkins` | no | @@ -34,7 +34,7 @@ | ssh_key_pair | Name of SSH key that will be deployed on Elastic Beanstalk and DataPipeline instance. The key should be present in AWS | string | `` | no | | stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | - | yes | | tags | Additional tags (e.g. `map('BusinessUnit`,`XYZ`) | map | `` | no | -| use_efs_ip_address | | string | `false` | no | +| use_efs_ip_address | - | string | `false` | no | | vpc_id | ID of the VPC in which to provision the AWS resources | string | - | yes | | zone_id | Route53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the EB environment and EFS | string | - | yes |