Skip to content
Terraform module to build Docker image with Jenkins, save it to an ECR repo, and deploy to Elastic Beanstalk running Docker stack
HCL Go Makefile
Branch: master
Clone or download
aknysh Convert to TF 0.12. Add tests. Add Codefresh test pipeline (#49)
* Convert to TF 0.12

* Convert to TF 0.12

* Convert to TF 0.12

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Convert to TF 0.12. Add tests. Add Codefresh test pipeline

* Update tests

* Update tests

* Update tests

* Update `terraform-aws-elastic-beanstalk-application` version
Latest commit 44766b0 Oct 14, 2019

README.md

README Header

Cloud Posse

terraform-aws-jenkins Codefresh Build Status Latest Release Slack Community

terraform-aws-jenkins is a Terraform module to build a Docker image with Jenkins, save it to an ECR repo, and deploy to Elastic Beanstalk running Docker.

This is an enterprise-ready, scalable and highly-available architecture and the CI/CD pattern to build and deploy Jenkins.

Features

The module will create the following AWS resources:

  • Elastic Beanstalk Application
  • Elastic Beanstalk Environment with Docker stack to run the Jenkins master
  • ECR repository to store the Jenkins Docker image
  • EFS filesystem to store Jenkins config and jobs (it will be mounted to a directory on the EC2 host, and then to the Docker container)
  • AWS Backup stack to automatically backup the EFS
  • CodePipeline with CodeBuild to build and deploy Jenkins so even Jenkins itself follows the CI/CD pattern

After all of the AWS resources are created,

CodePipeline will:

  • Get the specified Jenkins repo from GitHub, e.g. https://github.com/cloudposse/jenkins
  • Build a Docker image from it
  • Save the Docker image to the ECR repo
  • Deploy the Docker image from the ECR repo to Elastic Beanstalk running Docker stack
  • Monitor the GitHub repo for changes and re-run the steps above if new commits are pushed

jenkins build server architecture


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

Terraform Open Source Modules

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.

For a complete example, see examples/complete.

For automatic tests of the complete example, see test.

provider "aws" {
  region = var.region
}

module "vpc" {
  source     = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.8.0"
  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  tags       = var.tags
  delimiter  = var.delimiter
  cidr_block = "172.16.0.0/16"
}

module "subnets" {
  source               = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=tags/0.16.0"
  availability_zones   = var.availability_zones
  namespace            = var.namespace
  stage                = var.stage
  name                 = var.name
  attributes           = var.attributes
  tags                 = var.tags
  delimiter            = var.delimiter
  vpc_id               = module.vpc.vpc_id
  igw_id               = module.vpc.igw_id
  cidr_block           = module.vpc.vpc_cidr_block
  nat_gateway_enabled  = true
  nat_instance_enabled = false
}

module "jenkins" {
  source      = "git::https://github.com/cloudposse/terraform-aws-jenkins.git?ref=master"
  namespace   = var.namespace
  stage       = var.stage
  name        = var.name
  description = var.description

  master_instance_type = var.master_instance_type
  aws_account_id       = var.aws_account_id
  region               = var.region
  availability_zones   = var.availability_zones
  vpc_id               = module.vpc.vpc_id
  dns_zone_id          = var.dns_zone_id
  loadbalancer_subnets = module.subnets.public_subnet_ids
  application_subnets  = module.subnets.private_subnet_ids

  environment_type                       = var.environment_type
  loadbalancer_type                      = var.loadbalancer_type
  loadbalancer_certificate_arn           = var.loadbalancer_certificate_arn
  availability_zone_selector             = var.availability_zone_selector
  rolling_update_type                    = var.rolling_update_type
  loadbalancer_logs_bucket_force_destroy = var.loadbalancer_logs_bucket_force_destroy
  cicd_bucket_force_destroy              = var.cicd_bucket_force_destroy

  github_oauth_token  = var.github_oauth_token
  github_organization = var.github_organization
  github_repo_name    = var.github_repo_name
  github_branch       = var.github_branch

  image_tag = var.image_tag

  healthcheck_url = var.healthcheck_url

  build_image        = var.build_image
  build_compute_type = var.build_compute_type

  efs_backup_schedule           = var.efs_backup_schedule
  efs_backup_start_window       = var.efs_backup_start_window
  efs_backup_completion_window  = var.efs_backup_completion_window
  efs_backup_cold_storage_after = var.efs_backup_cold_storage_after
  efs_backup_delete_after       = var.efs_backup_delete_after

  env_vars = {
    "JENKINS_USER"          = var.jenkins_username
    "JENKINS_PASS"          = var.jenkins_password
    "JENKINS_NUM_EXECUTORS" = var.jenkins_num_executors
  }
}

Makefile Targets

Available targets:

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

Inputs

Name Description Type Default Required
allowed_security_groups List of security groups to be allowed to connect to Jenkins master EC2 instances list(string) <list> no
application_subnets List of subnets to place EC2 instances and EFS list(string) - yes
attributes Additional attributes (e.g. 1) list(string) <list> no
availability_zone_selector Availability Zone selector string Any no
availability_zones List of Availability Zones for EFS list(string) - yes
aws_account_id AWS Account ID. Used as CodeBuild ENV variable $AWS_ACCOUNT_ID when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html string - yes
build_compute_type CodeBuild compute type, e.g. 'BUILD_GENERAL1_SMALL'. For more info: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html string BUILD_GENERAL1_SMALL no
build_image CodeBuild build image, e.g. 'aws/codebuild/amazonlinux2-x86_64-standard:1.0'. For more info: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html string aws/codebuild/docker:1.12.1 no
cicd_bucket_force_destroy Force destroy the CI/CD S3 bucket even if it's not empty bool false no
delimiter Delimiter to be used between namespace, stage, name and attributes string - no
description Will be used as Elastic Beanstalk application description string Jenkins server as Docker container running on Elastic Benastalk no
dns_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
efs_backup_cold_storage_after Specifies the number of days after creation that a recovery point is moved to cold storage number null no
efs_backup_completion_window The amount of time AWS Backup attempts a backup before canceling the job and returning an error. Must be at least 60 minutes greater than start_window number null no
efs_backup_delete_after Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_after number null no
efs_backup_schedule A CRON expression specifying when AWS Backup initiates a backup job string null no
efs_backup_start_window The amount of time in minutes before beginning a backup. Minimum value is 60 minutes number null no
env_vars Map of custom ENV variables to be provided to the Jenkins application running on Elastic Beanstalk, e.g. env_vars = { JENKINS_USER = 'admin' JENKINS_PASS = 'xxxxxx' } map(string) <map> no
environment_type Environment type, e.g. 'LoadBalanced' or 'SingleInstance'. If setting to 'SingleInstance', rolling_update_type must be set to 'Time' or Immutable, and loadbalancer_subnets will be unused (it applies to the ELB, which does not exist in SingleInstance environments) string LoadBalanced no
github_branch GitHub repository branch, e.g. 'master'. By default, this module will deploy 'https://github.com/cloudposse/jenkins' master branch string master no
github_oauth_token GitHub Oauth Token string - yes
github_organization GitHub organization, e.g. 'cloudposse'. By default, this module will deploy 'https://github.com/cloudposse/jenkins' repository string cloudposse no
github_repo_name GitHub repository name, e.g. 'jenkins'. By default, this module will deploy 'https://github.com/cloudposse/jenkins' repository string jenkins no
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 `` no
loadbalancer_logs_bucket_force_destroy Force destroy the S3 bucket for load balancer logs even if it's not empty bool false no
loadbalancer_subnets List of subnets to place Elastic Load Balancer list(string) - yes
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 - yes
namespace Namespace, which could be your organization name, e.g. 'eg' or 'cp' string `` no
region AWS region in which to provision the AWS resources string - yes
rolling_update_type Health, Time or Immutable. Set it to Immutable to apply the configuration change to a fresh group of instances. For more details, see https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html#command-options-general-autoscalingupdatepolicyrollingupdate string Health no
solution_stack_name Elastic Beanstalk stack, e.g. Docker, Go, Node, Java, IIS. For more info: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html string 64bit Amazon Linux 2018.03 v2.12.17 running Docker 18.06.1-ce no
ssh_key_pair Name of SSH key that will be deployed on Elastic Beanstalk instances. The key should be present in AWS string `` no
stage Stage, e.g. 'prod', 'staging', 'dev', or 'test' string `` no
tags Additional tags (e.g. map('BusinessUnit,XYZ) map(string) <map> no
use_efs_ip_address If set to true, will provide the EFS IP address instead of DNS name to Jenkins as ENV var bool false no
vpc_id ID of the VPC in which to provision the AWS resources string - yes

Outputs

Name Description
codebuild_badge_url The URL of the build badge when badge_enabled is enabled
codebuild_cache_bucket_arn CodeBuild cache S3 bucket ARN
codebuild_cache_bucket_name CodeBuild cache S3 bucket name
codebuild_project_id CodeBuild project ID
codebuild_project_name CodeBuild project name
codebuild_role_arn CodeBuild IAM Role ARN
codebuild_role_id CodeBuild IAM Role ID
codepipeline_arn CodePipeline ARN
codepipeline_id CodePipeline ID
ecr_registry_id Registry ID
ecr_registry_url Registry URL
ecr_repository_name Registry name
efs_arn EFS ARN
efs_backup_plan_arn Backup Plan ARN
efs_backup_plan_version Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan
efs_backup_selection_id Backup Selection ID
efs_backup_vault_arn Backup Vault ARN
efs_backup_vault_id Backup Vault ID
efs_backup_vault_recovery_points Backup Vault recovery points
efs_dns_name EFS DNS name
efs_host Route53 DNS hostname for the EFS
efs_id EFS ID
efs_mount_target_dns_names List of EFS mount target DNS names
efs_mount_target_ids List of EFS mount target IDs (one per Availability Zone)
efs_mount_target_ips List of EFS mount target IPs (one per Availability Zone)
efs_network_interface_ids List of mount target network interface IDs
elastic_beanstalk_application_name Elastic Beanstalk Application name
elastic_beanstalk_environment_all_settings List of all option settings configured in the environment. These are a combination of default settings and their overrides from setting in the configuration
elastic_beanstalk_environment_application The Elastic Beanstalk Application specified for this environment
elastic_beanstalk_environment_autoscaling_groups The autoscaling groups used by this environment
elastic_beanstalk_environment_ec2_instance_profile_role_name Instance IAM role name
elastic_beanstalk_environment_elb_zone_id ELB zone id
elastic_beanstalk_environment_endpoint Fully qualified DNS name for the environment
elastic_beanstalk_environment_hostname DNS hostname
elastic_beanstalk_environment_id ID of the Elastic Beanstalk environment
elastic_beanstalk_environment_instances Instances used by this environment
elastic_beanstalk_environment_launch_configurations Launch configurations in use by this environment
elastic_beanstalk_environment_load_balancers Elastic Load Balancers in use by this environment
elastic_beanstalk_environment_name Name
elastic_beanstalk_environment_queues SQS queues in use by this environment
elastic_beanstalk_environment_security_group_id Security group id
elastic_beanstalk_environment_setting Settings specifically set for this environment
elastic_beanstalk_environment_tier The environment tier
elastic_beanstalk_environment_triggers Autoscaling triggers in use by this environment

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.

Help

Got a question?

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

README Commercial Support

Commercial Support

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

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

Newsletter

Signup 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.

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.

  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 changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2019 Cloud Posse, LLC

License

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman
Erik Osterman
Andriy Knysh
Andriy Knysh
Igor Rodionov
Igor Rodionov
Ivan Pinatti
Ivan Pinatti
Sergey Vasilyev
Sergey Vasilyev

README Footer Beacon

You can’t perform that action at this time.