Skip to content

Commit

Permalink
Updated information on variables in read me (castai#342)
Browse files Browse the repository at this point in the history
* Updated information on variables in read me

* Changes to readme in eka cluster examples
  • Loading branch information
arthivjkumar authored Aug 5, 2024
1 parent a3c7c51 commit bbb5b3a
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 0 deletions.
8 changes: 8 additions & 0 deletions examples/eks/eks_cluster_access_entries/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions examples/eks/eks_cluster_assumerole/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions examples/eks/eks_cluster_autoscaler_policies/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions examples/eks/eks_cluster_custom_iam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions examples/eks/eks_cluster_existing/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions examples/eks/eks_cluster_optional_readonly/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions examples/eks/eks_cluster_readonly/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions examples/eks/eks_clusters/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bbb5b3a

Please sign in to comment.