Delay filename outputs until files exist (#42)

* Delay filename outputs until files exist. * retry * Executed 'terraform fmt' * Updated README.md * compatibility w/ `var.generate_ssh_key == false` Co-authored-by: actions-bot <58130806+actions-bot@users.noreply.github.com>
cloudposse · Jul 4, 2020 · f8e37b1 · f8e37b1
1 parent c0ffe4d
commit f8e37b1
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -114,32 +114,50 @@ Available targets:
   lint                                Lint terraform code
 
 ```
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | ~> 0.12.0 |
+| aws | ~> 2.0 |
+| local | ~> 1.3 |
+| null | ~> 2.1 |
+| tls | ~> 2.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | ~> 2.0 |
+| local | ~> 1.3 |
+| tls | ~> 2.0 |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no |
-| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no |
-| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
-| generate_ssh_key | If set to `true`, new SSH key pair will be created | bool | `false` | no |
-| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
-| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
-| private_key_extension | Private key extension | string | `` | no |
-| public_key_extension | Public key extension | string | `.pub` | no |
-| ssh_key_algorithm | SSH key algorithm | string | `RSA` | no |
-| ssh_public_key_path | Path to SSH public key directory (e.g. `/secrets`) | string | - | yes |
-| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no |
-| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
+|------|-------------|------|---------|:--------:|
+| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no |
+| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | `string` | `"-"` | no |
+| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `""` | no |
+| generate\_ssh\_key | If set to `true`, new SSH key pair will be created | `bool` | `false` | no |
+| name | Solution name, e.g. 'app' or 'jenkins' | `string` | `""` | no |
+| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `""` | no |
+| private\_key\_extension | Private key extension | `string` | `""` | no |
+| public\_key\_extension | Public key extension | `string` | `".pub"` | no |
+| ssh\_key\_algorithm | SSH key algorithm | `string` | `"RSA"` | no |
+| ssh\_public\_key\_path | Path to SSH public key directory (e.g. `/secrets`) | `string` | n/a | yes |
+| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `""` | no |
+| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| key_name | Name of SSH key |
-| private_key | Content of the generated private key |
-| private_key_filename | Private Key Filename |
-| public_key | Content of the generated public key |
-| public_key_filename | Public Key Filename |
+| key\_name | Name of SSH key |
+| private\_key | Content of the generated private key |
+| private\_key\_filename | Private Key Filename |
+| public\_key | Content of the generated public key |
+| public\_key\_filename | Public Key Filename |
 
 
 
@@ -195,6 +213,10 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
 
 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.
 
+## Discourse Forums
+
+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.
+
 ## Newsletter
 
 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. 
@@ -314,6 +336,7 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
   [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=testimonial
   [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=office_hours
   [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=newsletter
+  [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=discourse
   [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=email
   [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=commercial_support
   [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-key-pair&utm_content=we_love_open_source

diff --git a/docs/terraform.md b/docs/terraform.md
@@ -1,27 +1,45 @@
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | ~> 0.12.0 |
+| aws | ~> 2.0 |
+| local | ~> 1.3 |
+| null | ~> 2.1 |
+| tls | ~> 2.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | ~> 2.0 |
+| local | ~> 1.3 |
+| tls | ~> 2.0 |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no |
-| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no |
-| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
-| generate_ssh_key | If set to `true`, new SSH key pair will be created | bool | `false` | no |
-| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
-| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
-| private_key_extension | Private key extension | string | `` | no |
-| public_key_extension | Public key extension | string | `.pub` | no |
-| ssh_key_algorithm | SSH key algorithm | string | `RSA` | no |
-| ssh_public_key_path | Path to SSH public key directory (e.g. `/secrets`) | string | - | yes |
-| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no |
-| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
+|------|-------------|------|---------|:--------:|
+| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no |
+| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | `string` | `"-"` | no |
+| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `""` | no |
+| generate\_ssh\_key | If set to `true`, new SSH key pair will be created | `bool` | `false` | no |
+| name | Solution name, e.g. 'app' or 'jenkins' | `string` | `""` | no |
+| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `""` | no |
+| private\_key\_extension | Private key extension | `string` | `""` | no |
+| public\_key\_extension | Public key extension | `string` | `".pub"` | no |
+| ssh\_key\_algorithm | SSH key algorithm | `string` | `"RSA"` | no |
+| ssh\_public\_key\_path | Path to SSH public key directory (e.g. `/secrets`) | `string` | n/a | yes |
+| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `""` | no |
+| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| key_name | Name of SSH key |
-| private_key | Content of the generated private key |
-| private_key_filename | Private Key Filename |
-| public_key | Content of the generated public key |
-| public_key_filename | Public Key Filename |
+| key\_name | Name of SSH key |
+| private\_key | Content of the generated private key |
+| private\_key\_filename | Private Key Filename |
+| public\_key | Content of the generated public key |
+| public\_key\_filename | Public Key Filename |
 
diff --git a/outputs.tf b/outputs.tf
@@ -20,10 +20,14 @@ output "private_key" {
 
 output "public_key_filename" {
   description = "Public Key Filename"
-  value       = local.public_key_filename
+
+  # Prevent releasing filename to downstream consumers until file exists (aka not during plan):
+  value = length(join("", tls_private_key.default.*.public_key_openssh)) > 0 ? local.public_key_filename : local.public_key_filename
 }
 
 output "private_key_filename" {
   description = "Private Key Filename"
-  value       = local.private_key_filename
+
+  # Prevent releasing filename to downstream consumers until file exists (aka not during plan):
+  value = length(join("", tls_private_key.default.*.public_key_openssh)) > 0 ? local.private_key_filename : local.private_key_filename
 }