From 0d8db82aa2501c891f103ef22239942d012a3ae1 Mon Sep 17 00:00:00 2001
From: jarpat <jay.patel@sas.com>
Date: Fri, 1 Dec 2023 11:18:15 -0500
Subject: [PATCH] add description for output.tf in ./modules

---
 modules/aws_autoscaling/outputs.tf |  3 ++-
 modules/aws_ebs_csi/outputs.tf     |  3 ++-
 modules/aws_vm/outputs.tf          | 15 ++++++++++-----
 modules/kubeconfig/outputs.tf      |  3 ++-
 4 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/modules/aws_autoscaling/outputs.tf b/modules/aws_autoscaling/outputs.tf
index 8e660c24..ffb6bae1 100644
--- a/modules/aws_autoscaling/outputs.tf
+++ b/modules/aws_autoscaling/outputs.tf
@@ -2,5 +2,6 @@
 # SPDX-License-Identifier: Apache-2.0
 
 output "autoscaler_account" {
-  value = module.iam_assumable_role_with_oidc.iam_role_arn
+  description = "ARN of IAM role for cluster-autoscaler."
+  value       = module.iam_assumable_role_with_oidc.iam_role_arn
 }
diff --git a/modules/aws_ebs_csi/outputs.tf b/modules/aws_ebs_csi/outputs.tf
index abfb8d6f..9f4dc9bb 100644
--- a/modules/aws_ebs_csi/outputs.tf
+++ b/modules/aws_ebs_csi/outputs.tf
@@ -2,5 +2,6 @@
 # SPDX-License-Identifier: Apache-2.0
 
 output "ebs_csi_account" {
-  value = module.iam_assumable_role_with_oidc.iam_role_arn
+  description = "ARN of IAM role for ebs-csi-controller Service Account."
+  value       = module.iam_assumable_role_with_oidc.iam_role_arn
 }
diff --git a/modules/aws_vm/outputs.tf b/modules/aws_vm/outputs.tf
index a46c716d..3c4ba98b 100644
--- a/modules/aws_vm/outputs.tf
+++ b/modules/aws_vm/outputs.tf
@@ -2,21 +2,26 @@
 # SPDX-License-Identifier: Apache-2.0
 
 output "private_ip_address" {
-  value = aws_instance.vm.private_ip
+  description = "Private IP address associated with the VM."
+  value       = aws_instance.vm.private_ip
 }
 
 output "public_ip_address" {
-  value = var.create_public_ip ? coalesce(aws_eip.eip[0].public_ip, aws_instance.vm.public_ip) : null
+  description = "Public IP address associated with the VM."
+  value       = var.create_public_ip ? coalesce(aws_eip.eip[0].public_ip, aws_instance.vm.public_ip) : null
 }
 
 output "admin_username" {
-  value = var.vm_admin
+  description = "Admin username for the VM"
+  value       = var.vm_admin
 }
 
 output "private_dns" {
-  value = aws_instance.vm.private_dns
+  description = "Private DNS name assigned to the VM."
+  value       = aws_instance.vm.private_dns
 }
 
 output "public_dns" {
-  value = var.create_public_ip ? coalesce(aws_eip.eip[0].public_dns, aws_instance.vm.public_dns) : null
+  description = "Public DNS name assigned to the VM."
+  value       = var.create_public_ip ? coalesce(aws_eip.eip[0].public_dns, aws_instance.vm.public_dns) : null
 }
diff --git a/modules/kubeconfig/outputs.tf b/modules/kubeconfig/outputs.tf
index 1aaeb6eb..6502f708 100644
--- a/modules/kubeconfig/outputs.tf
+++ b/modules/kubeconfig/outputs.tf
@@ -2,5 +2,6 @@
 # SPDX-License-Identifier: Apache-2.0
 
 output "kube_config" {
-  value = local_file.kubeconfig.content
+  description = "Kubernetes cluster authentication information for kubectl."
+  value       = local_file.kubeconfig.content
 }