Skip to content

Commit

Permalink
ReadMe update (#279)
Browse files Browse the repository at this point in the history
* Update README.MD

making edits to the README on the Example EKS repos to specify which ones are for phase 1, because some customers having been facing issues differentiating lately.

* Update README.MD

making edits to the README on the Example EKS repos to specify which ones are for phase 1, because some customers having been facing issues differentiating lately.

* Update README.MD

making edits to the README on the Example EKS repos to specify which ones are for phase 2, because some customers having been facing issues differentiating lately.

* Update README.MD

making edits to the README on the Example EKS repos to specify which ones are for phase 2, because some customers having been facing issues differentiating lately.

* Update README.MD

making edits to the README on the Example EKS repos to specify which ones are for phase 2, because some customers having been facing issues differentiating lately.
  • Loading branch information
jbih26 authored Feb 23, 2024
1 parent fdb0361 commit 89c6ab0
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions examples/eks/eks_cluster_assumerole/README.MD
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## EKS and CAST AI example with CAST AI managed IAM policies
## EKS and CAST AI example with CAST AI managed IAM policies (Phase 2)

Following example shows how to onboard EKS cluster to CAST AI with CAST AI managed IAM policies.
Following this example shows how to onboard an EKS cluster to CAST AI with CAST AI managed IAM policies.

IAM policies in the example are created by [castai/eks-iam-role/castai module](https://github.com/castai/terraform-castai-eks-role-iam).

Example configuration should be analysed in the following order:
1. Create VPC - `vpc.tf`
2. Create EKS cluster - `eks.tf`
3. Create IAM and other CAST AI related resources to connect EKS cluster to CAST AI - `castai.tf`
3. Create IAM and other CAST AI related resources to connect EKS cluster to CAST AI (In Phase 2)- `castai.tf`

# Usage
1. Rename `tf.vars.example` to `tf.vars`
Expand Down
4 changes: 2 additions & 2 deletions examples/eks/eks_cluster_autoscaler_policies/README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## EKS and CAST AI example with CAST AI Autoscaler policies and additional Node Configurations
## EKS and CAST AI example with CAST AI Autoscaler policies and additional Node Configurations (Phase 2)

Following example shows how to onboard EKS cluster to CAST AI, configure [Autoscaler policies](https://docs.cast.ai/reference/policiesapi_upsertclusterpolicies) and additional [Node Configurations](https://docs.cast.ai/docs/node-configuration/).
Following this example shows how to onboard EKS cluster to CAST AI (In phase 2), configure [Autoscaler policies](https://docs.cast.ai/reference/policiesapi_upsertclusterpolicies) and additional [Node Configurations](https://docs.cast.ai/docs/node-configuration/).

IAM policies required to connect the cluster to CAST AI in the example are created by [castai/eks-role-iam/castai module](https://github.com/castai/terraform-castai-eks-role-iam).

Expand Down
10 changes: 5 additions & 5 deletions examples/eks/eks_cluster_optional_readonly/README.MD
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Example of EKS cluster connected to CAST AI to read-only mode with ability to switch cluster to full access mode.
Following example creates EKS cluster and its supporting resources using AWS community modules.
After EKS cluster is created, by default it is onboarded to CAST AI in Read-only mode.
Read-only behaviour is controlled by bool variable `readonly`.
Following this example creates an EKS cluster and its supporting resources using AWS community modules.
After EKS cluster is created, by default it is onboarded to CAST AI in Read-only mode(Phase 1).
Read-only behaviour is controlled by bool variable "readonly" (In the varaibles.tf file).
Example configuration should be analysed in the following order:
1. Create VPC - `vpc.tf`
2. Create EKS cluster - `eks.tf`
Expand All @@ -24,8 +24,8 @@ terraform apply -var-file=tf.vars
terraform destroy -var-file=tf.vars
```

# Enable full access mode after cluster was already onboarded to read-only mode
1. Set variable `readonly = false` and run `terraform apply -var-file=tf.vars`
# To Enable full access mode after cluster was already onboarded to read-only mode(Phase 1)
1. Set variable "readonly" = false`(it's true by default) and run `terraform apply -var-file=tf.vars`

Note: Current provider version (v3.13.0) does not support `castai_eks_cluster` resource in-place re-creation.
If `castai_eks_cluster` have to be re-created follow the steps below:
Expand Down
6 changes: 3 additions & 3 deletions examples/eks/eks_cluster_readonly/README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Example of EKS cluster connected to CAST AI in READ-ONLY mode
Following example creates EKS cluster and its supporting resources using AWS community modules.
After EKS cluster is created it is onboarded to CAST AI in Read-only mode.
# Example of EKS cluster connected to CAST AI in READ-ONLY mode (Phase 1)
Following this example creates EKS cluster and its supporting resources using AWS community modules.
After EKS cluster is created it is onboarded to CAST AI in Read-only mode(Phase 1).
Example configuration should be analysed in the following order:
1. Create VPC - `vpc.tf`
2. Create EKS cluster - `eks.tf`
Expand Down
2 changes: 1 addition & 1 deletion examples/eks/eks_clusters/README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## EKS and CAST AI example with CAST AI Autoscaler policies and additional Node Configurations

Following example shows how to onboard EKS cluster to CAST AI, configure [Autoscaler policies](https://docs.cast.ai/reference/policiesapi_upsertclusterpolicies) and additional [Node Configurations](https://docs.cast.ai/docs/node-configuration/).
Following this example shows how to onboard EKS cluster to CAST AI (Phase 2), configure [Autoscaler policies](https://docs.cast.ai/reference/policiesapi_upsertclusterpolicies) and additional [Node Configurations](https://docs.cast.ai/docs/node-configuration/).

IAM policies required to connect the cluster to CAST AI in the example are created by [castai/eks-role-iam/castai module](https://github.com/castai/terraform-castai-eks-role-iam).

Expand Down

0 comments on commit 89c6ab0

Please sign in to comment.