From bbb5b3a5536b7748444a0585a82ac2138a1ce913 Mon Sep 17 00:00:00 2001
From: Arthi <43505226+arthivjkumar@users.noreply.github.com>
Date: Mon, 5 Aug 2024 03:21:44 -0400
Subject: [PATCH] Updated information on variables in read me (#342)

* Updated information on variables in read me

* Changes to readme in eka cluster examples
---
 examples/eks/eks_cluster_access_entries/README.MD     |  8 ++++++++
 examples/eks/eks_cluster_assumerole/README.MD         |  8 ++++++++
 .../eks/eks_cluster_autoscaler_policies/README.MD     |  7 +++++++
 examples/eks/eks_cluster_custom_iam/README.md         |  7 +++++++
 examples/eks/eks_cluster_existing/README.MD           | 11 +++++++++++
 examples/eks/eks_cluster_optional_readonly/README.MD  |  7 +++++++
 examples/eks/eks_cluster_readonly/README.MD           |  7 +++++++
 examples/eks/eks_clusters/README.MD                   |  7 +++++++
 8 files changed, 62 insertions(+)

diff --git a/examples/eks/eks_cluster_access_entries/README.MD b/examples/eks/eks_cluster_access_entries/README.MD
index ba36f213..7df193c1 100644
--- a/examples/eks/eks_cluster_access_entries/README.MD
+++ b/examples/eks/eks_cluster_access_entries/README.MD
@@ -12,6 +12,14 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_cluster_assumerole/README.MD b/examples/eks/eks_cluster_assumerole/README.MD
index 9470ce24..ea989770 100644
--- a/examples/eks/eks_cluster_assumerole/README.MD
+++ b/examples/eks/eks_cluster_assumerole/README.MD
@@ -12,6 +12,14 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_cluster_autoscaler_policies/README.MD b/examples/eks/eks_cluster_autoscaler_policies/README.MD
index dec86eeb..d32cbfed 100644
--- a/examples/eks/eks_cluster_autoscaler_policies/README.MD
+++ b/examples/eks/eks_cluster_autoscaler_policies/README.MD
@@ -12,6 +12,13 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token.
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_cluster_custom_iam/README.md b/examples/eks/eks_cluster_custom_iam/README.md
index 278d00d0..5c88171d 100644
--- a/examples/eks/eks_cluster_custom_iam/README.md
+++ b/examples/eks/eks_cluster_custom_iam/README.md
@@ -27,6 +27,13 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_cluster_existing/README.MD b/examples/eks/eks_cluster_existing/README.MD
index 35638986..488887f8 100644
--- a/examples/eks/eks_cluster_existing/README.MD
+++ b/examples/eks/eks_cluster_existing/README.MD
@@ -10,6 +10,17 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region, vpc_id, cluster_security_group_id, node_security_group_id, subnets and CAST AI API token.
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+| vpc_id                      = "" | Virtual Private Cloud(VPC) id |
+| cluster_security_group_id   = "" | Cluster security group id |
+| node_security_group_id      = "" | Node security group id |
+| subnets                     = ["", ""] | Public subnets of cluster |
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_cluster_optional_readonly/README.MD b/examples/eks/eks_cluster_optional_readonly/README.MD
index 5e04a3b6..893d6009 100644
--- a/examples/eks/eks_cluster_optional_readonly/README.MD
+++ b/examples/eks/eks_cluster_optional_readonly/README.MD
@@ -11,6 +11,13 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_cluster_readonly/README.MD b/examples/eks/eks_cluster_readonly/README.MD
index b94546bc..5f0197e2 100644
--- a/examples/eks/eks_cluster_readonly/README.MD
+++ b/examples/eks/eks_cluster_readonly/README.MD
@@ -9,6 +9,13 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init
diff --git a/examples/eks/eks_clusters/README.MD b/examples/eks/eks_clusters/README.MD
index 49498639..463cf2ee 100644
--- a/examples/eks/eks_clusters/README.MD
+++ b/examples/eks/eks_clusters/README.MD
@@ -14,6 +14,13 @@ Example configuration should be analysed in the following order:
 # Usage
 1. Rename `tf.vars.example` to `tf.vars`
 2. Update `tf.vars` file with your cluster name, cluster region and CAST AI API token.
+
+| Variable | Description |
+| --- | --- |
+| cluster_name                = "" | Name of cluster |
+| cluster_region              = "" | Name of region of cluster |
+| castai_api_token            = "" | Cast api token |
+
 3. Initialize Terraform. Under example root folder run:
 ```
 terraform init