Information
Running the GKE Metadata Server prevents workloads from accessing sensitive instance metadata and facilitates Workload Identity.
Every node stores its metadata on a metadata server. Some of this metadata, such as kubelet credentials and the VM instance identity token, is sensitive and should not be exposed to a Kubernetes workload. Enabling the GKE Metadata server prevents pods (that are not running on the host network) from accessing this metadata and facilitates Workload Identity.
When unspecified, the default setting allows running pods to have full access to the node's underlying metadata server.
Solution
The GKE Metadata Server requires Workload Identity to be enabled on a cluster. Modify the cluster to enable Workload Identity and enable the GKE Metadata Server.
Using Google Cloud Console
- Go to Kubernetes Engine by visiting
https://console.cloud.google.com/kubernetes/list
- From the list of clusters, select the cluster for which Workload Identity is disabled.
- Under the DETAILS pane, navigate down to the Security subsection.
- Click on the pencil icon named Edit Workload Identity click on Enable Workload Identity in the pop-up window, and select a workload pool from the drop-down box. By default, it will be the namespace of the Cloud project containing the cluster, for example: <project_id>.svc.id.goog
- Click SAVE CHANGES and wait for the cluster to update.
- Once the cluster has updated, select each Node pool within the cluster Details page.
- For each Node pool, select EDIT within the Node pool details page.
- Within the Edit node pool pane, check the Enable GKE Metadata Server checkbox.
- Click SAVE
Using Command Line
gcloud container clusters update <cluster_name> --identity-namespace=<project_id>.svc.id.goog
Note that existing Node pools are unaffected. New Node pools default to --workload-metadata-from-node=GKE_METADATA_SERVER
To modify an existing Node pool to enable GKE Metadata Server:
gcloud container node-pools update <node_pool_name> --cluster=<cluster_name> --workload-metadata-from-node=GKE_METADATA_SERVER
Workloads may need modification in order for them to use Workload Identity as described within:
https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
Impact:
The GKE Metadata Server must be run when using Workload Identity. Because Workload Identity replaces the need to use Metadata Concealment, the two approaches are incompatible.
When the GKE Metadata Server and Workload Identity are enabled, unless the Pod is running on the host network, Pods cannot use the the Compute Engine default service account.
Workloads may need modification in order for them to use Workload Identity as described within:
https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity