Skip to content

Commit bc82d76

Browse files
[CLOUDCRAFT 1192] Update EKS documentation to reflect modern expectations (#28763)
* [CLOUDCRAFT-1192] Update EKS documentation Signed-off-by: James Pond <[email protected]> * [CLOUDCRAFT-1192] Update wording Signed-off-by: James Pond <[email protected]> --------- Signed-off-by: James Pond <[email protected]>
1 parent 2e4193c commit bc82d76

File tree

1 file changed

+24
-36
lines changed

1 file changed

+24
-36
lines changed

content/en/cloudcraft/getting-started/connect-amazon-eks-cluster-with-cloudcraft.md

+24-36
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ title: Connect an Amazon EKS Cluster with Cloudcraft
44

55
By scanning your Amazon EKS clusters, Cloudcraft allows you to generate system architecture diagrams to help visualize your deployed workloads and pods.
66

7-
Cloudcraft uses the [role-based access control (RBAC) authorization method provided by Kubernetes][1] to authorize [Cloudcraft's existing read-only IAM entity role][2]. That means Cloudcraft requires no special software or agent.
8-
9-
To learn more about RBAC configuration and IAM entities, see [Managing users or IAM roles for your cluster][3].
7+
Cloudcraft uses [access entries][1] to grant [Cloudcraft's existing read-only IAM entity role][2] access to the Kubernetes API. Cloudcraft does not require any special software or agent to be installed on your cluster.
108

119
<div class="alert alert-info">The ability to scan Amazon EKS clusters and AWS accounts is only available to Cloudcraft Pro subscribers. Check out <a href="https://www.cloudcraft.co/pricing">our pricing page</a> for more information.</div>
1210

@@ -15,48 +13,37 @@ To learn more about RBAC configuration and IAM entities, see [Managing users or
1513
Before connecting your Amazon EKS clusters with Cloudcraft, you must connect your AWS account and generate diagrams that include your clusters.
1614

1715
To connect your AWS account and familiarize yourself with Cloudcraft, see the following articles:
18-
- [Connect your AWS account with Cloudcraft][4]
19-
- [Create your first live AWS diagram][5]
16+
- [Connect your AWS account with Cloudcraft][3]
17+
- [Crafting Better Diagrams: Cloudcraft's Live Diagramming and Filtering][4]
18+
19+
[Install and configure `kubectl`][6], a tool that allows you to control Kubernetes clusters through the command line. Cloudcraft recommends using the latest version to avoid issues.
2020

21-
[Install and configure `kubectl`][7], a tool that allows you to control Kubernetes clusters through the command line. Cloudcraft recommends using the latest version to avoid issues.
21+
In addition, you'll want to [install and configure the AWS CLI][8] to manage your AWS services from the command line. As with `kubectl`, Cloudcraft recommends using the latest version.
2222

23-
In addition, in order to scan your cluster successfully, Cloudcraft requires clusters to have public access enabled and no IP filtering applied. The **Public Access Source Allow List** option in the networking configuration must remain set to its default value of 0.0.0.0/0.
23+
Finally, in order to scan your cluster successfully, Cloudcraft requires clusters to have public access enabled and no IP filtering applied. The **Public Access Source Allow List** option in the networking configuration must remain set to its default value of 0.0.0.0/0.
2424

25-
## Authorizing the Cloudcraft IAM role for view-only
25+
## Create access entries
2626

27-
Start by opening a blueprint with an existing Amazon EKS cluster or using the **Auto Layout** feature to generate a new blueprint.
27+
Start by opening a blueprint with an existing Amazon EKS cluster or creating a new blueprint to scan an account with Amazon EKS clusters.
2828

2929
With your AWS environment mapped into a blueprint, select the Amazon EKS cluster that you wish to scan, and click the **Enable cluster scanning** button that appears in the component toolbar.
3030

3131
{{< img src="cloudcraft/getting-started/connect-amazon-eks-cluster-with-cloudcraft/enable-cluster-scanning.png" alt="Interactive Cloudcraft diagram showing an AWS EKS cluster with enable cluster scanning button highlighted." responsive="true" style="width:100%;">}}
3232

33-
The next screen provides step-by-step commands to run in Terminal.
33+
The next screen provides step-by-step commands to run in your favorite terminal application.
3434

35-
As the Amazon EKS cluster creator or user with admin access, open the aws-auth ConfigMap file with `kubectl`.
35+
As the Amazon EKS cluster creator or user with admin access, run the following command to map the Cloudcraft IAM role to the Kubernetes group `cloudcraft-view-only`:
3636

3737
```
38-
kubectl edit -n kube-system configmap/aws-auth
39-
```
40-
41-
With the `aws-auth.yaml` file open in a text editor, add the role details to the *mapRoles* section of the file, just after under the *data* section.
42-
38+
aws eks create-access-entry \
39+
--cluster-name ${EKS_CLUSTER_NAME} \
40+
--principal-arn ${CLOUDCRAFT_IAM_ROLE_ARN} \
41+
--kubernetes-groups 'cloudcraft-view-only'
4342
```
44-
data:
45-
mapRoles: |
46-
- rolearn: <arn-for-the-readonly-cloudcraft-iam-role>
47-
groups:
48-
- cloudcraft-view-only
49-
```
50-
51-
If the section does not exist, add it. Once done, save the file and exit.
52-
53-
<div class="alert alert-info">`groups` refer to groups in your cluster to which the role is mapped. For more information, see [Default Roles and Role Bindings][8] in the Kubernetes documentation.</div>
54-
55-
<div class="alert alert-danger">Typos and syntax errors can affect the permissions of all IAM users and roles updated in the ConfigMap file. To prevent this from occuring, Cloudcraft recommends adding a YAML linter to your text editor.</div>
5643

5744
## Granting view-only access to the Cloudcraft IAM role
5845

59-
Next, use [ClusterRoleBinding][6] to bind the IAM role to a Kubernetes role.
46+
Next, use [ClusterRoleBinding][5] to bind the IAM role to a Kubernetes role.
6047

6148
A ClusterRoleBinding grants permissions defined in a role to a user or set of users in all namespaces in a cluster. Kubernetes defines some default user-facing roles. For Cloudcraft, use the predefined "view" role that allows view-only access to most objects in a namespace.
6249

@@ -65,6 +52,7 @@ Enter the following multi-line command to create the ClusterRoleBinding and gran
6552
```
6653
cat << EOF | kubectl apply -f -
6754
apiVersion: rbac.authorization.k8s.io/v1
55+
kind: ClusterRoleBinding
6856
metadata:
6957
name: cloudcraft-view-only
7058
subjects:
@@ -86,11 +74,11 @@ To test that Cloudcraft can access to the cluster, click **Test cluster access**
8674

8775
To scan other clusters, repeat the process as many times as needed.
8876

89-
[1]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
77+
[1]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html
9078
[2]: /cloudcraft/faq/how-cloudcraft-connects-to-aws/
91-
[3]: https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html
92-
[4]: /cloudcraft/getting-started/connect-aws-account-with-cloudcraft/
93-
[5]: /cloudcraft/getting-started/create-your-first-cloudcraft-diagram/
94-
[6]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding
95-
[7]: https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html
96-
[8]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings
79+
[3]: /cloudcraft/getting-started/connect-aws-account-with-cloudcraft/
80+
[4]: /cloudcraft/getting-started/crafting-better-diagrams/
81+
[5]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding
82+
[6]: https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html
83+
[7]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings
84+
[8]: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

0 commit comments

Comments
 (0)