From 6e16b661462ddd63613e01b2995c88c2b23a16cb Mon Sep 17 00:00:00 2001
From: Anthony Zawacki <anthony.c.zawacki@census.gov>
Date: Tue, 26 Sep 2023 17:09:11 -0400
Subject: [PATCH] Added input/output.

---
 README.md | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 124 insertions(+)

diff --git a/README.md b/README.md
index 14fde31..0877a54 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,127 @@ The module configures an eks cluster with additional components after the cluste
 
 When selecting which version of the cluster-autoscaler to install, use the one that is closest to the same version as the `cluster_version` or slightly higher.
 The cluster-autoscaler uses the kuberentes scheduling algorithm to appropriate scale the cluster, and if the autoscaler version sufficiently divirges from the kubernetes version, the autoscaler will scale the node groups incorrectly.
+
+## Input
+
+**cluster_name** `string`
+
+EKS cluster name name component used through out the EKS cluster describing its purpose (ex: dice-dev)
+
+
+**region** `string`
+
+AWS region
+
+
+**profile** `string`
+
+AWS config profile
+
+
+**vpc_id** `string`
+
+Specify the VPC id that is used by this cluster
+
+
+**subnets** `list(string)`
+
+Specify the subnets used by this cluster
+
+
+**security_group_all_worker_mgmt_id** `string`
+
+The security group representing all of the worker nodes in the cluster.
+
+**eks_managed_node_groups_autoscaling_group_names** `list(string)`
+
+List of the autoscaling group names created by EKS managed node groups
+
+
+**oidc_provider_arn** `string`
+
+The ARN of the OIDC Provider
+
+
+**tag_costallocation** `string`
+
+Tag CostAllocation (default)
+
+Default: `"csvd:infrastructure"`
+
+
+**tags** `map(string)`
+
+AWS Tags to apply to appropriate resources
+
+Default: `{}`
+
+
+**kubectl_image_tag** `string`
+
+The version of bitnami/kubectl image to use.
+
+Default: `"1.27.1"`
+
+
+**cluster_autoscaler_chart_version** `string`
+
+The helm chart of the cluster-autoscaler most closely matching the Kuberentes version.  Review output of `helm add repo autoscaler 'https://kubernetes.github.io/autoscaler'` (if the repo hasn't been added previously) and `helm search repo -l autoscaler/cluster-autoscaler
+
+Default: `"9.29.3"`
+
+
+**cluster_autoscaler_tag** `string`
+
+Image tag of cluster-autoscaler associated with the cluster_autoscaler_chart_version helm chart.  `helm show values --version [cluster_autoscaler_chart_version] autoscaler/cluster-autoscaler | grep tag:`
+
+Default: `"v1.27.2"`
+
+
+## Output
+
+**module_name**
+The name of this module.
+  value       = local._module_name
+}
+
+**module_version**
+The version of this module.
+  value       = local._module_version
+}
+
+**rwo_storage_class**
+
+Kubernetes storage class that supports read/write once.
+
+
+**rwx_storage_class**
+
+Kubernetes storage class that supports read/write many.
+
+
+**cluster_autoscaler_irsa_role**
+
+The arn/name/unique_id of the irsa role for the cluster autoscaler addon
+
+
+**kubectl_image_full_path**
+
+The full URI to access the kubectl image including the registry/repository:tag
+
+
+**kubectl_image_registry**
+
+The registry portion of the URI to access the kubectl image
+
+
+**kubectl_image_repository**
+
+The repository portion of the URI to access the kubectl image
+
+
+**kubectl_image_tag**
+
+The tag portion of the URI to access the kubectl image
+
+