terraform-aws-cicd

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

This module supports three use-cases:

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.).
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
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 app and env attributes for the module.
- http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html

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
    app                 = "<(Optional) Elastic Beanstalk application name>"
    env                 = "<(Optional) Elastic Beanstalk environment name>"
    
    # 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"
}

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
namespace	global	Namespace
stage	default	Stage
name	app	Name
enabled	true	Enable `CodePipeline` creation
app	""	(Optional) Elastic Beanstalk application name. If not provided or set to empty string, the `Deploy` stage of the pipeline will not be created
env	""	(Optional) 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	""	(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 if configured)
branch	""	Branch of the GitHub repository, e.g. `master`
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`
build_compute_type	BUILD_GENERAL1_SMALL	`CodeBuild` instance size. Possible values are: `BUILD_GENERAL1_SMALL` `BUILD_GENERAL1_MEDIUM` `BUILD_GENERAL1_LARGE`
buildspec	""	(Optional) `buildspec` declaration to use for building the project. http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html
privileged_mode	""	(Optional) If set to true, enables running the Docker daemon inside a Docker container on the `CodeBuild` instance. Used when building Docker images
aws_region	""	(Optional) AWS Region, e.g. `us-east-1`. Used as `CodeBuild` ENV variable `$AWS_REGION` when building Docker images
aws_account_id	""	(Optional) AWS Account ID. Used as `CodeBuild` ENV variable `$AWS_ACCOUNT_ID` when building Docker images
image_repo_name	""	(Optional) ECR repository name to store the Docker image built by the module. Used as `CodeBuild` ENV variable `$IMAGE_REPO_NAME` when building Docker images
image_tag	""	(Optional) Docker image tag in the ECR repository, e.g. `latest`. Used as `CodeBuild` ENV variable `$IMAGE_TAG` when building Docker images

License

Apache 2 License. See LICENSE for full details.

cgriggs01 / terraform-aws-cicd Goto Github PK