terraform-aws-kops-state-backend

Terraform module to provision dependencies for kops (config S3 bucket & DNS zone).

The module supports the following:

Forced server-side encryption at rest for the S3 bucket
S3 bucket versioning to allow for kops state recovery in the case of accidental deletions or human errors
Block public access in bucket level by default

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!

Screenshots

Example of outputs from the module after running terraform apply

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.

This example will create a DNS zone called us-east-1.cloudxl.net and delegate it from the parent zone cloudxl.net by setting NS and SOA records in the parent zone.

It will also create an S3 bucket with the name cp-prod-kops-state for storing kops state.

module "kops" {
  source           = "git::https://github.com/cloudposse/terraform-aws-kops-state-backend.git?ref=master"
  namespace        = "eg"
  stage            = "prod"
  name             = "kops-state"
  cluster_name     = "us-east-1"
  parent_zone_name = "domain.com"
  zone_name        = "$${name}.$${parent_zone_name}"
  region           = "us-east-1"
}

To verify that the created kops DNS zone has been tagged correctly, run

aws route53 list-tags-for-resources --resource-type hostedzone --resource-ids Z27EGVGENRTTZZ

{
{
    "ResourceTagSets": [
        {
            "ResourceType": "hostedzone",
            "ResourceId": "Z27EGVGENRTTZZ",
            "Tags": [
                {
                    "Key": "Cluster",
                    "Value": "us-east-1.domain.com"
                },
                {
                    "Key": "Stage",
                    "Value": "prod"
                },
                {
                    "Key": "Namespace",
                    "Value": "cp"
                },
                {
                    "Key": "Name",
                    "Value": "eg-prod-us-east-1"
                }
            ]
        }
    ]
}

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
acl	The canned ACL to apply to the S3 bucket	string	`private`	no
attributes	Additional attributes (e.g. `1`)	list	`<list>`	no
block_public_access_enabled	Block all public access from bucket level	string	`true`	no
cluster_name	Kops cluster name (e.g. `us-east-1` or `cluster-1`)	string	`us-east-1`	no
create_bucket	Set to `false` to use existing S3 bucket for kops state store instead of creating one.	string	`true`	no
delimiter	Delimiter to be used between `namespace`, `stage`, `name`, and `attributes`	string	`-`	no
domain_enabled	A boolean that determines whether a DNS Zone for the kops domain is created	string	`true`	no
force_destroy	A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without errors. These objects are not recoverable	string	`false`	no
name	Name (e.g. `kops-state`)	string	`kops-state`	no
namespace	Namespace (e.g. `eg` or `cp`)	string	-	yes
parent_zone_id	Parent DNS zone ID	string	``	no
parent_zone_name	Parent DNS zone name (e.g. `domain.com`)	string	``	no
region	AWS Region the S3 bucket should reside in	string	`us-east-1`	no
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	-	yes
tags	Additional tags (e.g. map(`BusinessUnit`,`XYZ`)	map	`<map>`	no
zone_name	Template for the DNS zone name	string	`$${name}.$${parent_zone_name}`	no

Outputs

Name	Description
bucket_arn	S3 bucket ARN
bucket_domain_name	S3 bucket domain name
bucket_id	S3 bucket ID
bucket_name	S3 bucket name
bucket_region	S3 bucket region
parent_zone_id	Parent zone ID
parent_zone_name	Parent zone name
zone_id	`kops` cluster zone ID
zone_name	`kops` cluster zone name

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-kops-metadata - Terraform module to lookup resources within a Kops cluster for easier integration with Terraform
terraform-aws-kops-ecr - Terraform module to provision an ECR repository and grant users and kubernetes nodes access to it.
terraform-aws-kops-external-dns - Terraform module to provision an IAM role for external-dns running in a Kops cluster, and attach an IAM policy to the role with permissions to modify Route53 record sets
terraform-aws-kops-vpc-peering - Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops
terraform-aws-kops-route53 - Terraform module to lookup the IAM role associated with kops masters, and attach an IAM policy to the role with permissions to modify Route53 record sets
terraform-aws-kops-vault-backend - Terraform module to provision an S3 bucket for HashiCorp Vault secrets storage, and an IAM role and policy with permissions for Kops nodes to access the bucket
terraform-aws-kops-chart-repo - Terraform module to provision an S3 bucket for Helm chart repository, and an IAM role and policy with permissions for Kops nodes to access the bucket

Help

Got a question?

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

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.

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.

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.

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.

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!

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	Andriy Knysh

Is this module deprecated ?

Hello we are trying to use this module as we still use KOPS and will like to create kops state backend using this module. we are currently using terraform

terraform -version
Terraform v0.12.24
+ provider.aws v2.57.0
+ provider.null v2.1.2
+ provider.template v2.1.2

and this is the error we are getting when we implement the module.

Error: Unsupported block type

  on .terraform/modules/kops-state-backend.domain/main.tf line 18, in data "template_file" "zone_name":
  18:   vars {

Blocks of type "vars" are not expected here. Did you mean to define argument
"vars"? If so, use the equals sign to assign it a value.


Error: Unsupported block type

  on .terraform/modules/kops-state-backend/terraform-aws-kops-state-backend-0.3.0/main.tf line 11, in data "template_file" "zone_name":
  11:   vars {

Blocks of type "vars" are not expected here. Did you mean to define argument
"vars"? If so, use the equals sign to assign it a value.

i think this module needs to be updated to terraform .12, also i see there is a higher version of 0.3.0 available but in the example it seems to be outdated

module "kops-state-backend" {
  source  = "cloudposse/kops-state-backend/aws"
  version = "0.1.7"
  # insert the 2 required variables here
}

solution

module "kops-state-backend" {
  source  = "cloudposse/kops-state-backend/aws"
  version = "0.3.0"
  # insert the 2 required variables here
}

if this module is deprecated and is no longer receiving updates is there a similar module which we can use that will do the same?

cloudposse-archives / terraform-aws-kops-state-backend Goto Github PK