このページでは、Google Kubernetes Engine（GKE）クラスタに対して認証を行うように外部 ID プロバイダを構成する方法について説明します。
概要
GKE 用 Identity Service は、既存の ID ソリューションを GKE クラスタに拡張します。OpenID Connect（OIDC）のサポートにより、組織内のユーザー アカウントの作成、有効化、無効化の標準的な手順で Kubernetes クラスタへのアクセスを管理できます。GKE 用 Identity Service は OIDC ID プロバイダに限定されています。
始める前に
このトピックでは、次の認証と OpenID のコンセプトを理解していることを前提としています。
ヘッドレス システムはサポートされていません。ブラウザベースの認証フローが使用されて、プロンプトで同意が求められ、ユーザー アカウントを承認します。
作業を始める前に、次のことを確認してください。
- Google Kubernetes Engine API を有効にします。 Google Kubernetes Engine API の有効化
- このタスクに Google Cloud CLI を使用する場合は、gcloud CLI をインストールして初期化します。
GKE 用 Identity Service を使用するユーザー
このドキュメントのタスクは、次のいずれかに該当する方を対象としています。
クラスタ管理者: 1 つ以上のユーザー クラスタを作成し、クラスタを使用する開発者用の認証構成ファイルを作成します。
デベロッパー: 1 つ以上のクラスタでワークロードを実行し、OIDC を使用して認証します。
仕組み
GKE クラスタで GKE 用 Identity Service を設定して使用するには、クラスタ管理者が次の手順を行います。
クラスタ管理者が GKE 用 Identity Service を構成すると、デベロッパーはクラスタにログインして認証できるようになります。
クラスタで GKE 用 Identity Service を有効にする
このセクションは、クラスタ管理者を対象としています。
デフォルトでは、Identity and Access Management（IAM）がクラスタ認証の ID プロバイダとして構成されます。サードパーティの ID プロバイダで OIDC を使用する場合は、Google Cloud CLI を使用して新規または既存のクラスタで GKE 用 Identity Service を有効にできます。
新しいクラスタで GKE 用 Identity Service を有効にする
GKE 用 Identity Service が有効になったクラスタを作成するには、次のコマンドを実行します。
gcloud container clusters create CLUSTER_NAME \
--enable-identity-service
CLUSTER_NAME は、使用するクラスタの名前に置き換えます。
既存のクラスタで GKE 用 Identity Service を有効にする
既存のクラスタで GKE 用 Identity Service を有効にするには、次のコマンドを実行します。
gcloud container clusters update CLUSTER_NAME \
--enable-identity-service
CLUSTER_NAME は、使用するクラスタの名前に置き換えます。
GKE 用 Identity Service によって作成された Kubernetes オブジェクト
次の表は、クラスタで GKE 用 Identity Service を有効にするときに作成される Kubernetes オブジェクトを示したものです。
| Kubernetes オブジェクト | |
|---|---|
anthos-identity-service |
NamespaceGKE 用 Identity Service のデプロイに使用されます。 |
kube-public |
Namespacedefaultクライアント構成ファイルに使用されます。 |
gke-oidc-envoy |
LoadBalancerOIDC リクエストのエンドポイント。デフォルトは External です。限定公開クラスタまたは厳格なネットワーク ポリシーを持つクラスタで作成された場合、エンドポイントはクラスタの Virtual Private Cloud の内部になります。 anthos-identity-service 名前空間に作成されます。 |
gke-oidc-service |
ClusterIPgke-oidc-envoy Deployment と gke-oidc-service Deployment との間の通信を容易にします。anthos-identity-service 名前空間に作成されます。 |
gke-oidc-envoy |
Deploymentgke-oidc-envoy LoadBalancer に公開されたプロキシを実行します。gke-oidc-service と通信して ID トークンを検証します。Kubernetes API サーバーのプロキシとして機能し、API サーバーにリクエストを渡すときにユーザーになりすまします。anthos-identity-service 名前空間に作成されます。 |
gke-oidc-service |
DeploymentID トークンを検証し、 ClientConfig リソース用の検証用アドミッション Webhook を提供します。anthos-identity-service 名前空間に作成されます。 |
gke-oidc-operator |
Deploymentクライアント構成と gke-oidc-envoy LoadBalancer を調整します。anthos-identity-service 名前空間に作成されます。 |
gke-oidc-certs |
SecretLoadBalancer 用のクラスタ認証局（CA）と TLS 証明書が含まれています。 anthos-identity-service 名前空間に作成されます。 |
default |
ClientConfig CRD推奨される認証方法、ID プロバイダの構成、ユーザーとグループのクレームのマッピングなどの OIDC パラメータが含まれています。ID トークンの検証に使用されます。クラスタ管理者がデベロッパーに配布する前に OIDC 設定を構成するために使用します。 kube-public 名前空間に作成されます。 |
GKE 用 Identity Service を構成する
このセクションは、クラスタ管理者を対象としています。
default ClientConfig をダウンロードして変更することで、GKE 用 Identity Service を構成できます。
defaultClientConfig をダウンロードします。kubectl get clientconfig default -n kube-public -o yaml > client-config.yaml使用したい設定で
spec.authenticationセクションを更新します。apiVersion: authentication.gke.io/v2alpha1 kind: ClientConfig metadata: name: default namespace: kube-public spec: name: cluster-name server: https://192.168.0.1:6443 authentication: - name: oidc oidc: clientID: CLIENT_ID certificateAuthorityData: OIDC_PROVIDER_CERTIFICATE extraParams: EXTRA_PARAMS issuerURI: ISSUER_URI cloudConsoleRedirectURI: https://console.cloud.google.com/kubernetes/oidc kubectlRedirectURI: KUBECTL_REDIRECT_URL scopes: SCOPES userClaim: USER groupsClaim: GROUPS userPrefix: USER_PREFIX groupPrefix: GROUP_PREFIX次のように置き換えます。
CLIENT_ID: OIDC プロバイダへの認証リクエストを行うクライアント アプリケーションの ID。OIDC_PROVIDER_CERTIFICATE:（省略可）OIDC プロバイダの PEM 証明書。OIDC プロバイダが自己署名証明書を使用する場合、このフィールドが役立つことがあります。GKE 用 Identity Service には、デフォルトで一連の公開ルートが含まれています。EXTRA_PARAMS: OIDC プロバイダに送信する追加の Key-Value パラメータ。- グループを承認するには、
resource=token-groups-claimを使用します。 - Microsoft Azure と Okta を認証するには、
prompt=consentを使用します。 - Cloud Identity の場合は、
prompt=consent,access_type=offlineを使用します。
- グループを承認するには、
ISSUER_URI: OIDC 認可リクエストを送信する URL（たとえば、https://example.com/adfs）。Kubernetes API サーバーは、この URL を使用してトークン検証用の公開鍵を検出します。URI には HTTPS を使用する必要があります。 Cloud Identity の場合は、https://accounts.google.comを使用します。KUBECTL_REDIRECT_URL:kubectl oidc loginが認証に使用するリダイレクト URL。通常は、http://localhost:PORT/callbackという形式です。ここで、PORTはデベロッパー ワークステーションで使用可能な1024を超えるポートです（例:http://localhost:10000/callback）。クライアント アプリケーションの承認済みリダイレクト URL として、OIDC プロバイダに URL を登録する必要があります。Google Identity を OIDC プロバイダとして使用する場合は、リダイレクト URI の設定をご覧ください。SCOPES: OIDC プロバイダに送信する追加のスコープ。- Microsoft Azure と Okta には
offline_accessスコープが必要です。 - Cloud Identity の場合は、
openid, emailを使用して、emailクレームにメールアドレスを含む ID トークンを取得します。
- Microsoft Azure と Okta には
USER: ID トークンからのユーザー クレーム。GROUPS: ID トークンからのグループ クレーム。USER_PREFIX: 既存の名前と競合しないように、ユーザー クレームの先頭に付加される接頭辞。デフォルトでは、発行元の接頭辞が Kubernetes API サーバーに渡されたuserIDに追加されます（ユーザー クレームがemailの場合を除く）。生成されるユーザー ID はISSUER_URI#USERです。接頭辞を使用することをおすすめしますが、USER_PREFIXを-に設定することで接頭辞を無効にすることもできます。GROUP_PREFIX: 既存の名前と競合しないように、グループ クレームの先頭に付加される接頭辞。たとえば、foobarという名前の 2 つのグループがある場合、接頭辞gid-を追加します。結果のグループはgid-foobarです。
更新された構成を適用します。
kubectl apply -f client-config.yamlこの構成を適用すると、GKE 用 Identity Service がクラスタ内で実行され、
gke-oidc-envoyロードバランサの背後でリクエストを処理します。spec.serverフィールドの IP アドレスは、ロードバランサの IP アドレスである必要があります。spec.serverフィールドを変更すると、kubectlコマンドが失敗する可能性があります。client-config.yaml構成ファイルのコピーを作成します。cp client-config.yaml login-config.yamlspec.authentication.oidcセクションのclientSecret設定でlogin-config.yaml構成ファイルを更新します。clientSecret: CLIENT_SECRETCLIENT_SECRETは、OIDC クライアント アプリケーションと OIDC プロバイダの間での共有シークレットに置き換えます。更新した
login-config.yamlファイルをデベロッパーに配布します。
厳格なポリシーを持つクラスタで GKE 用 Identity Service を構成する
限定公開クラスタなど、厳格なネットワーク ポリシーが設定されているクラスタで想定どおりに動作するように GKE 用 Identity Service を構成するには、次の手順を行います。
- TCP ポート
15000にファイアウォール ルールを追加して、コントロール プレーンがClientConfig検証 Webhook と通信できるようにします。 gke-oidc-envoyが内部ロードバランサとして作成されている場合は、VPC で公開します。- クラスタ内のトラフィックを拒否するポリシーが存在する場合は、TCP ポート
8443にファイアウォール ルールを追加して、gke-oidc-envoyDeployment がgke-oidc-serviceDeployment と通信できるようにします。
GKE コンポーネントの Identity Service バージョン 0.2.20 以降では、TCP ポート 15000 を使用しません。コンポーネントのバージョンが 0.2.20 以降の場合、ポート 15000 にファイアウォール ルールを追加する必要はありません。コンポーネントのバージョンを確認するには、次のコマンドを実行します。
kubectl describe deployment gke-oidc-envoy -n anthos-identity-service \
| grep "components.gke.io/component-name: gke-oidc" -A1
ロードバランサにカスタム プロパティを追加する
GKE 用 Identity Service を構成すると、静的 IP アドレスなどのカスタム アノテーションとプロパティを gke-oidc-envoy ロードバランサに追加できます。gke-oidc-envoy Service を編集するには、次のコマンドを実行します。
kubectl edit service gke-oidc-envoy -n anthos-identity-service
GKE の TCP/UDP 負荷分散を構成する方法をドキュメントで確認する。
クラスタの RBAC ポリシーを作成する
このセクションは、クラスタ管理者を対象としています。
管理者は Kubernetes ロールベースのアクセス制御（RBAC）を使用して、認証済みクラスタ ユーザーにアクセスを許可します。クラスタに RBAC を構成するには、各デベロッパーに RBAC ロールを付与する必要があります。特定の Namespace のリソースへのアクセスを許可するには、Role と RoleBinding を作成します。クラスタ全体のリソースへのアクセスを許可するには、ClusterRole と ClusterRoleBinding を作成します。
たとえば、クラスタ全体のすべての Secret オブジェクトを表示する必要があるユーザーについて考えてみましょう。次の手順では、必要な RBAC ロールをこのユーザーに付与します。
次の ClusterRole マニフェストを
secret-viewer-cluster-role.yamlとして保存します。このロールを付与されたユーザーは、クラスタ内の Secret に対して get、watch、list オペレーションを行えます。apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: secret-viewer rules: - apiGroups: [""] # The resource type for which access is granted resources: ["secrets"] # The permissions granted by the ClusterRole verbs: ["get", "watch", "list"]ClusterRole マニフェストを適用します。
kubectl apply -f secret-viewer-cluster-role.yaml次の ClusterRoleBinding マニフェストを
secret-viewer-cluster-role-binding.yamlとして保存します。このバインディングでは、クライアント構成ファイルで定義されているユーザー名にsecret-viewerロールを付与します。apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: people-who-view-secrets subjects: - kind: User name: ISSUER_URI#USER apiGroup: rbac.authorization.k8s.io roleRef: kind: ClusterRole name: secret-viewer apiGroup: rbac.authorization.k8s.io次のように置き換えます。
ISSUER_URI: クライアント構成ファイルのspec.authentication.oidc.issuerURIにある発行者 URI。USER: クライアント構成ファイルのspec.authentication.oidc.userClaimで構成されたクレーム名の下のトークンのユーザー ID。
ClusterRoleBinding マニフェストを適用します。
kubectl apply -f secret-viewer-cluster-role-binding.yaml
クラスタにログインして認証する
このセクションは開発者を対象としています。
管理者から OIDC 構成ファイルを受け取ったら、クラスタに対する認証が行えます。
管理者から提供された
login-config.yamlファイルをダウンロードします。個別の OIDC コンポーネントを提供する Google Cloud CLI SDK をインストールします。これをインストールするには、次のコマンドを実行します。
gcloud components install kubectl-oidcクラスタに対して認証を行います。
kubectl oidc login --cluster=CLUSTER_NAME --login-config=login-config.yamlウェブブラウザが開き、認証プロセスが完了します。
認証されたら、次のような
kubectlコマンドを実行できます。kubectl get pods
GKE 用 Identity Service を無効にする
このセクションは、クラスタ管理者を対象としています。
gcloud CLI を使用して、GKE 用 Identity Service を無効にできます。GKE 用 Identity Service を無効にするには、次のコマンドを実行します。
gcloud container clusters update CLUSTER_NAME \
--no-enable-identity-service
次のステップ
- ワークロードのデプロイの詳細を確認する。
- OpenID Connect の詳細を確認する。
- スコープとクレームについて詳細を確認する。