This page explains how to create Cloud Identity and Access Management (Cloud IAM) policies for authorization in Google Kubernetes Engine.
Every Google Cloud, GKE, and Kubernetes API call requires that the account making the request has the necessary permissions. By default, no one except you can access your project or its resources. You can use Cloud IAM to manage who can access your project and what they are allowed to do. Cloud IAM permissions work alongside Kubernetes RBAC, which provides granular access controls for specific objects in a cluster or Namespace. Cloud IAM has a stronger focus on permissions at the level of the Google Cloud project and organization, though it does provide several pre-defined roles specific to GKE.
To grant users and service accounts access to your Google Cloud project, you add them as project team members, then assign roles to the team members. Roles define which Google Cloud resources an account can access and which operations they can perform.
In GKE, you can use Cloud IAM to manage which users and service accounts can access, and perform operations in, your clusters.
Before you begin
Before you start, make sure you have performed the following tasks:
- Ensure that you have enabled the Google Kubernetes Engine API. Enable Google Kubernetes Engine API
- Ensure that you have installed the Cloud SDK.
Set up default
gcloud settings using one of the following methods:
gcloud init, if you want to be walked through setting defaults.
gcloud config, to individually set your project ID, zone, and region.
Using gcloud init
gcloud initand follow the directions:
If you are using SSH on a remote server, use the
--console-onlyflag to prevent the command from launching a browser:
gcloud init --console-only
Follow the instructions to authorize
gcloudto use your Google Cloud account.
- Create a new configuration or select an existing one.
- Choose a Google Cloud project.
- Choose a default Compute Engine zone.
Using gcloud config
- Set your default project ID:
gcloud config set project [PROJECT_ID]
- If you are working with zonal clusters, set your default compute zone:
gcloud config set compute/zone [COMPUTE_ZONE]
- If you are working with regional clusters, set your default compute region:
gcloud config set compute/region [COMPUTE_REGION]
gcloudto the latest version:
gcloud components update
Interaction with Kubernetes RBAC
Kubernetes' native role-based access control (RBAC) system also manages access to your cluster. RBAC controls access on a cluster and namespace level, while Cloud IAM works on the project level.
Cloud IAM and RBAC can work in concert, and an entity must have sufficient permissions at either level to work with resources in your cluster.
Cloud IAM Roles
The following sections describe the Cloud IAM Roles available in Google Cloud.
Predefined GKE Roles
Cloud IAM provides predefined Roles that grant access to specific Google Cloud resources and prevent unauthorized access to other resources.
Cloud IAM offers the following predefined roles for GKE:
||Kubernetes Engine Admin||Provides access to full management of Container Clusters and their Kubernetes API objects.||Project|
||Kubernetes Engine Cluster Admin||Provides access to management of Container Clusters.||Project|
||Kubernetes Engine Cluster Viewer||Read-only access to Kubernetes Clusters.|
||Kubernetes Engine Developer||Provides full access to Kubernetes API objects inside Container Clusters.||Project|
||Kubernetes Engine Host Service Agent User||Use access of the Kubernetes Engine Host Service Agent.|
||Kubernetes Engine Viewer||Provides read-only access to GKE resources.||Project|
To learn about permissions granted by each Cloud IAM role, refer to Permissions granted by Cloud IAM roles.
Primitive Cloud IAM roles
Primitive Cloud IAM roles grant users global, project-level access to all Google Cloud resources. To keep your project and clusters secure, use predefined Roles whenever possible.
To learn more about primitive roles, refer to Primitive roles in the Cloud IAM documentation.
Service Account User role
Service Account User grants a Google Cloud user account the permission to perform actions as though a service account were performing them.
iam.serviceAccountUserrole to a user for a project gives the user all of the roles granted to all service accounts in the project, including service accounts that may be created in the future.
iam.serviceAccountUserrole to a user for a specific service account gives a user all of the roles granted to that service account.
This role includes the following permissions:
For more information about the ServiceAccountUser role, see ServiceAccountUser in the Cloud IAM documentation.
The following command shows the syntax for granting the Service Account User role:
gcloud iam service-accounts add-iam-policy-binding \ [SA_NAME]@[PROJECT_ID].iam.gserviceaccount.com \ --member=user:[USER] \ --role=roles/iam.serviceAccountUser
Host Service Agent User role
The Host Service Agent User role is only used in Shared VPC clusters. This role includes the following permissions:
To learn how to create and assign custom roles, refer to Creating and managing custom roles.
Viewing permissions granted by Cloud IAM roles
You can view the permissions granted by each Role using the
command-line tool or Cloud Console.
To view the permissions granted by a specific role, run the following
[ROLE] is any Cloud IAM role.
GKE roles are prefixed with
gcloud iam roles describe roles/[ROLE]
gcloud iam roles describe roles/container.admin
To view the permissions granted by a specific Role, perform the following steps:
Visit the Roles section of Cloud Console's Cloud IAM page.
From the Filter table field, enter "GKE"
Select the desired Role.
Managing Cloud IAM roles
To learn how to manage Cloud IAM roles and permissions for human users, refer to Granting, changing, and revoking access to project members in the Cloud IAM documentation.
For service accounts, refer to Granting roles to service accounts.
Here are a few examples of how Cloud IAM works with GKE:
- A new employee has joined a company. They need to be added to the Google Cloud project, but they only need to view the project's clusters and other Google Cloud resources. The project owner assigns them the project-level Compute Viewer role. This role provides read-only access to get and list nodes, which are Compute Engine resources.
- The employee is working in operations, and they need to update a cluster using
gcloudor Google Cloud Console. This operation requires the
container.clusters.updatepermission, so the project owner assigns them the Kubernetes Engine Cluster Admin role. The employee now has the permissions granted by both the Kubernetes Engine Cluster Admin and Compute Viewer roles.
- The employee needs to investigate why a Deployment is having issues. They
need to run
kubectl get podsto see Pods running in the cluster. The employee already has the Compute Viewer role, which is not sufficient for listing Pods. The employee needs the Kubernetes Engine Viewer role.
- The employee needs to create a new cluster. The project owner grants the
employee the Service Account User role for the
[PROJECT_NUMBER]-firstname.lastname@example.org account, so that the employee's account can access Compute Engine's default service account. This service account has the Editor role, which provides a broad set of permission.