Home

Awesome

<!-- markdownlint-disable -->

terraform-aws-jenkins Latest Release Slack Community

<!-- markdownlint-restore -->

README Header

Cloud Posse

<!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

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:

After all of the AWS resources are created,

CodePipeline will:

jenkins build server architecture


This project is part of our comprehensive "SweetOps" approach towards DevOps. <img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/> <img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" /> <img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" /> <img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" /> <img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" /> <img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />

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!

Security & Compliance <img src="https://cloudposse.com/wp-content/uploads/2020/11/bridgecrew.svg" width="250" align="right" />

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

BenchmarkDescription
Infrastructure SecurityInfrastructure Security Compliance
CIS KUBERNETESCenter for Internet Security, KUBERNETES Compliance
CIS AWSCenter for Internet Security, AWS Compliance
CIS AZURECenter for Internet Security, AZURE Compliance
PCI-DSSPayment Card Industry Data Security Standards Compliance
NIST-800-53National Institute of Standards and Technology Compliance
ISO27001Information Security Management System, ISO/IEC 27001 Compliance
SOC2Service Organization Control 2 Compliance
CIS GCPCenter for Internet Security, GCP Compliance
HIPAAHealth Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

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 = "cloudposse/jenkins/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  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
  }
}
<!-- markdownlint-disable -->

Makefile Targets

Available targets:

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

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 0.14.0
<a name="requirement_aws"></a> aws>= 2.0

Providers

NameVersion
<a name="provider_aws"></a> aws>= 2.0

Modules

