Skip to content

Commit

Permalink
Update user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
cPu1 committed Sep 17, 2021
1 parent 791c5f8 commit 9ce2a0b
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions userdocs/src/usage/eks-connector.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# Registering non-EKS clusters with EKS Connector
The EKS Console provides a single pane of glass to manage all your Kubernetes clusters, including those hosted on
other cloud providers, via EKS Connector. This process requires registering the cluster with EKS and running the
EKS Connector agent on the external Kubernetes cluster.
other cloud providers, via [EKS Connector][eks-user-guide]. This process requires registering the cluster with EKS and running the
EKS Connector agent on the external Kubernetes cluster.

`eksctl` simplifies registering non-EKS clusters by creating the required AWS resources and generating Kubernetes manifests
`eksctl` simplifies registering non-EKS clusters by creating the required AWS resources and generating Kubernetes manifests
for EKS Connector to apply to the external cluster.


## Register Cluster
To register or connect a non-EKS Kubernetes cluster, run

```shell
$ eksctl register cluster --name <name> --provider <provider>
2021-08-19 13:47:26 [ℹ] creating IAM role "eksctl-20210819194112186040"
2021-08-19 13:47:26 [ℹ] registered cluster "<name>" successfully
2021-08-19 13:47:26 [ℹ] wrote file eks-connector.yaml to <current directory>
2021-08-19 13:47:26 [ℹ] wrote file eks-connector-binding.yaml to <current directory>
2021-08-19 13:47:26 [ℹ] wrote file eks-connector-clusterrole.yaml to <current directory>
2021-08-19 13:47:26 [ℹ] wrote file eks-connector-console-dashboard-full-access-group.yaml to <current directory>
2021-08-19 13:47:26 [!] note: ClusterRoleBinding in "eks-connector-binding.yaml" gives cluster-admin permissions to IAM identity "<aws-arn>", edit if required; read https://eksct.io/usage/eks-connector for more info
2021-08-19 13:47:26 [ℹ] run `kubectl apply -f eks-connector.yaml,eks-connector-binding.yaml` before <expiry> to connect the cluster
2021-08-19 13:47:26 [ℹ] run `kubectl apply -f eks-connector.yaml,eks-connector-clusterrole.yaml,eks-connector-console-dashboard-full-access-group.yaml` before <expiry> to connect the cluster

```
Expand All @@ -28,7 +29,7 @@ the Kubernetes manifests for EKS Connector that must be applied to the external
`eks-connector-binding.yaml` contains a `ClusterRoleBinding` that gives `cluster-admin` permissions to the calling
IAM identity and must be edited accordingly if required before applying it to the cluster.
To provide an existing IAM role to use for EKS Connector, pass it via `--role-arn` as in:
To provide an existing IAM role to use for EKS Connector, pass it via `--role-arn` as in:
```shell
$ eksctl register cluster --name <name> --provider <provider> --role-arn=<role-arn>
Expand All @@ -48,5 +49,12 @@ $ eksctl deregister cluster --name <name>
2021-08-19 16:04:09 [ℹ] run `kubectl delete namespace eks-connector` and `kubectl delete -f eks-connector-binding.yaml` on your cluster to remove EKS Connector resources
```
This command will deregister the external cluster and remove its associated AWS resources, but you are required to remove the
This command will deregister the external cluster and remove its associated AWS resources, but you are required to remove the
EKS connector Kubernetes resources from the cluster.
## Further information
- [EKS Connector][eks-user-guide]
[eks-user-guide]: https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html

0 comments on commit 9ce2a0b

Please sign in to comment.