Usa Workload Identity

En esta página, se explica la forma en que se recomienda que las aplicaciones de Google Kubernetes Engine (GKE) consuman los servicios proporcionados por las API de Google.

Descripción general

Workload Identity es la forma recomendada de acceder a los servicios de Google Cloud desde aplicaciones que se ejecutan dentro de GKE debido a sus propiedades de seguridad y capacidad de administración mejoradas. Si deseas obtener información sobre formas alternativas para acceder a las API de Google Cloud desde GKE, consulta la sección alternativas a continuación.

Terminología

En este documento, se distingue entre cuentas de servicio de Kubernetes y cuentas de servicio de Google. Las cuentas de servicio de Kubernetes son recursos de Kubernetes, mientras que las cuentas de servicio de Google son específicas de Google Cloud. En otros documentos de Google Cloud, se hace referencia a las cuentas de servicio de Google como “cuentas de servicio”.

Conceptos

Las aplicaciones que se ejecutan en GKE deben autenticarse para usar las API de Google Cloud, como las API de Compute, las API de Storage y Database o las API de aprendizaje automático.

Con Workload Identity, puedes configurar una cuenta de servicio de Kubernetes para que actúe como una cuenta de servicio de Google. Cualquier aplicación que se ejecute como la cuenta de servicio de Kubernetes se autentica de manera automática como la cuenta de servicio de Google cuando se accede a las API de Google Cloud. Esto te permite asignar identidad y autorización detalladas para las aplicaciones en el clúster.

Para realizar una mapeo seguro entre las cuentas de servicio de Kubernetes y las cuentas de servicio de Google, Workload Identity presenta el concepto del grupo de identidades de la carga de trabajo de un clúster, que permite que la administración de identidades y accesos (IAM) confíe y comprenda las credenciales de la cuenta de servicio de Kubernetes.

Cuando habilites Workload Identity en tu clúster de GKE, configura el grupo de identidades de la carga de trabajo del clúster como my-pool.svc.id.goog. Esto permite que IAM autentique las cuentas de servicio de Kubernetes como el siguiente nombre de miembro:

serviceAccount:my-pool.svc.id.goog[k8s-namespace/ksa-name]

En este nombre de miembro, se da lo siguiente:

  • my-pool.svc.id.goog es el grupo de identidades de carga de trabajo configurado en el clúster.
  • ksa-name es el nombre de la cuenta de servicio de Kubernetes que realiza la solicitud.
  • k8s-namespace es el espacio de nombres de Kubernetes en el que se define la cuenta de servicio de Kubernetes.

Solo hay un grupo de identidades de carga de trabajo fijo por proyecto de Google Cloud, project-id.svc.id.goog, y se crea de forma automática para ti.

Comparte identidades entre clústeres

Todas las cuentas de servicio de Kubernetes que comparten un nombre, un nombre de espacio de nombres y un grupo de identidad de carga de trabajo se resuelven con el mismo nombre de miembro y, por lo tanto, comparten el acceso a los recursos de Google Cloud. Esto puede ser útil si varios clústeres contienen las mismas identidades, pero peligroso si los nombres de cuentas de servicio y espacios de nombres de Kubernetes no se administran con cuidado.

Por ejemplo, si se habilita Workload Identity en el clúster, el siguiente comando otorga el mismo acceso a todas las cargas de trabajo de Kubernetes en cualquier clúster del proyecto que use la cuenta de servicio y el espacio de nombres predeterminados:

gcloud iam service-accounts add-iam-policy-binding \
  --role roles/iam.workloadIdentityUser \
  --member "serviceAccount:project-id.svc.id.goog[default/default]" \
  gsa-name@project-id.iam.gserviceaccount.com