NameSourceVersion
<a name="module_cicd"></a> cicdcloudposse/cicd/aws0.19.5
<a name="module_ecr"></a> ecrcloudposse/ecr/aws0.34.0
<a name="module_efs"></a> efscloudposse/efs/aws0.32.7
<a name="module_efs_backup"></a> efs_backupcloudposse/backup/aws0.14.0
<a name="module_elastic_beanstalk_application"></a> elastic_beanstalk_applicationcloudposse/elastic-beanstalk-application/aws0.11.1
<a name="module_elastic_beanstalk_environment"></a> elastic_beanstalk_environmentcloudposse/elastic-beanstalk-environment/aws0.46.0
<a name="module_label_slaves"></a> label_slavescloudposse/label/null0.25.0
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
aws_iam_policy.slavesresource
aws_iam_role_policy_attachment.slavesresource
aws_security_group.slavesresource
aws_iam_policy_document.slavesdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_application_subnets"></a> application_subnetsList of subnets to place EC2 instances and EFSlist(string)n/ayes
<a name="input_associated_security_group_ids"></a> associated_security_group_idsList of security groups to be allowed to connect to Jenkins master EC2 instanceslist(string)[]no
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the delimiter<br>and treated as a single ID element.list(string)[]no
<a name="input_availability_zone_selector"></a> availability_zone_selectorAvailability Zone selectorstring"Any"no
<a name="input_availability_zones"></a> availability_zonesList of Availability Zones for EFSlist(string)n/ayes
<a name="input_aws_account_id"></a> aws_account_idAWS 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.htmlstringn/ayes
<a name="input_build_compute_type"></a> build_compute_typeCodeBuild compute type, e.g. 'BUILD_GENERAL1_SMALL'. For more info: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.htmlstring"BUILD_GENERAL1_SMALL"no
<a name="input_build_image"></a> build_imageCodeBuild 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.htmlstring"aws/codebuild/docker:1.12.1"no
<a name="input_cicd_bucket_force_destroy"></a> cicd_bucket_force_destroyForce destroy the CI/CD S3 bucket even if it's not emptyboolfalseno
<a name="input_context"></a> contextSingle object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as null to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre>no
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_description"></a> descriptionWill be used as Elastic Beanstalk application descriptionstring"Jenkins server as Docker container running on Elastic Benastalk"no
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>{<br> format = string<br> labels = list(string)<br>}<br>(Type is any so the map values can later be enhanced to provide additional options.)<br>format is a Terraform format string to be passed to the format() function.<br>labels is a list of labels, in order, to pass to format() function.<br>Label values will be normalized before being passed to format() so they will be<br>identical to how they appear in id.<br>Default is {} (descriptors output will be empty).any{}no
<a name="input_dns_zone_id"></a> dns_zone_idRoute53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the EB environment and EFSstringn/ayes
<a name="input_efs_backup_cold_storage_after"></a> efs_backup_cold_storage_afterSpecifies the number of days after creation that a recovery point is moved to cold storagenumbernullno
<a name="input_efs_backup_completion_window"></a> efs_backup_completion_windowThe 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_windownumbernullno
<a name="input_efs_backup_delete_after"></a> efs_backup_delete_afterSpecifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_afternumbernullno
<a name="input_efs_backup_schedule"></a> efs_backup_scheduleA CRON expression specifying when AWS Backup initiates a backup jobstringnullno
<a name="input_efs_backup_start_window"></a> efs_backup_start_windowThe amount of time in minutes before beginning a backup. Minimum value is 60 minutesnumbernullno
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_env_vars"></a> env_varsMap 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){}no
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_environment_type"></a> environment_typeEnvironment 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
<a name="input_github_branch"></a> github_branchGitHub repository branch, e.g. 'master'. By default, this module will deploy 'https://github.com/cloudposse/jenkins' master branchstring"master"no
<a name="input_github_oauth_token"></a> github_oauth_tokenGitHub Oauth Tokenstringn/ayes
<a name="input_github_organization"></a> github_organizationGitHub organization, e.g. 'cloudposse'. By default, this module will deploy 'https://github.com/cloudposse/jenkins' repositorystring"cloudposse"no
<a name="input_github_repo_name"></a> github_repo_nameGitHub repository name, e.g. 'jenkins'. By default, this module will deploy 'https://github.com/cloudposse/jenkins' repositorystring"jenkins"no
<a name="input_healthcheck_url"></a> healthcheck_urlApplication Health Check URL. Elastic Beanstalk will call this URL to check the health of the application running on EC2 instancesstring"/login"no
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br>Set to 0 for unlimited length.<br>Set to null for keep the existing setting, which defaults to 0.<br>Does not affect id_full.numbernullno
<a name="input_image_tag"></a> image_tagDocker 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.htmlstring"latest"no
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the tags input.<br>Possible values: lower, title, upper.<br>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the tags input.<br>Possible values: lower, title, upper and none (no transformation).<br>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the tags output.<br>Set to [] to suppress all generated tags.<br>Notes:<br> The value of the name tag, if included, will be the id, not the name.<br> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br> "default"<br>]</pre>no
<a name="input_loadbalancer_certificate_arn"></a> loadbalancer_certificate_arnLoad Balancer SSL certificate ARN. The certificate must be present in AWS Certificate Managerstring""no
<a name="input_loadbalancer_logs_bucket_force_destroy"></a> loadbalancer_logs_bucket_force_destroyForce destroy the S3 bucket for load balancer logs even if it's not emptyboolfalseno
<a name="input_loadbalancer_ssl_policy"></a> loadbalancer_ssl_policySpecify a security policy to apply to the listener. This option is only applicable to environments with an application load balancerstring""no
<a name="input_loadbalancer_subnets"></a> loadbalancer_subnetsList of subnets to place Elastic Load Balancerlist(string)n/ayes
<a name="input_loadbalancer_type"></a> loadbalancer_typeLoad Balancer type, e.g. 'application' or 'classic'string"application"no
<a name="input_master_instance_type"></a> master_instance_typeEC2 instance type for Jenkins master, e.g. 't2.medium'string"t2.medium"no
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a tag.<br>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_region"></a> regionAWS region in which to provision the AWS resourcesstringn/ayes
<a name="input_rolling_update_type"></a> rolling_update_typeHealth, 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-autoscalingupdatepolicyrollingupdatestring"Health"no
<a name="input_solution_stack_name"></a> solution_stack_nameElastic Beanstalk stack, e.g. Docker, Go, Node, Java, IIS. For more info: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.htmlstring"64bit Amazon Linux 2018.03 v2.12.17 running Docker 18.06.1-ce"no
<a name="input_ssh_key_pair"></a> ssh_key_pairName of SSH key that will be deployed on Elastic Beanstalk instances. The key should be present in AWSstring""no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_use_efs_ip_address"></a> use_efs_ip_addressIf set to true, will provide the EFS IP address instead of DNS name to Jenkins as ENV varboolfalseno
<a name="input_vpc_id"></a> vpc_idID of the VPC in which to provision the AWS resourcesstringn/ayes

Outputs

