diff --git a/.gitignore b/.gitignore index 6a2a4e5..bf42b9f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,6 @@ .terraform/ .idea *.iml + +.build-harness +build-harness \ No newline at end of file diff --git a/Makefile b/Makefile index d002c7d..655f630 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,10 @@ SHELL := /bin/bash +# List of targets the `readme` target should call before generating the readme +export README_DEPS ?= docs/targets.md docs/terraform.md + -include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness) +## Lint terraform code lint: - $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate + $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate \ No newline at end of file diff --git a/README.md b/README.md index e3083c3..7cccda6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,31 @@ -# terraform-aws-kops-vault-backend [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-kops-vault-backend.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-kops-vault-backend) + + +[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) + +# terraform-aws-kops-vault-backend [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-kops-vault-backend.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-kops-vault-backend) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-kops-vault-backend.svg)](https://github.com/cloudposse/terraform-aws-kops-vault-backend/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) + Terraform module to provision an S3 bucket for [HashiCorp Vault](https://www.hashicorp.com/products/vault) secrets storage, and an IAM role and policy with permissions for Kops nodes to access the bucket. The module uses [terraform-aws-kops-metadata](https://github.com/cloudposse/terraform-aws-kops-metadata) to lookup resources within a Kops cluster for easier integration with Terraform. +--- + +This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. + + +It's 100% Open Source and licensed under the [APACHE2](LICENSE). + + + + + + + + + + ## Usage ```hcl @@ -23,41 +44,90 @@ module "kops_vault_backend" { ``` -## Variables -| Name | Default | Description | Required | -|:-------------------|:----------------|:---------------------------------------------------------------------------------|:--------:| -| `namespace` | `` | Namespace (_e.g._ `cp` or `cloudposse`) | Yes | -| `stage` | `` | Stage (_e.g._ `prod`, `dev`, `staging`) | Yes | -| `cluster_name` | `` | Cluster name (_e.g._ `us-east-1.cloudposse.com`) | Yes | -| `name` | `vault-backend` | Name (_e.g._ `vault-backend`) | No | -| `attributes` | `[]` | Additional attributes (_e.g._ `1`) | No | -| `tags` | `{}` | Additional tags (_e.g._ `map("Cluster","us-east-1.cloudposse.com")` | No | -| `delimiter` | `-` | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | No | -| `nodes_name` | `nodes` | Kops nodes subdomain name in the cluster DNS zone | No | + +## Makefile Targets +``` +Available targets: + + help This help screen + help/all Display help for all targets + lint Lint terraform code + +``` + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| attributes | Additional attributes (e.g. `1`) | list | `` | no | +| cluster_name | Kops cluster name (e.g. `us-east-1.cloudposse.com` or `cluster-1.cloudposse.com`) | string | - | yes | +| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | +| name | Name (e.g. `vault-backend`) | string | `vault-backend` | no | +| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | +| nodes_name | Kops nodes subdomain name in the cluster DNS zone | string | `nodes` | no | +| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | +| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `` | no | + ## Outputs -| Name | Description | -|:-----------------------|:--------------------------| -| `bucket_domain_name` | S3 bucket domain name | -| `bucket_id` | S3 bucket ID | -| `bucket_arn` | S3 bucket ARN | -| `role_name` | IAM role name | -| `role_unique_id` | IAM role unique ID | -| `role_arn` | IAM role ARN | -| `policy_name` | IAM policy name | -| `policy_id` | IAM policy ID | -| `policy_arn` | IAM policy ARN | +| Name | Description | +|------|-------------| +| bucket_arn | S3 bucket ARN | +| bucket_domain_name | S3 bucket domain name | +| bucket_id | S3 bucket ID | +| policy_arn | IAM policy ARN | +| policy_id | IAM policy ID | +| policy_name | IAM policy name | +| role_arn | IAM role ARN | +| role_name | IAM role name | +| role_unique_id | IAM role unique ID | + + + + +## Related Projects + +Check out these related projects. + +- [terraform-aws-kops-metadata](https://github.com/cloudposse/terraform-aws-kops-metadata) - Terraform module to lookup resources within a Kops cluster for easier integration with Terraform +- [terraform-aws-kops-ecr](https://github.com/cloudposse/terraform-aws-kops-ecr) - Terraform module to provision an ECR repository and grant users and kubernetes nodes access to it. +- [terraform-aws-kops-state-backend](https://github.com/cloudposse/terraform-aws-kops-state-backend) - Easily bootstrap kops clusters (DNS & S3 Bucket) +- [terraform-aws-kops-vpc-peering](https://github.com/cloudposse/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](https://github.com/cloudposse/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-external-dns](https://github.com/cloudposse/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-chart-repo](https://github.com/cloudposse/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](https://github.com/cloudposse/terraform-aws-kops-vault-backend/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Gitter](https://gitter.im/cloudposse/). +File a GitHub [issue](https://github.com/cloudposse/terraform-aws-kops-vault-backend/issues), send us an [email][email] or join our [Slack Community][slack]. + +## Commerical 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][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a fulltime engineer. + +[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com) + +- **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. + + +## Community Forum + +Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join 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 *sweet* infrastructure. ## Contributing @@ -67,7 +137,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-kops- ### Developing -If you are interested in being a contributor and want to get involved in developing `terraform-aws-kops-vault-backend`, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com). +If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com). In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. @@ -75,14 +145,20 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. 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 + 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! -**NOTE:** Be sure to merge the latest from "upstream" before making a pull request! +## Copyright -## License +Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com) -[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com) + + +## License + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) See [LICENSE](LICENSE) for full details. @@ -94,7 +170,7 @@ See [LICENSE](LICENSE) for full details. "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + 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 @@ -104,31 +180,46 @@ See [LICENSE](LICENSE) for full details. under the License. + + + + + + + +## Trademarks + +All other trademarks referenced herein are the property of their respective owners. + ## About -`terraform-aws-kops-vault-backend` is maintained and funded by [Cloud Posse, LLC][website]. +This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at + +[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) -![Cloud Posse](https://cloudposse.com/logo-300x69.png) +We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)! +We offer paid support on all of our projects. -Like it? Please let us know at +Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. -We love [Open Source Software](https://github.com/cloudposse/)! + [docs]: https://docs.cloudposse.com/ + [website]: https://cloudposse.com/ + [github]: https://github.com/cloudposse/ + [jobs]: https://cloudposse.com/jobs/ + [hire]: https://cloudposse.com/contact/ + [slack]: https://slack.cloudposse.com/ + [linkedin]: https://www.linkedin.com/company/cloudposse + [twitter]: https://twitter.com/cloudposse/ + [email]: mailto:hello@cloudposse.com -See [our other projects][community] -or [hire us][hire] to help build your next cloud platform. -[website]: https://cloudposse.com/ -[community]: https://github.com/cloudposse/ -[hire]: https://cloudposse.com/contact/ +### Contributors +| [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]
[Andriy Knysh][aknysh_homepage] | +|---| -## Contributors + [aknysh_homepage]: https://github.com/aknysh + [aknysh_avatar]: https://github.com/aknysh.png?size=150 -| [![Erik Osterman][erik_img]][erik_web]
[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]
[Andriy Knysh][andriy_web] | -|-------------------------------------------------------|------------------------------------------------------------------| -[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144 -[erik_web]: https://github.com/osterman/ -[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144 -[andriy_web]: https://github.com/aknysh/ diff --git a/README.yaml b/README.yaml new file mode 100644 index 0000000..7f220b2 --- /dev/null +++ b/README.yaml @@ -0,0 +1,84 @@ +--- +# +# This is the canonical configuration for the `README.md` +# Run `make readme` to rebuild the `README.md` +# + +# Name of this project +name: terraform-aws-kops-vault-backend + +# Logo for this project +#logo: docs/logo.png + +# License of this project +license: "APACHE2" + +# Canonical GitHub repo +github_repo: cloudposse/terraform-aws-kops-vault-backend + +# Badges to display +badges: + - name: "Build Status" + image: "https://travis-ci.org/cloudposse/terraform-aws-kops-vault-backend.svg?branch=master" + url: "https://travis-ci.org/cloudposse/terraform-aws-kops-vault-backend" + - name: "Latest Release" + image: "https://img.shields.io/github/release/cloudposse/terraform-aws-kops-vault-backend.svg" + url: "https://github.com/cloudposse/terraform-aws-kops-vault-backend/releases/latest" + - name: "Slack Community" + image: "https://slack.cloudposse.com/badge.svg" + url: "https://slack.cloudposse.com" + +related: + - name: "terraform-aws-kops-metadata" + description: "Terraform module to lookup resources within a Kops cluster for easier integration with Terraform" + url: "https://github.com/cloudposse/terraform-aws-kops-metadata" + - name: "terraform-aws-kops-ecr" + description: "Terraform module to provision an ECR repository and grant users and kubernetes nodes access to it." + url: "https://github.com/cloudposse/terraform-aws-kops-ecr" + - name: "terraform-aws-kops-state-backend" + description: "Easily bootstrap kops clusters (DNS & S3 Bucket)" + url: "https://github.com/cloudposse/terraform-aws-kops-state-backend" + - name: "terraform-aws-kops-vpc-peering" + description: "Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops" + url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering" + - name: "terraform-aws-kops-route53" + description: "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" + url: "https://github.com/cloudposse/terraform-aws-kops-route53" + - name: "terraform-aws-kops-external-dns" + description: "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" + url: "https://github.com/cloudposse/terraform-aws-kops-external-dns" + - name: "terraform-aws-kops-chart-repo" + description: "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" + url: "https://github.com/cloudposse/terraform-aws-kops-chart-repo" + +# Short description of this project +description: |- + Terraform module to provision an S3 bucket for [HashiCorp Vault](https://www.hashicorp.com/products/vault) secrets storage, and an IAM role and policy with permissions for Kops nodes to access the bucket. + + The module uses [terraform-aws-kops-metadata](https://github.com/cloudposse/terraform-aws-kops-metadata) to lookup resources within a Kops cluster for easier integration with Terraform. + +# How to use this project +usage: |- + ```hcl + module "kops_vault_backend" { + source = "git::https://github.com/cloudposse/terraform-aws-kops-vault-backend.git?ref=master" + namespace = "cp" + stage = "prod" + name = "vault-backend" + cluster_name = "us-east-1.cloudposse.com" + nodes_name = "nodes" + + tags = { + Cluster = "us-east-1.cloudposse.com" + } + } + ``` + +include: + - "docs/targets.md" + - "docs/terraform.md" + +# Contributors to this project +contributors: + - name: "Andriy Knysh" + github: "aknysh" \ No newline at end of file diff --git a/docs/targets.md b/docs/targets.md new file mode 100644 index 0000000..09c39cd --- /dev/null +++ b/docs/targets.md @@ -0,0 +1,9 @@ +## Makefile Targets +``` +Available targets: + + help This help screen + help/all Display help for all targets + lint Lint terraform code + +``` diff --git a/docs/terraform.md b/docs/terraform.md new file mode 100644 index 0000000..1a45860 --- /dev/null +++ b/docs/terraform.md @@ -0,0 +1,28 @@ + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| attributes | Additional attributes (e.g. `1`) | list | `` | no | +| cluster_name | Kops cluster name (e.g. `us-east-1.cloudposse.com` or `cluster-1.cloudposse.com`) | string | - | yes | +| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | +| name | Name (e.g. `vault-backend`) | string | `vault-backend` | no | +| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | +| nodes_name | Kops nodes subdomain name in the cluster DNS zone | string | `nodes` | no | +| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | +| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| bucket_arn | S3 bucket ARN | +| bucket_domain_name | S3 bucket domain name | +| bucket_id | S3 bucket ID | +| policy_arn | IAM policy ARN | +| policy_id | IAM policy ID | +| policy_name | IAM policy name | +| role_arn | IAM role ARN | +| role_name | IAM role name | +| role_unique_id | IAM role unique ID | + diff --git a/outputs.tf b/outputs.tf index 67501d4..19a2495 100644 --- a/outputs.tf +++ b/outputs.tf @@ -1,35 +1,44 @@ output "bucket_domain_name" { - value = "${aws_s3_bucket.default.bucket_domain_name}" + value = "${aws_s3_bucket.default.bucket_domain_name}" + description = "S3 bucket domain name" } output "bucket_id" { - value = "${aws_s3_bucket.default.id}" + value = "${aws_s3_bucket.default.id}" + description = "S3 bucket ID" } output "bucket_arn" { - value = "${aws_s3_bucket.default.arn}" + value = "${aws_s3_bucket.default.arn}" + description = "S3 bucket ARN" } output "role_name" { - value = "${aws_iam_role.default.name}" + value = "${aws_iam_role.default.name}" + description = "IAM role name" } output "role_unique_id" { - value = "${aws_iam_role.default.unique_id}" + value = "${aws_iam_role.default.unique_id}" + description = "IAM role unique ID" } output "role_arn" { - value = "${aws_iam_role.default.arn}" + value = "${aws_iam_role.default.arn}" + description = "IAM role ARN" } output "policy_name" { - value = "${aws_iam_policy.default.name}" + value = "${aws_iam_policy.default.name}" + description = "IAM policy name" } output "policy_id" { - value = "${aws_iam_policy.default.id}" + value = "${aws_iam_policy.default.id}" + description = "IAM policy ID" } output "policy_arn" { - value = "${aws_iam_policy.default.arn}" + value = "${aws_iam_policy.default.arn}" + description = "IAM policy ARN" }