Limitaciones

  • Actualmente, solo hay un grupo de identidades de carga de trabajo fijo por proyecto de Google Cloud, project-id.svc.id.goog, y se crea de forma automática para ti.

  • Por el momento, Workload Identity no es compatible cuando una carga de trabajo se ejecuta en un clúster de GKE On-Prem.

  • Workload Identity reemplaza la necesidad de usar ocultamiento de metadatos y, por lo tanto, los dos enfoques son incompatibles. Workload Identity también protege los metadatos sensibles protegidos con la ocultación de metadatos.

  • Cuando el servidor de metadatos de GKE se habilita en un grupo de nodos, los Pods ya no podrán acceder al servidor de metadatos de Compute Engine. En su lugar, la solicitud realizada desde estos Pods a las API de metadatos se enrutará al servidor de metadatos de GKE. La única excepción son los Pods que se ejecutan en la red del host (consulta el siguiente elemento).

  • No se puede usar Workload Identity en los Pods que se ejecutan en la red del host. Las solicitudes realizadas desde estos Pods a las API de metadatos se enrutarán al servidor de metadatos de Compute Engine.

  • El servidor de metadatos de GKE toma unos segundos en comenzar a ejecutarse en un Pod recién creado. Por lo tanto, pueden fallar los intentos de autenticación o autorización mediante Workload Identity que se realicen durante los primeros segundos de la vida útil de un Pod. Volver a intentar la llamada resolverá el problema.

  • Los agentes de supervisión y registro de GKE seguirán usando la cuenta de servicio del nodo.

  • Workload Identity no es compatible con los nodos de Windows.

  • Workload Identity requiere una configuración manual para Cloud Run for Anthos en Google Cloud a fin de continuar lanzando métricas de solicitudes.

  • Workload Identity instala ip-masq-agent si el clúster se crea sin la marca --disable-default-snat.

Antes de comenzar

Antes de comenzar, asegúrate de haber realizado las siguientes tareas:

Establece la configuración de gcloud predeterminada mediante uno de los siguientes métodos:

  • Usa gcloud init si deseas ver una explicación sobre cómo configurar parámetros predeterminados.
  • Usa gcloud config para establecer el ID, la zona y la región del proyecto de manera individual.

Usa gcloud init

Si recibes el error One of [--zone, --region] must be supplied: Please specify location, completa esta sección.

  1. Ejecuta gcloud init y sigue las instrucciones:

    gcloud init

    Si usas SSH en un servidor remoto, usa la marca --console-only para evitar que el comando abra un navegador:

    gcloud init --console-only
  2. Sigue las instrucciones a fin de autorizar a gcloud para que use tu cuenta de Google Cloud.
  3. Crea una configuración nueva o selecciona una existente.
  4. Elige un proyecto de Google Cloud.
  5. Elige una zona predeterminada de Compute Engine.

Usa gcloud config

  • Establece tu ID del proyecto predeterminado:
    gcloud config set project project-id
  • Si trabajas con clústeres zonales, establece tu zona de procesamiento predeterminada:
    gcloud config set compute/zone compute-zone
  • Si trabajas con clústeres regionales, establece tu región de procesamiento predeterminada:
    gcloud config set compute/region compute-region
  • Actualiza gcloud a la versión más reciente:
    gcloud components update

Habilita Workload Identity en un clúster

Puedes habilitar Workload Identity en un clúster nuevo o existente con la herramienta de gcloud.

  1. Asegúrate de que habilitaste la API de credenciales de la cuenta de servicio de IAM.

    Habilitar la API de credenciales de IAM

  2. Para crear un clúster nuevo con Workload Identity habilitado, usa el siguiente comando:

    gcloud container clusters create cluster-name \
      --workload-pool=project-id.svc.id.goog
    

    Reemplaza los siguientes elementos:

    • cluster-name: Es el nombre de tu clúster.
    • project-id: El ID del proyecto de Google Cloud.

    Esta acción requiere el permiso container.clusters.create en el proyecto.

  3. Para habilitar Workload Identity en un clúster existente, modifica el clúster con el siguiente comando:

    gcloud container clusters update cluster-name \
      --workload-pool=project-id.svc.id.goog
    

    Los grupos de nodos existentes no se ven afectados; los grupos de nodos nuevos se establecen de forma predeterminada como --workload-metadata=GKE_METADATA.

    Esta acción requiere permisos container.clusters.update en el clúster.

Migra aplicaciones a Workload Identity