NameDescription
<a name="output_codebuild_badge_url"></a> codebuild_badge_urlThe URL of the build badge when badge_enabled is enabled
<a name="output_codebuild_cache_bucket_arn"></a> codebuild_cache_bucket_arnCodeBuild cache S3 bucket ARN
<a name="output_codebuild_cache_bucket_name"></a> codebuild_cache_bucket_nameCodeBuild cache S3 bucket name
<a name="output_codebuild_project_id"></a> codebuild_project_idCodeBuild project ID
<a name="output_codebuild_project_name"></a> codebuild_project_nameCodeBuild project name
<a name="output_codebuild_role_arn"></a> codebuild_role_arnCodeBuild IAM Role ARN
<a name="output_codebuild_role_id"></a> codebuild_role_idCodeBuild IAM Role ID
<a name="output_codepipeline_arn"></a> codepipeline_arnCodePipeline ARN
<a name="output_codepipeline_id"></a> codepipeline_idCodePipeline ID
<a name="output_ecr_registry_id"></a> ecr_registry_idRegistry ID
<a name="output_ecr_repository_name"></a> ecr_repository_nameRepository name
<a name="output_ecr_repository_url"></a> ecr_repository_urlRepository URL
<a name="output_efs_arn"></a> efs_arnEFS ARN
<a name="output_efs_backup_plan_arn"></a> efs_backup_plan_arnBackup Plan ARN
<a name="output_efs_backup_plan_version"></a> efs_backup_plan_versionUnique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan
<a name="output_efs_backup_selection_id"></a> efs_backup_selection_idBackup Selection ID
<a name="output_efs_backup_vault_arn"></a> efs_backup_vault_arnBackup Vault ARN
<a name="output_efs_backup_vault_id"></a> efs_backup_vault_idBackup Vault ID
<a name="output_efs_dns_name"></a> efs_dns_nameEFS DNS name
<a name="output_efs_host"></a> efs_hostRoute53 DNS hostname for the EFS
<a name="output_efs_id"></a> efs_idEFS ID
<a name="output_efs_mount_target_dns_names"></a> efs_mount_target_dns_namesList of EFS mount target DNS names
<a name="output_efs_mount_target_ids"></a> efs_mount_target_idsList of EFS mount target IDs (one per Availability Zone)
<a name="output_efs_mount_target_ips"></a> efs_mount_target_ipsList of EFS mount target IPs (one per Availability Zone)
<a name="output_efs_network_interface_ids"></a> efs_network_interface_idsList of mount target network interface IDs
<a name="output_elastic_beanstalk_application_name"></a> elastic_beanstalk_application_nameElastic Beanstalk Application name
<a name="output_elastic_beanstalk_environment_all_settings"></a> elastic_beanstalk_environment_all_settingsList of all option settings configured in the environment. These are a combination of default settings and their overrides from setting in the configuration
<a name="output_elastic_beanstalk_environment_application"></a> elastic_beanstalk_environment_applicationThe Elastic Beanstalk Application specified for this environment
<a name="output_elastic_beanstalk_environment_autoscaling_groups"></a> elastic_beanstalk_environment_autoscaling_groupsThe autoscaling groups used by this environment
<a name="output_elastic_beanstalk_environment_ec2_instance_profile_role_name"></a> elastic_beanstalk_environment_ec2_instance_profile_role_nameInstance IAM role name
<a name="output_elastic_beanstalk_environment_elb_zone_id"></a> elastic_beanstalk_environment_elb_zone_idELB zone id
<a name="output_elastic_beanstalk_environment_endpoint"></a> elastic_beanstalk_environment_endpointFully qualified DNS name for the environment
<a name="output_elastic_beanstalk_environment_hostname"></a> elastic_beanstalk_environment_hostnameDNS hostname
<a name="output_elastic_beanstalk_environment_id"></a> elastic_beanstalk_environment_idID of the Elastic Beanstalk environment
<a name="output_elastic_beanstalk_environment_instances"></a> elastic_beanstalk_environment_instancesInstances used by this environment
<a name="output_elastic_beanstalk_environment_launch_configurations"></a> elastic_beanstalk_environment_launch_configurationsLaunch configurations in use by this environment
<a name="output_elastic_beanstalk_environment_load_balancers"></a> elastic_beanstalk_environment_load_balancersElastic Load Balancers in use by this environment
<a name="output_elastic_beanstalk_environment_name"></a> elastic_beanstalk_environment_nameName
<a name="output_elastic_beanstalk_environment_queues"></a> elastic_beanstalk_environment_queuesSQS queues in use by this environment
<a name="output_elastic_beanstalk_environment_security_group_id"></a> elastic_beanstalk_environment_security_group_idSecurity group id
<a name="output_elastic_beanstalk_environment_setting"></a> elastic_beanstalk_environment_settingSettings specifically set for this environment
<a name="output_elastic_beanstalk_environment_tier"></a> elastic_beanstalk_environment_tierThe environment tier
<a name="output_elastic_beanstalk_environment_triggers"></a> elastic_beanstalk_environment_triggersAutoscaling triggers in use by this environment
<!-- markdownlint-restore -->

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? We got answers.

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

README Commercial Support

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.

Learn More

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.

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.

Newsletter

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!

zoom

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-2023 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

<!-- markdownlint-disable -->
Erik Osterman<br/>Erik OstermanAndriy Knysh<br/>Andriy KnyshIgor Rodionov<br/>Igor RodionovIvan Pinatti<br/>Ivan PinattiSergey Vasilyev<br/>Sergey VasilyevRB<br/>RB
<!-- markdownlint-restore -->

README Footer Beacon

<!-- markdownlint-disable --> <!-- markdownlint-restore -->