terraform-aws-cicd

Terraform module to create AWS CodePipeline with CodeBuild for CI/CD

This module supports 4 use-cases:

1. GitHub -> S3 (build artifact) -> Elastic Beanstalk (running application stack). The module gets the code from a GitHub repository (public or private), builds it by executing the buildspec.yml file from the repository, pushes the built artifact to an S3 bucket, and deploys the artifact to Elastic Beanstalk running one of the supported stacks (e.g. Java, Go, Node, IIS, Python, Ruby, etc.).

   • http://docs.aws.amazon.com/codebuild/latest/userguide/sample-maven-5m.html
   • http://docs.aws.amazon.com/codebuild/latest/userguide/sample-nodejs-hw.html
   • http://docs.aws.amazon.com/codebuild/latest/userguide/sample-go-hw.html

2. GitHub -> ECR (Docker image) -> Elastic Beanstalk (running Docker stack). The module gets the code from a GitHub repository, builds a Docker image from it by executing the buildspec.yml and Dockerfile files from the repository, pushes the Docker image to an ECR repository, and deploys the Docker image to Elastic Beanstalk running Docker stack.

   • http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html

3. GitHub -> ECR (Docker image). The module gets the code from a GitHub repository, builds a Docker image from it by executing the buildspec.yml and Dockerfile files from the repository, and pushes the Docker image to an ECR repository. This is used when we want to build a Docker image from the code and push it to ECR without deploying to Elastic Beanstalk. To activate this mode, don't specify the ebs_app and ebs_env attributes for the module.

   • http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html

4. GitHub -> ECR (Docker image) -> Elastic Container Service. The module gets the code from a GitHub repository, builds a Docker image from it by executing the buildspec.yml and Dockerfile files from the repository, pushes the Docker image to an ECR repository and deploys the Docker image to ECS. To activate this mode, don`t specify ebs_** and specify ``ecs_**`` variables for the module.

   • http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html

Approval

Also, for every scenario, there is the same pipeline implemented with approval stage. It is activated specifying ``approve = true` variable.

Usage

Include this repository as a module in your existing terraform code:

module "build" {
    source              = "git::https://github.com/cloudposse/terraform-aws-cicd.git?ref=master"
    namespace           = "global"
    name                = "app"
    stage               = "staging"

    # Enable the pipeline creation
    enabled             = "true"

    # Elastic Beanstalk
    ebs_app                 = "<(Optional) Elastic Beanstalk application name>"
    ebs_env                 = "<(Optional) Elastic Beanstalk environment name>"

    # ECS
    ecs_cluster             = "<(Optional) ECS cluster name>"
    ecs_service             = "<(Optional) ECS service name>"
    ecs_images_file         = "<(Optional, default images.json) ECS updated images>"

    # Application repository on GitHub
    github_oauth_token  = "(Optional) <GitHub Oauth Token with permissions to access private repositories>"
    repo_owner          = "<GitHub Organization or Person name>"
    repo_name           = "<GitHub repository name of the application to be built and deployed to Elastic Beanstalk>"
    branch              = "<Branch of the GitHub repository>"

    # http://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref.html
    # http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html
    build_image         = "aws/codebuild/docker:1.12.1"
    build_compute_type  = "BUILD_GENERAL1_SMALL"

    # These attributes are optional, used as ENV variables when building Docker images and pushing them to ECR
    # For more info:
    # http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html
    # https://www.terraform.io/docs/providers/aws/r/codebuild_project.html
    privileged_mode     = "true"
    aws_region          = "us-east-1"
    aws_account_id      = "xxxxxxxxxx"
    image_repo_name     = "ecr-repo-name"
    image_tag           = "latest"
    approve             = "false"
    approve_comment     = ""
    approve_url         = ""
}

Example: GitHub, NodeJS, S3 and EB

This is an example to build a Node app, store the build artifact to an S3 bucket, and then deploy it to Elastic Beanstalk running Node stack

buildspec.yml file

version: 0.2

