-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Terraform TLS SSH key pair to SSM initial implementation (#2)
* Initial implementation * Add readme * Enable both RSA + ECDSA keys to be written to SSM This commit adds some default variables and locals for naming of SSM params. We expect SSM params to be written in the form `/foo/bar` or `/foo/bar_badger` where foo is var.ssm_path_prefix and bar is passed in explicitly, or else we default to label.id where we replace the delimiter with underscores to maintain consistency. Both RSA + ECDSA key algo’s are supported. * Add full example
- Loading branch information
Showing
15 changed files
with
680 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Local .terraform directories | ||
**/.terraform/* | ||
|
||
# .tfstate files | ||
*.tfstate | ||
*.tfstate.* | ||
|
||
**/.idea | ||
**/*.iml | ||
|
||
**/.build-harness | ||
**/build-harness |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
addons: | ||
apt: | ||
packages: | ||
- git | ||
- make | ||
- curl | ||
|
||
install: | ||
- make init | ||
|
||
script: | ||
- make terraform/install | ||
- make terraform/get-plugins | ||
- make terraform/get-modules | ||
- make terraform/lint | ||
- make terraform/validate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,275 @@ | ||
# terraform-aws-ssm-tls-ssh-key-pair | ||
Terraform module that provisions an SSH TLS Key pair and writes it to SSM Parameter Store | ||
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> | ||
[![README Header][readme_header_img]][readme_header_link] | ||
|
||
[![Cloud Posse][logo]](https://cpco.io/homepage) | ||
|
||
# terraform-aws-ssm-tls-ssh-key-pair [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-ssm-tls-ssh-key-pair.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-ssm-tls-ssh-key-pair) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-ssm-tls-ssh-key-pair.svg)](https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) | ||
|
||
|
||
Terraform module that provisions an SSH TLS key pair and writes it to SSM Parameter Store. | ||
|
||
|
||
--- | ||
|
||
This project is part of our comprehensive ["SweetOps"](https://cpco.io/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"/>][share_email] | ||
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus] | ||
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook] | ||
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit] | ||
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin] | ||
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter] | ||
|
||
|
||
[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules] | ||
|
||
|
||
|
||
It's 100% Open Source and licensed under the [APACHE2](LICENSE). | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out! | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## Usage | ||
|
||
```hcl | ||
module "ssm_tls_ssh_key_pair" { | ||
source = "git::https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair.git?ref=master" | ||
namespace = "eg" | ||
stage = "prod" | ||
name = "app" | ||
ssm_path_prefix = "ssh_keys" | ||
ssh_key_algorithm = "ECDSA" | ||
} | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
|
||
## 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 | | ||
|------|-------------|:----:|:-----:|:-----:| | ||
| attributes | Additional attributes (e.g. `1`) | list | `<list>` | no | | ||
| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | | ||
| ecdsa_curve | When ssh_key_algorithm is 'ECDSA', the name of the elliptic curve to use. May be any one of 'P256', 'P384' or P521' | string | `P256` | no | | ||
| enable_kms_key_rotation | Whether KMS key rotation is enabled | string | `true` | no | | ||
| enabled | Whether to create the resources. Set to `false` to prevent the module from creating any resources | string | `true` | no | | ||
| name | Application or solution name (e.g. `app`) | string | - | yes | | ||
| namespace | Namespace (e.g. `eg` or `cp`) | string | - | yes | | ||
| overwrite_ssm_parameter | Whether to overwrite an existing SSM parameter | string | `true` | no | | ||
| rsa_bits | When ssh_key_algorithm is 'RSA', the size of the generated RSA key in bits | string | `4096` | no | | ||
| ssh_key_algorithm | SSH key algorithm to use. Currently-supported values are 'RSA' and 'ECDSA' | string | `RSA` | no | | ||
| ssh_private_key_name | SSM Parameter name of the SSH private key | string | `` | no | | ||
| ssh_public_key_name | SSM Parameter name of the SSH public key | string | `` | no | | ||
| ssm_path_prefix | The SSM parameter path prefix (e.g. /$ssm_path_prefix/$key_name) | string | `ssh_keys` | no | | ||
| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | | ||
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `<map>` | no | | ||
|
||
## Outputs | ||
|
||
| Name | Description | | ||
|------|-------------| | ||
| public_key | Contents of the generated public key | | ||
|
||
|
||
|
||
|
||
## Share the Love | ||
|
||
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair)! (it helps us **a lot**) | ||
|
||
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =) | ||
|
||
|
||
## Related Projects | ||
|
||
Check out these related projects. | ||
|
||
- [terraform-aws-key-pair](https://github.com/cloudposse/terraform-aws-key-pair) - Terraform Module to Automatically Generate SSH key Pairs (Public/Private Keys) | ||
- [terraform-tls-ssh-key-pair](https://github.com/cloudposse/terraform-tls-ssh-key-pair) - Terraform module for generating an SSH public key file | ||
|
||
|
||
|
||
## Help | ||
|
||
**Got a question?** | ||
|
||
File a GitHub [issue](https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair/issues), send us an [email][email] or join our [Slack Community][slack]. | ||
|
||
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link] | ||
|
||
## Commercial Support | ||
|
||
Work directly with our team of DevOps experts via email, slack, and video conferencing. | ||
|
||
We provide [*commercial support*][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 full-time engineer. | ||
|
||
[![E-Mail](https://img.shields.io/badge/[email protected])][email] | ||
|
||
- **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][module_development] 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][module_development] today and we'll get back to you ASAP. | ||
|
||
|
||
## Slack Community | ||
|
||
Join our [Open Source Community][slack] 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][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](https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair/issues) 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](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][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](https://cpco.io/copyright) | ||
|
||
|
||
|
||
## 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. | ||
|
||
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][website]. Like it? Please let us know by [leaving a testimonial][testimonial]! | ||
|
||
[![Cloud Posse][logo]][website] | ||
|
||
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source]. | ||
|
||
We offer [paid support][commercial_support] on all of our projects. | ||
|
||
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. | ||
|
||
|
||
|
||
### Contributors | ||
|
||
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Josh Myers][joshmyers_avatar]][joshmyers_homepage]<br/>[Josh Myers][joshmyers_homepage] | | ||
|---|---| | ||
|
||
[osterman_homepage]: https://github.com/osterman | ||
[osterman_avatar]: https://github.com/osterman.png?size=150 | ||
[joshmyers_homepage]: https://github.com/joshmyers | ||
[joshmyers_avatar]: https://github.com/joshmyers.png?size=150 | ||
|
||
|
||
|
||
[![README Footer][readme_footer_img]][readme_footer_link] | ||
[![Beacon][beacon]][website] | ||
|
||
[logo]: https://cloudposse.com/logo-300x69.svg | ||
[docs]: https://cpco.io/docs | ||
[website]: https://cpco.io/homepage | ||
[github]: https://cpco.io/github | ||
[jobs]: https://cpco.io/jobs | ||
[hire]: https://cpco.io/hire | ||
[slack]: https://cpco.io/slack | ||
[linkedin]: https://cpco.io/linkedin | ||
[twitter]: https://cpco.io/twitter | ||
[testimonial]: https://cpco.io/leave-testimonial | ||
[newsletter]: https://cpco.io/newsletter | ||
[email]: https://cpco.io/email | ||
[commercial_support]: https://cpco.io/commercial-support | ||
[we_love_open_source]: https://cpco.io/we-love-open-source | ||
[module_development]: https://cpco.io/module-development | ||
[terraform_modules]: https://cpco.io/terraform-modules | ||
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[share_twitter]: https://twitter.com/intent/tweet/?text=terraform-aws-ssm-tls-ssh-key-pair&url=https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-aws-ssm-tls-ssh-key-pair&url=https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[share_email]: mailto:?subject=terraform-aws-ssm-tls-ssh-key-pair&body=https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-ssm-tls-ssh-key-pair?pixel&cs=github&cm=readme&an=terraform-aws-ssm-tls-ssh-key-pair |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
# | ||
# This is the canonical configuration for the `README.md` | ||
# Run `make readme` to rebuild the `README.md` | ||
# | ||
|
||
# Name of this project | ||
name: terraform-aws-ssm-tls-ssh-key-pair | ||
|
||
# Logo for this project | ||
#logo: docs/logo.png | ||
|
||
# License of this project | ||
license: "APACHE2" | ||
|
||
# Canonical GitHub repo | ||
github_repo: cloudposse/terraform-aws-ssm-tls-ssh-key-pair | ||
|
||
# Badges to display | ||
badges: | ||
- name: "Build Status" | ||
image: "https://travis-ci.org/cloudposse/terraform-aws-ssm-tls-ssh-key-pair.svg?branch=master" | ||
url: "https://travis-ci.org/cloudposse/terraform-aws-ssm-tls-ssh-key-pair" | ||
- name: "Latest Release" | ||
image: "https://img.shields.io/github/release/cloudposse/terraform-aws-ssm-tls-ssh-key-pair.svg" | ||
url: "https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair/releases/latest" | ||
- name: "Slack Community" | ||
image: "https://slack.cloudposse.com/badge.svg" | ||
url: "https://slack.cloudposse.com" | ||
|
||
related: | ||
- name: "terraform-aws-key-pair" | ||
description: "Terraform Module to Automatically Generate SSH key Pairs (Public/Private Keys)" | ||
url: "https://github.com/cloudposse/terraform-aws-key-pair" | ||
- name: "terraform-tls-ssh-key-pair" | ||
description: "Terraform module for generating an SSH public key file" | ||
url: "https://github.com/cloudposse/terraform-tls-ssh-key-pair" | ||
|
||
# Short description of this project | ||
description: |- | ||
Terraform module that provisions an SSH TLS key pair and writes it to SSM Parameter Store. | ||
# How to use this project | ||
usage: |- | ||
```hcl | ||
module "ssm_tls_ssh_key_pair" { | ||
source = "git::https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair.git?ref=master" | ||
namespace = "eg" | ||
stage = "prod" | ||
name = "app" | ||
ssm_path_prefix = "ssh_keys" | ||
ssh_key_algorithm = "ECDSA" | ||
} | ||
``` | ||
include: | ||
- "docs/targets.md" | ||
- "docs/terraform.md" | ||
|
||
# Contributors to this project | ||
contributors: | ||
- name: "Erik Osterman" | ||
github: "osterman" | ||
- name: "Josh Myers" | ||
github: "joshmyers" |
Oops, something went wrong.