## Overview

To attach a cluster means to connect it to Google Cloud by registering it with
Google Cloud [Fleet management](https://docs.cloud.google.com/anthos/fleet-management/docs) and
installing the GKE attached clusters software on it.

You can attach a cluster using the gcloud CLI or Terraform. To learn
how to create and attach an EKS cluster using Terraform, check the
[GitHub repository of samples for GKE attached clusters](https://github.com/GoogleCloudPlatform/anthos-samples/tree/main/anthos-attached-clusters).

This page is for IT administrators and Operators who want to set up,
monitor, and manage cloud infrastructure. To learn more about common roles and
example tasks that we reference in Google Cloud content, see
[Common GKE user roles and tasks](https://docs.cloud.google.com/kubernetes-engine/enterprise/docs/concepts/roles-tasks.md.txt).

To attach an EKS cluster using gcloud, perform the
following steps.

## Prerequisites

Ensure that your cluster meets the [cluster requirements](https://docs.cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/eks/reference/cluster-prerequisites.md.txt).

When attaching your cluster, you must specify:

- a supported Google Cloud [administrative region](https://docs.cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/eks/reference/supported-regions.md.txt) and
- a platform version.

The administrative region is a Google Cloud region
to administer your attached cluster from. You can choose any supported
region, but best practice is to choose the region geographically closest to
your cluster. No user data is stored in the administrative region.

The platform version is the version of GKE attached clusters to be installed on your
cluster. You can list all supported versions by running the following command:

```bash
gcloud container attached get-server-config  \
  --location=GOOGLE_CLOUD_REGION
```

Replace <var translate="no">GOOGLE_CLOUD_REGION</var> with the name of the
Google Cloud location to administer your cluster from.

## Platform version numbering

These documents refer to the GKE attached clusters version as the platform version,
to distinguish it from the Kubernetes version. GKE attached clusters uses the same
version numbering convention as GKE - for example, 1.21.5-gke.1. When attaching
or updating your cluster, you must choose a platform version whose minor version
is the same as or one level below the Kubernetes version of your cluster. For
example, you can attach a cluster running Kubernetes v1.22.\* with
GKE attached clusters platform version 1.21.\* or 1.22.\*.

This lets you upgrade your cluster to the next minor version before upgrading
GKE attached clusters.

## Attach an EKS cluster

> [!NOTE]
> **Note:** The default number of clusters that you can attach per project is 50. To increase this quota, contact [Google Cloud support](https://docs.cloud.google.com/support).

To attach your EKS cluster to Google Cloud
[Fleet management](https://docs.cloud.google.com/anthos/fleet-management/docs), perform the following steps:

1. Ensure that your kubeconfig file has an entry for the cluster you'd like
   to attach:

   ```bash
   aws eks update-kubeconfig --region AWS_REGION \
     --name EKS_CLUSTER_NAME
   ```
2. Retrieve the OIDC issuer URL with the following command:

   ```bash
   aws eks describe-cluster \
     --region AWS_REGION \
     --name EKS_CLUSTER_NAME \
     --query "cluster.identity.oidc.issuer" \
     --output text
   ```

   The output of this command is the URL of your OIDC issuer. Save this value
   for use later.
3. Run this command to extract your cluster's kubeconfig context and
   store it in the `KUBECONFIG_CONTEXT` environment variable:

   ```bash
   KUBECONFIG_CONTEXT=$(kubectl config current-context)
   ```
4. Use the
   [`gcloud container attached clusters register` command](https://docs.cloud.google.com/sdk/gcloud/reference/container/attached/clusters/register) to register the cluster:

   ```bash
   gcloud container attached clusters register CLUSTER_NAME \
     --location=GOOGLE_CLOUD_REGION \
     --fleet-project=PROJECT_NUMBER \
     --platform-version=PLATFORM_VERSION \
     --distribution=eks \
     --issuer-url=ISSUER_URL \
     --context=KUBECONFIG_CONTEXT \
     --kubeconfig=KUBECONFIG_PATH
   ```

   Replace:

- <var translate="no">AWS_REGION</var>: the AWS region where your EKS cluster is located
- <var translate="no">CLUSTER_NAME</var>: the name of your cluster. This name can be the same <var translate="no">EKS_CLUSTER_NAME</var> you used in the preceding steps. The <var translate="no">CLUSTER_NAME</var> must be compliant with the [RFC 1123 Label Names standard](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names).
- <var translate="no">GOOGLE_CLOUD_REGION</var>: the Google Cloud region to administer your cluster
- <var translate="no">PLATFORM_VERSION</var>: the GKE attached clusters version to use for the cluster
- <var translate="no">PROJECT_NUMBER</var>: the fleet host project where the cluster will be registered
- <var translate="no">ISSUER_URL</var>: the issuer URL retrieved earlier
- <var translate="no">KUBECONFIG_CONTEXT</var>: context in the kubeconfig for accessing the EKS cluster, as extracted earlier
- <var translate="no">KUBECONFIG_PATH</var>: path to your kubeconfig

  > [!NOTE]
  > **Note:** If attaching your cluster fails, the system automatically rolls back any changes made to Google Cloud resources related to the cluster, such as workload identity pool. This means the connection between your cluster and GKE attached clusters isn't established, but your actual EKS cluster remains unaffected. You can try again to attach the cluster after fixing the issue that caused the failure.

## Authorize Cloud Logging / Cloud Monitoring

> [!NOTE]
> **Note:** Starting with Kubernetes version 1.28, manual policy binding to authorize the `gke-system/gke-telemetry-agent` service account for log and metric collection is no longer necessary. The required permissions are now automatically granted to this service account. You can therefore disregard this section.

In order for GKE attached clusters to create and upload system logs and metrics to
Google Cloud, it must be authorized.

To authorize the Kubernetes workload identity `gke-system/gke-telemetry-agent`
to write logs to Google Cloud Logging, and metrics to Google Cloud Monitoring,
run this command:

```bash
gcloud projects add-iam-policy-binding GOOGLE_PROJECT_ID \
  --member="serviceAccount:GOOGLE_PROJECT_ID.svc.id.goog[gke-system/gke-telemetry-agent]" \
  --role=roles/gkemulticloud.telemetryWriter
```

Replace `GOOGLE_PROJECT_ID` with the cluster's Google Cloud project ID.

This IAM binding grants access for all clusters in the Google Cloud project project to
upload logs and metrics. You only need to run it after creating your
first cluster for the project.

Adding this IAM binding will fail unless at least one cluster has been
created in your Google Cloud project. This is because the workload identity pool
it refers to (`GOOGLE_PROJECT_ID.svc.id.goog`) is
not provisioned until cluster creation.