Selecciona la estrategia de migración ideal para tu entorno. Los grupos de nodos se pueden migrar en el lugar o puedes crear grupos de nodos nuevos con Workload Identity habilitada. Te recomendamos crear grupos de nodos nuevos si también necesitas modificar la aplicación para que sea compatible con esta característica.

Agrega un grupo de nodos nuevo al clúster con Workload Identity habilitado y migra cargas de trabajo a ese grupo de forma manual. Esto tiene éxito solo si Workload Identity está habilitada en el clúster.

gcloud container node-pools create nodepool-name \
  --cluster=cluster-name \
  --workload-metadata=GKE_METADATA

Si un clúster tiene Workload Identity habilitada, puedes inhabilitarla de forma selectiva en un grupo de nodos en particular si especificas --workload-metadata=GCE_METADATA explícitamente. Para obtener más información, consulta Protege metadatos del clúster.

Opción 2: modificación del grupo de nodos

Modifica un grupo de nodos existente para habilitar GKE_METADATA. Esta actualización tiene éxito solo si Workload Identity está habilitada en el clúster. Habilita de inmediato Workload Identity para las cargas de trabajo implementadas en el grupo de nodos. Este cambio evitará que las cargas de trabajo usen la cuenta de servicio de Compute Engine y se debe implementar con mucho cuidado.

gcloud container node-pools update nodepool-name \
  --cluster=cluster-name \
  --workload-metadata=GKE_METADATA

Esta acción requiere permisos container.nodes.update en el proyecto.

Autentica en Google Cloud

En esta sección, se explica cómo una aplicación puede autenticarse en Google Cloud mediante Workload Identity. A fin de hacer esto, asigna una cuenta de servicio de Kubernetes a la aplicación y configúrala para que actúe como una cuenta de servicio de Google:

  1. Configura kubectl para comunicarse con el clúster:

    gcloud container clusters get-credentials cluster-name
    

    Reemplaza cluster-name por el nombre del clúster que creaste en el paso anterior.

    Esta acción requiere el permiso container.clusters.get en el proyecto.

  2. Como la mayoría de los otros recursos, las cuentas de servicio de Kubernetes se alojan en un espacio de nombres. Crea el espacio de nombres para usar en la cuenta de servicio de Kubernetes.

    kubectl create namespace k8s-namespace
    

    Esta acción requiere crear el permiso RBAC de espacio de nombres dentro del clúster.

  3. Crea la cuenta de servicio de Kubernetes para usar en la aplicación:

    kubectl create serviceaccount --namespace k8s-namespace ksa-name
    

    Reemplaza los siguientes elementos:

    • k8s-namespace: El nombre del espacio de nombres de Kubernetes que creaste en el paso anterior.
    • ksa-name: El nombre que deseas usar para la cuenta de servicio de Kubernetes.

    Para esta acción, se requiere crear el permiso RBAC de cuentas de servicio dentro del espacio de nombres.

    Como alternativa, puedes usar el espacio de nombres predeterminado o la cuenta de servicio predeterminada de Kubernetes en cualquier espacio de nombres.

  4. Crea una cuenta de servicio de Google para la aplicación. Si tienes una cuenta de servicio existente, puedes usarla en lugar de crear una nueva. No es necesario que la cuenta de servicio esté en el mismo proyecto que el clúster. Puedes usar cualquier cuenta de servicio de Google en la organización.

    gcloud

    Reemplaza gsa-name por el nombre que elijas para la cuenta de servicio.

    gcloud iam service-accounts create gsa-name
    

    Config Connector

    Si ya instalaste Config Connector en un clúster, puedes crear un clúster de GKE nuevo con Workload Identity habilitada mediante una configuración de Config Connector.

    Nota: En este paso, se necesita Config Connector. Sigue las instrucciones de instalación para instalar Config Connector en el clúster.

    apiVersion: iam.cnrm.cloud.google.com/v1beta1
    kind: IAMServiceAccount
    metadata:
      name: [GSA_NAME]
    spec:
      displayName: [GSA_NAME]
    Para implementar este manifiesto, descárgalo en tu equipo como service-account.yaml. Reemplaza gsa-name por el nombre que elijas para la cuenta de servicio. Luego, usa kubectl para aplicar el manifiesto.

    kubectl apply -f service-account.yaml

    Esta acción requiere el permiso iam.serviceAccounts.create en el proyecto.

    Para obtener información sobre la autorización de cuentas de servicio de Google a fin de acceder a las API de Google Cloud, consulta la página Comprende las cuentas de servicio.

  5. Para permitir que la cuenta de servicio de Kubernetes actúe en nombre de la cuenta de servicio de Google, crea una vinculación de política de IAM entre las dos. Esta vinculación permite que la cuenta de servicio de Kubernetes actúe como la cuenta de servicio de Google.

    gcloud

    gcloud iam service-accounts add-iam-policy-binding \
      --role roles/iam.workloadIdentityUser \
      --member "serviceAccount:project-id.svc.id.goog[k8s-namespace/ksa-name]" \
      gsa-name@project-id.iam.gserviceaccount.com
    

    Config Connector

    Nota: En este paso, se necesita Config Connector. Sigue las instrucciones de instalación para instalar Config Connector en el clúster.

    apiVersion: iam.cnrm.cloud.google.com/v1beta1
    kind: IAMPolicy
    metadata:
      name: iampolicy-workload-identity-sample
    spec:
      resourceRef:
        apiVersion: iam.cnrm.cloud.google.com/v1beta1
        kind: IAMServiceAccount
        name: [GSA_NAME]
      bindings:
        - role: roles/iam.workloadIdentityUser
          members:
            - serviceAccount:[PROJECT_ID].svc.id.goog[[K8S_NAMESPACE]/[KSA_NAME]]
    Para implementar este manifiesto, descárgalo en tu equipo como policy-binding.yaml. Reemplaza gsa-name, project-id, k8s-namespace y ksa-name por los valores para tu entorno. Luego, ejecuta lo siguiente:

    kubectl apply -f policy-binding.yaml

    Esta acción requiere el permiso iam.serviceAccounts.setIamPolicy en el proyecto.

  6. Agrega la anotación iam.gke.io/gcp-service-account=gsa-name@project-id a la cuenta de servicio de Kubernetes mediante la dirección de correo electrónico de la cuenta de servicio de Google.

    kubectl

    kubectl annotate serviceaccount \
      --namespace k8s-namespace \
      ksa-name \
      iam.gke.io/gcp-service-account=gsa-name@project-id.iam.gserviceaccount.com
    

    yaml

    apiVersion: v1
    kind: ServiceAccount
    metadata:
      annotations:
        iam.gke.io/gcp-service-account: gsa-name@project-id.iam.gserviceaccount.com
      name: ksa-name
      namespace: k8s-namespace
    

    Para esta acción, se necesitan permisos RBAC de edición en la cuenta de servicio de Kubernetes.

  7. Para verificar que las cuentas de servicio estén configuradas de forma correcta, crea un Pod con la cuenta de servicio de Kubernetes que ejecute la imagen del contenedor cloud-sdk y conéctate a ella con una sesión interactiva.

    kubectl

    kubectl run -it \
      --image google/cloud-sdk:slim \
      --serviceaccount ksa-name \
      --namespace k8s-namespace \
      workload-identity-test
    

    yaml

    apiVersion: v1
    kind: Pod
    metadata:
      name: workload-identity-test
      namespace: k8s-namespace
    spec:
      containers:
      - image: google/cloud-sdk:slim
        name: workload-identity-test
        command: ["sleep","infinity"]
      serviceAccountName: ksa-name
    

    La imagen google/cloud-sdk incluye la herramienta de línea de comandos de gcloud, que es una manera conveniente de usar las API de Google Cloud. La descarga de la imagen puede tomar un tiempo.

    Esta acción requiere crear permisos RBAC de Pods dentro del espacio de nombres.

    Ahora estás conectado a un shell interactivo dentro del Pod creado. Ejecuta el siguiente comando dentro del Pod:

    gcloud auth list
    

    Si las cuentas de servicio están configuradas de forma correcta, la dirección de correo electrónico de la cuenta de servicio de Google aparece como la identidad activa (y única). Esto demuestra que, de forma predeterminada, el Pod usa la autoridad de la cuenta de servicio de Google cuando llama a las API de Google Cloud.

