terraform-aws-codebuild

Terraform module to create AWS CodeBuild project for AWS CodePipeline.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

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.

Include this module in your existing terraform code:

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

    # https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
    build_image         = "aws/codebuild/standard:2.0"
    build_compute_type  = "BUILD_GENERAL1_SMALL"
    build_timeout       = 60

    # 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"

    # Optional extra environment variables
    environment_variables = [{
        name  = "JENKINS_URL"
        value = "https://jenkins.example.com"
      },
      {
        name  = "COMPANY_NAME"
        value = "Amazon"
      },
      {
        name = "TIME_ZONE"
        value = "Pacific/Auckland"

      }]
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 0.12.0
aws	~> 2.0
local	~> 1.2
null	~> 2.0
random	~> 2.1
template	~> 2.0

Providers

Name	Version
aws	~> 2.0
random	~> 2.1

Inputs

Name	Description	Type	Default	Required
artifact_type	The build output artifact's type. Valid values for this parameter are: CODEPIPELINE, NO_ARTIFACTS or S3	`string`	`"CODEPIPELINE"`	no
attributes	Additional attributes (e.g. `policy` or `role`)	`list(string)`	`[]`	no
aws_account_id	(Optional) AWS Account ID. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html	`string`	`""`	no
aws_region	(Optional) AWS Region, e.g. us-east-1. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html	`string`	`""`	no
badge_enabled	Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled	`bool`	`false`	no
build_compute_type	Instance type of the build instance	`string`	`"BUILD_GENERAL1_SMALL"`	no
build_image	Docker image for build environment, e.g. 'aws/codebuild/standard:2.0' or 'aws/codebuild/eb-nodejs-6.10.0-amazonlinux-64:4.0.0'. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref.html	`string`	`"aws/codebuild/standard:2.0"`	no
build_timeout	How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed	`number`	`60`	no
build_type	The type of build environment, e.g. 'LINUX_CONTAINER' or 'WINDOWS_CONTAINER'	`string`	`"LINUX_CONTAINER"`	no
buildspec	Optional buildspec declaration to use for building the project	`string`	`""`	no
cache_bucket_suffix_enabled	The cache bucket generates a random 13 character string to generate a unique bucket name. If set to false it uses terraform-null-label's id value. It only works when cache_type is 'S3	`bool`	`true`	no
cache_expiration_days	How many days should the build cache be kept. It only works when cache_type is 'S3'	`number`	`7`	no
cache_type	The type of storage that will be used for the AWS CodeBuild project cache. Valid values: NO_CACHE, LOCAL, and S3. Defaults to NO_CACHE. If cache_type is S3, it will create an S3 bucket for storing codebuild cache inside	`string`	`"NO_CACHE"`	no
delimiter	Delimiter to be used between `name`, `namespace`, `stage`, etc.	`string`	`"-"`	no
enabled	A boolean to enable/disable resource creation	`bool`	`true`	no
environment_variables	A list of maps, that contain both the key 'name' and the key 'value' to be used as additional environment variables for the build	list(object( { name = string value = string }))	[ { "name": "NO_ADDITIONAL_BUILD_VARS", "value": "TRUE" } ]	no
extra_permissions	List of action strings which will be added to IAM service account permissions.	`list`	`[]`	no
fetch_git_submodules	If set to true, fetches Git submodules for the AWS CodeBuild build project.	`bool`	`false`	no
git_clone_depth	Truncate git history to this many commits.	`number`	`null`	no
github_token	(Optional) GitHub auth token environment variable (`GITHUB_TOKEN`)	`string`	`""`	no
image_repo_name	(Optional) ECR repository name to store the Docker image built by this module. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html	`string`	`"UNSET"`	no
image_tag	(Optional) Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html	`string`	`"latest"`	no
local_cache_modes	Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: LOCAL_SOURCE_CACHE, LOCAL_DOCKER_LAYER_CACHE, and LOCAL_CUSTOM_CACHE	`list(string)`	`[]`	no
logs_config	Configuration for the builds to store log data to CloudWatch or S3.	`any`	`{}`	no
name	Solution name, e.g. 'app' or 'jenkins'	`string`	n/a	yes
namespace	Namespace, which could be your organization name, e.g. 'eg' or 'cp'	`string`	`""`	no
private_repository	Set to true to login into private repository with credentials supplied in source_credential variable.	`bool`	`false`	no
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	`bool`	`false`	no
report_build_status	Set to true to report the status of a build's start and finish to your source provider. This option is only valid when the source_type is BITBUCKET or GITHUB	`bool`	`false`	no
source_credential_auth_type	The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository.	`string`	`"PERSONAL_ACCESS_TOKEN"`	no
source_credential_server_type	The source provider used for this project.	`string`	`"GITHUB"`	no
source_credential_token	For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.	`string`	`""`	no
source_credential_user_name	The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.	`string`	`""`	no
source_location	The location of the source code from git or s3	`string`	`""`	no
source_type	The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3	`string`	`"CODEPIPELINE"`	no
source_version	A version of the build input to be built for this project. If not specified, the latest version is used.	`string`	`""`	no
stage	Stage, e.g. 'prod', 'staging', 'dev', or 'test'	`string`	`""`	no
tags	Additional tags (e.g. `map('BusinessUnit', 'XYZ')`	`map(string)`	`{}`	no
vpc_config	Configuration for the builds to run inside a VPC.	`any`	`{}`	no

Outputs

Name	Description
badge_url	The URL of the build badge when badge_enabled is enabled
cache_bucket_arn	Cache S3 bucket ARN
cache_bucket_name	Cache S3 bucket name
project_id	Project ID
project_name	Project name
role_arn	IAM Role ARN
role_id	IAM Role ID

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-ecs-codepipeline - Terraform Module for CI/CD with AWS Code Pipeline and Code Build for ECS

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

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 this project or help out with our other projects, 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.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

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

Copyright

License

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

  https://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.