|
42 | 42 |
|
43 | 43 | [![Cloud Posse][logo]](https://cpco.io/homepage)
|
44 | 44 |
|
45 |
| -# terraform-aws-ssm-tls-ssh-key-pair [](https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d1ba83195dc307c009861ce) [](https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair/releases/latest) [](https://slack.cloudposse.com) |
| 45 | +# terraform-aws-ssm-tls-ssh-key-pair [](https://github.com/cloudposse/terraform-aws-ssm-tls-ssh-key-pair/releases/latest) [](https://slack.cloudposse.com) |
46 | 46 |
|
47 | 47 |
|
48 | 48 | Terraform module that provisions an SSH TLS key pair and writes it to SSM Parameter Store.
|
@@ -114,35 +114,52 @@ Available targets:
|
114 | 114 | lint Lint terraform code
|
115 | 115 |
|
116 | 116 | ```
|
| 117 | +## Requirements |
| 118 | + |
| 119 | +| Name | Version | |
| 120 | +|------|---------| |
| 121 | +| terraform | ~> 0.12.0 | |
| 122 | +| aws | ~> 2.0 | |
| 123 | +| local | ~> 1.3 | |
| 124 | +| null | ~> 2.1 | |
| 125 | +| tls | ~> 2.0 | |
| 126 | + |
| 127 | +## Providers |
| 128 | + |
| 129 | +| Name | Version | |
| 130 | +|------|---------| |
| 131 | +| aws | ~> 2.0 | |
| 132 | +| tls | ~> 2.0 | |
| 133 | + |
117 | 134 | ## Inputs
|
118 | 135 |
|
119 | 136 | | Name | Description | Type | Default | Required |
|
120 |
| -|------|-------------|:----:|:-----:|:-----:| |
121 |
| -| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no | |
122 |
| -| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | |
123 |
| -| 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 | |
124 |
| -| enabled | Whether to create the resources. Set to `false` to prevent the module from creating any resources | bool | `true` | no | |
125 |
| -| kms_key_id | KMS Key ID used for encryption | string | `` | no | |
126 |
| -| name | Application or solution name (e.g. `app`) | string | - | yes | |
127 |
| -| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no | |
128 |
| -| overwrite_ssm_parameter | Whether to overwrite an existing SSM parameter | bool | `true` | no | |
129 |
| -| rsa_bits | When ssh_key_algorithm is 'RSA', the size of the generated RSA key in bits | number | `4096` | no | |
130 |
| -| ssh_key_algorithm | SSH key algorithm to use. Currently-supported values are 'RSA' and 'ECDSA' | string | `RSA` | no | |
131 |
| -| ssh_private_key_name | SSM Parameter name of the SSH private key | string | `` | no | |
132 |
| -| ssh_public_key_name | SSM Parameter name of the SSH public key | string | `` | no | |
133 |
| -| ssm_path_format | SSM path format | string | `/%s/%s` | no | |
134 |
| -| ssm_path_prefix | The SSM parameter path prefix (e.g. /$ssm_path_prefix/$key_name) | string | `ssh_keys` | no | |
135 |
| -| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | `` | no | |
136 |
| -| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map(string) | `<map>` | no | |
| 137 | +|------|-------------|------|---------|:--------:| |
| 138 | +| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no | |
| 139 | +| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | `string` | `"-"` | no | |
| 140 | +| 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 | |
| 141 | +| enabled | Whether to create the resources. Set to `false` to prevent the module from creating any resources | `bool` | `true` | no | |
| 142 | +| kms\_key\_id | KMS Key ID used for encryption | `string` | `""` | no | |
| 143 | +| name | Application or solution name (e.g. `app`) | `string` | n/a | yes | |
| 144 | +| namespace | Namespace (e.g. `eg` or `cp`) | `string` | `""` | no | |
| 145 | +| overwrite\_ssm\_parameter | Whether to overwrite an existing SSM parameter | `bool` | `true` | no | |
| 146 | +| rsa\_bits | When ssh\_key\_algorithm is 'RSA', the size of the generated RSA key in bits | `number` | `4096` | no | |
| 147 | +| ssh\_key\_algorithm | SSH key algorithm to use. Currently-supported values are 'RSA' and 'ECDSA' | `string` | `"RSA"` | no | |
| 148 | +| ssh\_private\_key\_name | SSM Parameter name of the SSH private key | `string` | `""` | no | |
| 149 | +| ssh\_public\_key\_name | SSM Parameter name of the SSH public key | `string` | `""` | no | |
| 150 | +| ssm\_path\_format | SSM path format | `string` | `"/%s/%s"` | no | |
| 151 | +| ssm\_path\_prefix | The SSM parameter path prefix (e.g. /$ssm\_path\_prefix/$key\_name) | `string` | `"ssh_keys"` | no | |
| 152 | +| stage | Stage (e.g. `prod`, `dev`, `staging`) | `string` | `""` | no | |
| 153 | +| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | `map(string)` | `{}` | no | |
137 | 154 |
|
138 | 155 | ## Outputs
|
139 | 156 |
|
140 | 157 | | Name | Description |
|
141 | 158 | |------|-------------|
|
142 |
| -| key_name | Name of SSH key | |
143 |
| -| public_key | Content of the generated public key | |
144 |
| -| ssh_private_key_ssm_path | SSM path of the generated private key | |
145 |
| -| ssh_public_key_ssm_path | SSM path of the generated public key | |
| 159 | +| key\_name | Name of SSH key | |
| 160 | +| public\_key | Content of the generated public key | |
| 161 | +| ssh\_private\_key\_ssm\_path | SSM path of the generated private key | |
| 162 | +| ssh\_public\_key\_ssm\_path | SSM path of the generated public key | |
146 | 163 |
|
147 | 164 |
|
148 | 165 |
|
@@ -197,6 +214,10 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
|
197 | 214 |
|
198 | 215 | 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.
|
199 | 216 |
|
| 217 | +## Discourse Forums |
| 218 | + |
| 219 | +Participate in our [Discourse Forums][discourse]. 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. |
| 220 | + |
200 | 221 | ## Newsletter
|
201 | 222 |
|
202 | 223 | Sign up 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.
|
@@ -312,6 +333,7 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
|
312 | 333 | [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=testimonial
|
313 | 334 | [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=office_hours
|
314 | 335 | [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=newsletter
|
| 336 | + [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=discourse |
315 | 337 | [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=email
|
316 | 338 | [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=commercial_support
|
317 | 339 | [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-tls-ssh-key-pair&utm_content=we_love_open_source
|
|
0 commit comments