Usa Workload Identity desde el código

La autenticación en los servicios de Google Cloud desde tu código es el mismo proceso que la autenticación mediante el servidor de metadatos de Compute Engine. Cuando usas Workload Identity, las solicitudes al servidor de metadatos de la instancia se enrutan al servidor de metadatos de GKE. El código existente que se autentica mediante el servidor de metadatos de la instancia (como el código que usa las bibliotecas cliente de Google Cloud) debería funcionar sin modificaciones.

Comprende el servidor de metadatos de GKE

El servidor de metadatos de GKE es un servidor de metadatos nuevo diseñado para usarse con Kubernetes. Se ejecuta como un daemonset, con un Pod en cada nodo del clúster. El servidor de metadatos intercepta las solicitudes HTTP a http://metadata.google.internal (169.254.169.254:80), incluidas las solicitudes como GET /computeMetadata/v1/instance/service-accounts/default/token con el fin de recuperar un token para la cuenta de servicio de Google que el Pod está configurado para suplantar. El tráfico del servidor de metadatos nunca sale de la instancia de VM que aloja al Pod.

El servidor de metadatos de GKE solo implementa un subconjunto de extremos del servidor de metadatos de Compute Engine que son relevantes y seguros para las cargas de trabajo de Kubernetes:

  • /computeMetadata/v1/instance/attributes/cluster-location
  • /computeMetadata/v1/instance/attributes/cluster-name
  • /computeMetadata/v1/instance/attributes/cluster-uid
  • /computeMetadata/v1/instance/hostname
  • /computeMetadata/v1/instance/id
  • /computeMetadata/v1/project/numeric-project-id
  • /computeMetadata/v1/project/project-id
  • /computeMetadata/v1/instance/service-accounts
  • /computeMetadata/v1/instance/service-accounts/default
  • /computeMetadata/v1/instance/service-accounts/default/aliases
  • /computeMetadata/v1/instance/service-accounts/default/email
  • /computeMetadata/v1/instance/service-accounts/default/identity
  • /computeMetadata/v1/instance/service-accounts/default/identity?audience=audience
  • /computeMetadata/v1/instance/service-accounts/default/scopes
  • /computeMetadata/v1/instance/service-accounts/default/token
  • /computeMetadata/v1/instance/service-accounts/default/token?scopes=comma-separated-list-of-scopes

Revoca el acceso

  1. Revoca el acceso a la cuenta de servicio de Google mediante IAM:

    gcloud

    gcloud iam service-accounts remove-iam-policy-binding \
      --role roles/iam.workloadIdentityUser \
      --member "serviceAccount:project-id.svc.id.goog[k8s-namespace/ksa-name]" \
      gsa-name@gsa-project-id.iam.gserviceaccount.com
    

    Reemplaza los siguientes elementos:

    • project-id: El contenedor del ID del proyecto del clúster de GKE.
    • k8s-namespace: El nombre del espacio de nombres de Kubernetes en el que se encuentra la cuenta de servicio de Kubernetes.
    • ksa-name: El nombre de la cuenta de servicio de Kubernetes a la que se le revocará el acceso.
    • gsa-name: El nombre de la cuenta de servicio de Google.
    • gsa-project-id: El ID del proyecto que contiene la cuenta de servicio de Google.

    Config Connector

    Si usaste Config Connector para crear la cuenta de servicio, borra la cuenta de servicio con kubectl.

    kubectl delete -f service-account.yaml
    

    Esta acción requiere permisos iam.serviceAccounts.setIamPolicy en la cuenta de servicio.

    Los tokens almacenados en caché pueden tardar hasta 30 minutos en caducar. Puedes verificar si los tokens almacenados en caché caducaron con el siguiente comando:

    gcloud auth list
    

    Los tokens almacenados en caché caducaron si la salida de ese comando ya no incluye gsa-name@project-id.iam.gserviceaccount.com.

  2. Quita la anotación de la cuenta de servicio de Kubernetes. Este paso es opcional porque IAM revocó el acceso.

    kubectl annotate serviceaccount \
      --namespace k8s-namespace \
      ksa-name \
      iam.gke.io/gcp-service-account-
    

