Add output descriptions for outputs used in Server 4.x Helm values (#167

) * docs: update output descriptions for GCP re: Helm values * feat: add description to TF outputs
CircleCI-Public · May 10, 2023 · 2798ae6 · 2798ae6
1 parent b889e55
commit 2798ae6
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 14 deletions.
diff --git a/nomad-aws/README.md b/nomad-aws/README.md
@@ -95,10 +95,10 @@ There are more examples in the [examples](./examples/) directory.
 
 | Name | Description |
 |------|-------------|
-| mtls\_enabled | n/a |
+| mtls\_enabled | set this value for the `nomad.server.rpc.mTLS.enabled` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
 | nomad\_server\_cert | n/a |
 | nomad\_server\_key | n/a |
 | nomad\_tls\_ca | n/a |
-| nomad\_server\_cert\_base64 | n/a |
-| nomad\_server\_key\_base64 | n/a |
-| nomad\_tls\_ca\_base64 | n/a |
+| nomad\_server\_cert\_base64 | set this value for the `nomad.server.rpc.mTLS.certificate` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
+| nomad\_server\_key\_base64 | set this value for the `nomad.server.rpc.mTLS.privateKey` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
+| nomad\_tls\_ca\_base64 | set this value for the `nomad.server.rpc.mTLS.CACertificate` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
diff --git a/nomad-aws/output.tf b/nomad-aws/output.tf
@@ -1,5 +1,6 @@
 output "mtls_enabled" {
-  value = var.enable_mtls
+  description = "set this value for the `nomad.server.rpc.mTLS.enabled` key in the CircleCI Server's Helm values.yaml"
+  value       = var.enable_mtls
 }
 
 output "nomad_server_cert" {
@@ -15,15 +16,18 @@ output "nomad_tls_ca" {
 }
 
 output "nomad_server_cert_base64" {
-  value = var.enable_mtls ? base64encode(module.nomad_tls[0].nomad_server_cert) : ""
+  description = "set this value for the `nomad.server.rpc.mTLS.certificate` key in the CircleCI Server's Helm values.yaml"
+  value       = var.enable_mtls ? base64encode(module.nomad_tls[0].nomad_server_cert) : ""
 }
 
 output "nomad_server_key_base64" {
-  value = var.enable_mtls ? nonsensitive(base64encode(module.nomad_tls[0].nomad_server_key)) : ""
+  description = "set this value for the `nomad.server.rpc.mTLS.privateKey` key in the CircleCI Server's Helm values.yaml"
+  value       = var.enable_mtls ? nonsensitive(base64encode(module.nomad_tls[0].nomad_server_key)) : ""
 }
 
 output "nomad_tls_ca_base64" {
-  value = var.enable_mtls ? base64encode(module.nomad_tls[0].nomad_tls_ca) : ""
+  description = "set this value for the `nomad.server.rpc.mTLS.CACertificate` key in the CircleCI Server's Helm values.yaml"
+  value       = var.enable_mtls ? base64encode(module.nomad_tls[0].nomad_tls_ca) : ""
 }
 
 output "nomad_sg_id" {

diff --git a/nomad-gcp/README.md b/nomad-gcp/README.md
@@ -97,6 +97,6 @@ There are more examples in the [examples](./examples/) directory.
 | nomad\_server\_cert | n/a |
 | nomad\_server\_key | n/a |
 | nomad\_tls\_ca | n/a |
-| nomad\_server\_cert\_base64 | n/a |
-| nomad\_server\_key\_base64 | n/a |
-| nomad\_tls\_ca\_base64 | n/a |
+| nomad\_server\_cert\_base64 | set this value for the `nomad.server.rpc.mTLS.certificate` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
+| nomad\_server\_key\_base64 | set this value for the `nomad.server.rpc.mTLS.privateKey` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
+| nomad\_tls\_ca\_base64 | set this value for the `nomad.server.rpc.mTLS.CACertificate` key in the [CircleCI Server's Helm values.yaml](https://circleci.com/docs/server/installation/installation-reference/#all-values-yaml-options) |
diff --git a/nomad-gcp/output.tf b/nomad-gcp/output.tf
@@ -11,15 +11,18 @@ output "nomad_tls_ca" {
 }
 
 output "nomad_server_cert_base64" {
-  value = var.unsafe_disable_mtls ? "" : base64encode(module.tls[0].nomad_server_cert)
+  description = "set this value for the `nomad.server.rpc.mTLS.certificate` key in the CircleCI Server's Helm values.yaml"
+  value       = var.unsafe_disable_mtls ? "" : base64encode(module.tls[0].nomad_server_cert)
 }
 
 output "nomad_server_key_base64" {
-  value = var.unsafe_disable_mtls ? "" : nonsensitive(base64encode(module.tls[0].nomad_server_key))
+  description = "set this value for the `nomad.server.rpc.mTLS.privateKey` key in the CircleCI Server's Helm values.yaml"
+  value       = var.unsafe_disable_mtls ? "" : nonsensitive(base64encode(module.tls[0].nomad_server_key))
 }
 
 output "nomad_tls_ca_base64" {
-  value = var.unsafe_disable_mtls ? "" : base64encode(module.tls[0].nomad_tls_ca)
+  description = "set this value for the `nomad.server.rpc.mTLS.CACertificate` key in the CircleCI Server's Helm values.yaml"
+  value       = var.unsafe_disable_mtls ? "" : base64encode(module.tls[0].nomad_tls_ca)
 }
 
 output "managed_instance_group_name" {