Skip to content

Commit c6a12e5

Browse files
committed
Fixed Review Comments
1 parent af531fe commit c6a12e5

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

docs/user-guide/global-configurations/cluster-and-environments.md

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -187,13 +187,13 @@ Only a [Super-Admin](../global-configurations/user-access.md#assign-super-admin-
187187

188188
{% endhint %}
189189

190-
To create an EKS cluster, as a prerequisite, you need:
190+
To create an EKS cluster, you need:
191191

192-
* [OpenTofu](#install-opentofu) (`tofu-controller`) installed in your Devtron instance.
192+
* [OpenTofu](#install-opentofu) (`tofu-controller`) chart installed in your Devtron instance.
193193

194194
Refer to [Getting Started with OpenTofu](https://opentofu.org/docs/intro/) for more information.
195195

196-
* [FluxCD controller](#install-fluxcd-controller) (`flux2`) installed in your Devtron instance
196+
* [FluxCD controller](#install-fluxcd-controller) (`flux2`) chart installed in your Devtron instance
197197

198198
* [Secret](#create-a-secret) containing AWS credentials
199199

@@ -275,43 +275,47 @@ Now that FluxCD controller is installed, the final prerequisite is to [create a
275275

276276
### Who Can Perform This Action?
277277

278-
Only an [Admin](../../user-guide/global-configurations/authorization/user-access.md#kubernetes-resources-permissions) of the Kubernetes resource can create a Secret.
278+
User needs to be an [Admin](../../user-guide/global-configurations/authorization/user-access.md#kubernetes-resources-permissions) of the Kubernetes resource or a [Super-Admin](../../user-guide/global-configurations/authorization/user-access.md#kubernetes-resources-permissions) to create a Secret.
279279

280280
{% endhint %}
281281

282282
Follow the steps mentioned below to create a secret containing your AWS credentials:
283283

284284
1. Navigate to **Resource Browser**.
285285

286-
2. Select the **default_cluster** and click **Create Resource**.
286+
2. Click the **default_cluster**.
287287

288-
3. Copy the YAML snippet given below and paste it in the **Create Kubernetes Resource** page.
288+
3. Click **Create Resource**.
289289

290-
```
290+
4. Copy the YAML snippet given below and paste it in the **Create Kubernetes Resource** page.
291+
292+
```yaml
291293
apiVersion: v1
292294
data:
293295
AWS_ACCESS_KEY_ID: SDKDI382DKD0=
294296
AWS_SECRET_ACCESS_KEY: YVZsSIEOwcFRSMjlvM2xaUjSIE823J3PT0=
295297
kind: Secret
296298
metadata:
297299
name: tf-aws-creds
298-
namespace: default_cluster
300+
namespace: your-namespace
299301
type: Opaque
300302
```
301303
302304
{% hint style="warning" %}
303305
304306
### Important Note
305307
306-
* It is recommended to keep the `name` attribute to `tf-aws-creds`. Changing this value will make the secret go unrecognized.
308+
* It is recommended to keep the `name` attribute to `tf-aws-creds`. Changing this value might make the secret go unrecognized.
309+
310+
* The secret must be created in the same namespace where OpenTofu and FluxCD controller are installed.
307311

308-
* The secret must be created in the same `namespace` where OpenTofu and FluxCD controller are installed.
312+
* When creating a secret, kindly ensure that your `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are encoded in base64. Go to [Devtron Base64 Encoder](https://strings.devtron.ai/base64-encoder) to encode your AWS credentials.
309313

310314
{% endhint %}
311315

312-
4. Enter your AWS access key against the `AWS_ACCESS_KEY_ID` attribute and AWS secret key against the `AWS_SECRET_ACCESS_KEY` attribute. Refer to [Create New Access Keys](https://docs.aws.amazon.com/keyspaces/latest/devguide/create.keypair.html) for more information.
316+
5. Enter your AWS access key against the `AWS_ACCESS_KEY_ID` attribute and AWS secret key against the `AWS_SECRET_ACCESS_KEY` attribute. Refer to [Create New Access Keys](https://docs.aws.amazon.com/keyspaces/latest/devguide/create.keypair.html) for more information.
313317

314-
5. Click **Apply**. The secret will be created.
318+
6. Click **Apply**. The secret will be created.
315319

316320
Now that all the prerequisites are met, you can proceed to create a cluster from the **Create Kubernetes Cluster** page.
317321

@@ -325,33 +329,33 @@ Only a [Super-Admin](../global-configurations/user-access.md#assign-super-admin-
325329

326330
{% endhint %}
327331

328-
Navigate to **Global Configurations****Clusters & Environments****New Cluster****Create Kubernetes Cluster**.
332+
* Navigate to **Global Configurations** → **Clusters & Environments** → **New Cluster** → **Create Kubernetes Cluster**.
329333

330-
Refer the following table (containing **mandatory** fields) and enter the details in the corresponding fields:
334+
* Refer the following table (containing **mandatory** fields) and enter the details in the corresponding fields:
331335

332-
| Field | Description |
333-
| :--- | :--- |
334-
| `Cluster Provider` | Select the type of cluster you'd like to create based on your requirement |
335-
| `Name` | Enter the name of your Kubernetes cluster (e.g., `eks-cluster-nonprod` in the case of EKS and `rancher-cluster-qa` in the case of Rancher) |
336-
| `Region` | Select the region where your cluster is hosted (e.g., `us-east-1` in the case of EKS and `ap-south-3` in the case of Rancher) <br> Refer to [View cluster details using the AWS Management Console](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-manage-view-clusters.html#emr-view-cluster-console) for more information|
337-
| `VPC CIDR` | Enter the [VPC CIDR](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html) value. This value determines the number of [pods](../../reference/glossary.md#pod), [nodes](../../reference/glossary.md#nodes), or services your cluster can host (e.g., `10.0.1.6/16`)|
338-
| `Authentication Mode` | Select the authentication mode you wish to perform for the cluster <br> <ul><li> **API_AND_CONFIG_MAP** - Select this if you want to use both the API and the ConfigMap to authenticate who can access the cluster. This option is recommended if you are migrating from the old `aws-auth` ConfigMap method (which is deprecated) to the new API method. <br> Refer to [Grant IAM users access to Kubernetes with EKS access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) for more information. </li> <li>**API** - Select this if you want to manage access using a single API. This option is recommended as this is the best practice for EKS cluster creation. <br> Refer to [Manage User Access with API](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) for more information.</li> <li> **CONFIG MAP** - Select this if you want to rely on the original (but deprecated) way of authentication using `aws-auth` ConfigMap. This option is not recommended anymore. <br> Refer to [Grant IAM users access to Kubernetes. with a ConfigMap.](https://docs.aws.amazon.com/eks/latest/userguide/auth-configmap.html) for more information.</li></ul>|
339-
| `Enable IRSA` | Turn on this IRSA toggle (IAM Roles for [Service Accounts](https://kubernetes.io/docs/concepts/security/service-accounts/)) if you want your application to securely connect to other AWS services using a service account|
340-
| `Allow public access` | Turn on this toggle if you want to allow your [EKS control plane](https://docs.aws.amazon.com/eks/latest/best-practices/control-plane.html) endpoint to be accessed publicly from anywhere without the VPC. It is recommended to keep this toggle disabled |
341-
| `Cluster Version` | Select your preferred Kubernetes cluster version. If you are running a live application in a production environment, it is recommended that you select a stable version instead of the latest version |
336+
| Field | Description |
337+
| :--- | :--- |
338+
| `Cluster Provider` | Select the type of cluster you'd like to create based on your requirement |
339+
| `Name` | Enter the name of your Kubernetes cluster (e.g., `eks-cluster-nonprod` in the case of EKS and `rancher-cluster-qa` in the case of Rancher) |
340+
| `Region` | Select the region where your cluster is hosted (e.g., `us-east-1` in the case of EKS and `ap-south-3` in the case of Rancher) <br> Refer to [View cluster details using the AWS Management Console](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-manage-view-clusters.html#emr-view-cluster-console) for more information|
341+
| `VPC CIDR` | Enter the [VPC CIDR](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html) value. This value determines the number of [pods](../../reference/glossary.md#pod), [nodes](../../reference/glossary.md#nodes), or services your cluster can host (e.g., `10.0.1.6/16`)|
342+
| `Authentication Mode` | Select the authentication mode you wish to perform for the cluster <br> <ul><li> **API_AND_CONFIG_MAP** - Select this if you want to use both the API and the ConfigMap to authenticate who can access the cluster. This option is recommended if you are migrating from the old `aws-auth` ConfigMap method (which is deprecated) to the new API method. <br> Refer to [Grant IAM users access to Kubernetes with EKS access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) for more information. </li> <li>**API** - Select this if you want to manage access using a single API. This option is recommended as this is the best practice for EKS cluster creation. <br> Refer to [Manage User Access with API](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) for more information.</li> <li> **CONFIG MAP** - Select this if you want to rely on the original (but deprecated) way of authentication using `aws-auth` ConfigMap. This option is not recommended anymore. <br> Refer to [Grant IAM users access to Kubernetes. with a ConfigMap.](https://docs.aws.amazon.com/eks/latest/userguide/auth-configmap.html) for more information.</li></ul>|
343+
| `Enable IRSA` | Turn on this IRSA toggle (IAM Roles for [Service Accounts](https://kubernetes.io/docs/concepts/security/service-accounts/)) if you want your application to securely connect to other AWS services using a service account|
344+
| `Allow public access` | Turn on this toggle if you want to allow your [EKS control plane](https://docs.aws.amazon.com/eks/latest/best-practices/control-plane.html) endpoint to be accessed publicly from anywhere without the VPC. It is recommended to keep this toggle disabled |
345+
| `Cluster Version` | Select your preferred Kubernetes cluster version. If you are running a live application in a production environment, it is recommended that you select a stable version instead of the latest version |
342346

343-
![Figure 19: Create Kubernetes Cluster](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/create-k8s-cluster.jpg)
347+
![Figure 19: Create Kubernetes Cluster](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/create-k8s-cluster.jpg)
344348

345-
Refer the following table (containing **optional** fields) and enter the details in the corresponding fields:
349+
* Refer the following table (containing **optional** fields) and enter the details in the corresponding fields:
346350

347-
| Field | Description |
348-
| :--- | :--- |
349-
| `Team` | Select the team whose tag you want to attach to the cluster resources. For example, when you select `qa-team`, it means that the cluster resources (pods, ConfigMaps, etc.) created with this cluster are owned by the QA team |
350-
| `Environment` | Select the environment. For example, when you select `qa`, it means that this cluster is a part of the QA environment |
351-
| `Availability Zones` | Select availability zones (e.g., `us-east-2b` and `ap-west-1a`) if you prefer to distribute your worker nodes across multiple zones to make your cluster highly available. <br> This means that even if one availability zone goes down (e.g., `us-east-2b`), the other zones (e.g., `ap-west-1a`) keep your cluster up and running |
352-
| `Private access CIDRs` | Enter the private access CIDRs (IP addresses that are allowed to reach the API server). If you had turned off the **Allow public access** toggle, then your EKS control plane endpoint would be private. <br> It then becomes crucial to enter the private access CIDRs so that the API server recognizes them and allows them to access the endpoint |
351+
| Field | Description |
352+
| :--- | :--- |
353+
| `Team` | Select the team whose tag you want to attach to the cluster resources. For example, when you select `qa-team`, it means that the cluster resources (pods, ConfigMaps, etc.) created with this cluster are owned by the QA team |
354+
| `Environment` | Select the environment. For example, when you select `qa`, it means that this cluster is a part of the QA environment |
355+
| `Availability Zones` | Select availability zones (e.g., `us-east-2b` and `ap-west-1a`) if you prefer to distribute your worker nodes across multiple zones to make your cluster highly available. <br> This means that even if one availability zone goes down (e.g., `us-east-2b`), the other zones (e.g., `ap-west-1a`) keep your cluster up and running |
356+
| `Private access CIDRs` | Enter the private access CIDRs (IP addresses that are allowed to reach the API server). If you had turned off the **Allow public access** toggle, then your EKS control plane endpoint would be private. <br> It then becomes crucial to enter the private access CIDRs so that the API server recognizes them and allows them to access the endpoint |
353357

354-
Click **Create Cluster**.
358+
* Click **Create Cluster**.
355359

356360
---
357361

0 commit comments

Comments
 (0)