Soluciona problemas

Si la aplicación no puede autenticarse en Google Cloud, asegúrate de que estas opciones estén configuradas de forma correcta:

  1. Asegúrate de tener habilitada la API de credenciales de la cuenta de servicio de IAM en el proyecto que contiene el clúster de GKE.

    Habilitar la API de credenciales de IAM

  2. Asegúrate de que Workload Identity esté habilitado en el clúster mediante la verificación de que tiene un grupo de identidades de cargas de trabajo configurado:

    gcloud container clusters describe cluster-name \
      --format="value(workloadIdentityConfig.workloadPool)"
    
  3. Asegúrate de que el servidor de metadatos de GKE (GKE_METADATA) esté configurado en el grupo de nodos en el que se ejecuta la aplicación:

    gcloud container node-pools describe node-pool-name \
      --cluster=cluster-name \
      --format="value(config.workloadMetadataConfig.mode)"
    
  4. Asegúrate de que la cuenta de servicio de Kubernetes esté anotada de forma correcta

    kubectl describe serviceaccount \
      --namespace k8s-namespace \
      ksa-name
    

    Debería haber una anotación en el siguiente formato:

    iam.gke.io/gcp-service-account: gsa-name@project-id.iam.gserviceaccount.com
    
  5. Asegúrate de que la cuenta de servicio de Google esté configurada de forma correcta

    gcloud iam service-accounts get-iam-policy \
      gsa-name@project-id.iam.gserviceaccount.com
    

    Verifica que haya una vinculación con el siguiente formato:

    - members:
      - serviceAccount:project-id.svc.id.goog[k8s-namespace/ksa-name]
      role: roles/iam.workloadIdentityUser
    
  6. Si tienes una política de red del clúster, asegúrate de que se permita la salida a 127.0.0.1/32 en el puerto 988:

    kubectl describe networkpolicy network-policy-name
    

Inhabilita Workload Identity en un clúster

  1. Inhabilita Workload Identity en cada grupo de nodos:

    gcloud container node-pools update nodepool-name \
      --cluster=cluster-name \
      --workload-metadata=GCE_METADATA
    

    Repite este comando para cada grupo de nodos del clúster.

  2. Inhabilita Workload Identity en el clúster:

    gcloud container clusters update cluster-name \
      --disable-workload-identity
    

    Esta acción requiere permisos container.clusters.update en el clúster.

Inhabilita Workload Identity en la organización

Desde la perspectiva de seguridad, Workload Identity permite que GKE confirme las identidades de las cuentas de servicio de Kubernetes que se pueden autenticar y autorizar en los recursos de Google Cloud. Los administradores que realizaron acciones con el fin de aislar las cargas de trabajo de los recursos de Google Cloud, como inhabilitar la creación de cuentas de servicio o inhabilitar la creación de claves de cuentas de servicio, también podrían querer inhabilitar Workload Identity en la organización.

Consulta estas instrucciones para inhabilitar Workload Identity en la organización.

Alternativas a Workload Identity

Hay dos métodos alternativos para acceder a las API de Cloud desde GKE. Con el lanzamiento de Workload Identity, ya no recomendamos estos enfoques debido a los compromisos que requieren.

  1. Exporta claves de cuenta de servicio y almacénalas como secretos de Kubernetes. Las claves de las cuentas de servicio de Google vencen después de 10 años y se rotan manualmente. Exportar claves de cuentas de servicio tiene el potencial de expandir el alcance de un incumplimiento de las normas de seguridad si no se detecta.

  2. Usa la cuenta de servicio de Compute Engine de tus nodos. Puedes ejecutar grupos de nodos como cualquier cuenta de servicio de IAM en tu proyecto. Si no especificas una cuenta de servicio durante la creación del grupo de nodos, GKE usará la cuenta de servicio predeterminada de Compute Engine del proyecto. Todas las cargas de trabajo implementadas en ese nodo comparten la cuenta de servicio de Compute Engine. Esto puede generar un exceso de aprovisionamiento de permisos.

Próximos pasos