phases:
  install:
    commands:
      - echo Starting installation ...
  pre_build:
    commands:
      - echo Installing NPM dependencies...
      - npm install
  build:
    commands:
      - echo Build started on `date`
  post_build:
    commands:
      - echo Build completed on `date`
artifacts:
  files:
    - node_modules/**/*
    - public/**/*
    - routes/**/*
    - views/**/*
    - app.js

Example: GitHub, NodeJS, Docker, ECR and EB

This is an example to build a Docker image for a Node app, push the Docker image to an ECR repository, and then deploy it to Elastic Beanstalk running Docker stack

buildspec.yml file

version: 0.2

phases:
  pre_build:
    commands:
      - echo Logging in to Amazon ECR...
      - $(aws ecr get-login --region $AWS_REGION)
  build:
    commands:
      - echo Build started on `date`
      - echo Building the Docker image...
      - docker build -t $IMAGE_REPO_NAME .
      - docker tag $IMAGE_REPO_NAME:$IMAGE_TAG $AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$IMAGE_REPO_NAME:$IMAGE_TAG
  post_build:
    commands:
      - echo Build completed on `date`
      - echo Pushing the Docker image to ECR...
      - docker push $AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$IMAGE_REPO_NAME:$IMAGE_TAG
artifacts:
  files:
    - '**/*'

Dockefile

FROM node:latest

WORKDIR /usr/src/app

COPY package.json package-lock.json ./
RUN npm install
COPY . .

EXPOSE 8081
CMD [ "npm", "start" ]

Input

Name	Default	Description
app	""	Elastic Beanstalk application name. If not provided or set to empty string, the Deploy stage of the pipeline will not be created
attributes	[]	Additional attributes (e.g. policy or role)
aws_account_id	""	AWS Account ID. Used as CodeBuild ENV variable when building Docker images. For more info
aws_region	""	AWS Region, e.g. us-east-1. Used as CodeBuild ENV variable when building Docker images. For more info
branch	REQUIRED	Branch of the GitHub repository, e.g. master
build_compute_type	"BUILD_GENERAL1_SMALL"	CodeBuild instance size. Possible values are: BUILD_GENERAL1_SMALL BUILD_GENERAL1_MEDIUM BUILD_GENERAL1_LARGE
build_image	"aws/codebuild/docker:1.12.1"	Docker image for build environment, e.g. aws/codebuild/docker:1.12.1 or aws/codebuild/eb-nodejs-6.10.0-amazonlinux-64:4.0.0
buildspec	""	Declaration to use for building the project. For more info
delimiter	"-"	Delimiter to be used between name, namespace, stage, etc.
enabled	"true"	Enable CodePipeline creation
env	""	Elastic Beanstalk environment name. If not provided or set to empty string, the Deploy stage of the pipeline will not be created
github_oauth_token	REQUIRED	GitHub Oauth Token with permissions to access private repositories
image_repo_name	"UNSET"	ECR repository name to store the Docker image built by this module. Used as CodeBuild ENV variable when building Docker images. For more info
image_tag	"latest"	Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable when building Docker images. For more info
name	"app"	Solution name, e.g. 'app' or 'jenkins'
namespace	"global"	Namespace, which could be your organization name, e.g. 'cp' or 'cloudposse'
poll_source_changes	"true"	Periodically check the location of your source content and run the pipeline if changes are detected
privileged_mode	"false"	If set to true, enables running the Docker daemon inside a Docker container on the CodeBuild instance. Used when building Docker images
repo_name	REQUIRED	GitHub repository name of the application to be built (and deployed to Elastic Beanstalk if configured)
repo_owner	REQUIRED	GitHub Organization or Person name
stage	"default"	Stage, e.g. 'prod', 'staging', 'dev', or 'test'
tags	{}	Additional tags (e.g. map('BusinessUnit', 'XYZ')

Output

Name	Description

Help

Got a question?

File a GitHub issue, send us an email or reach out to us on Gitter.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing terraform-aws-cicd, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

APACHE 2.0 © 2017 Cloud Posse, LLC

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com

We love Open Source Software!

See our other projects or hire us to help build your next cloud-platform.

Contributors

Erik Osterman	Igor Rodionov	Andriy Knysh