add description for nfs module outputs

aneoconsulting · Feb 14, 2024 · 814380c · 814380c
1 parent 320e84a
commit 814380c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/storage/onpremise/nfs/README.md b/storage/onpremise/nfs/README.md
@@ -46,5 +46,5 @@ No modules.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_provisioner_name"></a> [provisioner\_name](#output\_provisioner\_name) | n/a |
-| <a name="output_pvc_name"></a> [pvc\_name](#output\_pvc\_name) | n/a |
+| <a name="output_provisioner_name"></a> [provisioner\_name](#output\_provisioner\_name) | name of the created provisionner |
+| <a name="output_pvc_name"></a> [pvc\_name](#output\_pvc\_name) | name of the created persistant volume claim |
diff --git a/storage/onpremise/nfs/outputs.tf b/storage/onpremise/nfs/outputs.tf
@@ -1,10 +1,12 @@
 # nfs
 
 output "provisioner_name" {
-  value = kubernetes_deployment.nfs_provisioner.metadata[0].name
+  description = "name of the created provisionner"
+  value       = kubernetes_deployment.nfs_provisioner.metadata[0].name
 }
 
 
 output "pvc_name" {
-  value = kubernetes_persistent_volume_claim.nfs_claim.metadata[0].name
+  description = "name of the created persistant volume claim"
+  value       = kubernetes_persistent_volume_claim.nfs_claim.metadata[0].name
 }