Authentifizierung mit OpenID Connect (OIDC)

Erfahren Sie, wie sie GKE On-Prem konfigurieren, um OpenID Connect (OIDC) zur Authentifizierung bei Nutzerclustern zu verwenden. In diesem Thema wird allgemein gezeigt, wie ein OpenID-Anbieter konfiguriert wird.

Eine Übersicht über den Authentifizierungsablauf in GKE On-Prem finden Sie unter Authentifizierung. In den folgenden Themen erfahren Sie, wie Sie OIDC mit anderen OpenID-Anbietern konfigurieren:

Übersicht

GKE On-Prem unterstützt OIDC als Authentifizierungsmechanismus für die Interaktion mit dem Kubernetes API-Server eines Nutzerclusters. Mit OIDC können Sie den Zugriff auf Kubernetes-Cluster verwalten und die Standardverfahren in Ihrer Organisation zum Erstellen, Aktivieren und Deaktivieren von Nutzerkonten verwenden.

Es gibt zwei Möglichkeiten, Konten zu autorisieren:

  • Sie können den OIDC-Ablauf mit der gcloud-Befehlszeile initiieren. So erhalten Sie die Nutzerautorisierung über eine browserbasierte Zustimmungsseite.

  • Sie initiieren den OIDC-Authentifizierungsvorgang mit der Google Cloud Console.

Hinweis

  • In diesem Thema wird davon ausgegangen, dass Sie mit den folgenden Authentifizierungs- und OpenID-Konzepten vertraut sind:

  • Monitorlose Systeme werden nicht unterstützt. Über einen browserbasierten Authentifizierungsvorgang werden Sie zur Zustimmung aufgefordert, um dann Ihr Nutzerkonto zu autorisieren.

  • Zur Authentifizierung über die Google Cloud Console muss jeder Cluster, den Sie für die OIDC-Authentifizierung konfigurieren möchten, bei Google Cloud registriert sein.

Identitäten

In diesem Thema werden drei Identitäten behandelt:

  • Administrator der Organisation: Wählt einen OpenID-Anbieter aus und registriert Clientanwendungen beim Anbieter.

  • Clusteradministrator: Erstellt einen oder mehrere Nutzercluster und Konfigurationsdateien zur Authentifizierung für Entwickler, die die Cluster verwenden.

  • Entwickler: Führt Arbeitslasten auf einem oder mehreren Clustern aus und verwendet OIDC zur Authentifizierung.

OpenID-Anbieter auswählen

Dieser Abschnitt richtet sich an Organisationsadministratoren.

Sie können einen beliebigen OpenID-Anbieter verwenden. Eine Liste der zertifizierten Anbieter finden Sie unter OpenID-Zertifizierung.

Informationen zu den folgenden OpenID-Anbietern finden Sie in den Konfigurationsschritten der folgenden Themen:

Weiterleitungs-URLs erstellen

Dieser Abschnitt richtet sich an Organisationsadministratoren.

Sie müssen sowohl für die gcloud-Befehlszeile als auch für die Cloud Console Weiterleitungs-URLs erstellen, mit denen der OpenID-Anbieter ID-Tokens zurückgeben kann.

Weiterleitungs-URL für die gcloud-Befehlszeile

Das Cloud SDK enthält die gcloud-Befehlszeile und ist auf dem lokalen Computer jedes Entwicklers installiert. Sie können für die Weiterleitungs-URL eine Portnummer größer als 1024 angeben:

http://localhost:[PORT]/callback

Dabei ist [PORT] Ihre Portnummer.

Wenn Sie Ihren OpenID-Anbieter konfigurieren, geben Sie http://localhost:[PORT]/callback als eine Ihrer Weiterleitungs-URLs an. Wie Sie dies tun, hängt von Ihrem Anbieter ab.

Weiterleitungs-URL für die Cloud Console

Die Weiterleitungs-URL für die Cloud Console lautet:

https://console.cloud.google.com/kubernetes/oidc

Wenn Sie Ihren OIDC-Anbieter konfigurieren, geben Sie https://console.cloud.google.com/kubernetes/oidc als eine Ihrer Weiterleitungs-URLs an. Wie Sie dies tun, hängt von Ihrem Anbieter ab.

Client-Anwendungen beim OpenID-Anbieter registrieren

Dieser Abschnitt richtet sich an Organisationsadministratoren.

Bevor Ihre Entwickler die gcloud-Befehlszeile oder die Cloud Console mit Ihrem OpenID-Anbieter verwenden können, müssen Sie diese beiden Clients beim OpenID-Anbieter registrieren. Die Registrierung umfasst folgende Schritte:

  • Informieren Sie sich über den Aussteller-URI des Anbieters. Hier sendet die gcloud-Befehlszeile oder die Cloud Console Authentifizierungsanfragen.

  • Geben Sie dem Anbieter die Weiterleitungs-URL für die gcloud-Befehlszeile.

  • Geben Sie dem Anbieter die Weiterleitungs-URL für die Cloud Console. Sie lautet https://console.cloud.google.com/kubernetes/oidc.

  • Richten Sie eine einzelne Client-ID ein. Dies ist die ID, mit der der Anbieter die gcloud-Befehlszeile und die Cloud Console identifiziert.

  • Richten Sie einen einzelnen Clientschlüssel ein. Die gcloud-Befehlszeile und die Cloud Console verwenden beide diesen Schlüssel zur Authentifizierung beim OpenID-Anbieter.

  • Richten Sie einen benutzerdefinierten Bereich ein, mit dem die gcloud-Befehlszeile oder die Cloud Console die Sicherheitsgruppen des Nutzers anfordern kann.

  • Legen Sie einen benutzerdefinierten Anforderungsnamen fest, mit dem der Anbieter die Sicherheitsgruppen des Nutzers zurückgibt.

Wie Sie diese Schritte durchführen, hängt von Ihrem OpenID-Anbieter ab.

oidc-Spezifikation in der GKE On-Prem-Konfigurationsdatei festlegen

Dieser Abschnitt richtet sich an Clusteradministratoren.

Generieren Sie, bevor Sie einen Nutzercluster erstellen, erst mit gkectl create-config cluster eine GKE On-Prem-Konfigurationsdatei. Die Konfiguration enthält die folgende oidc-Spezifikation. Sie müssen für oidc die Werte Ihres Anbieters angeben:

oidc:
  issuerURL:
  kubectlRedirectURL:
  clientID:
  clientSecret:
  username:
  usernamePrefix:
  group:
  groupPrefix:
  scopes:
  extraParams:
  deployCloudConsoleProxy:
  caPath:
  • issuerURL: erforderlich. Die URL Ihres OpenID-Anbieters, beispielsweise "https://example.com/adfs". Clientanwendungen wie die gcloud-Befehlszeile und die Cloud Console senden Autorisierungsanfragen an diese URL. Der Kubernetes API-Server nutzt diese URL, um öffentliche Schlüssel zum Verifizieren von Tokens zu ermitteln. Es muss HTTPS verwendet werden.
  • kubectlRedirectURL: erforderlich. Die Weiterleitungs-URL, die Sie für die gcloud-Befehlszeile zuvor konfiguriert haben.
  • clientID: erforderlich. Die ID für die Clientanwendung, die Authentifizierungsanfragen an den OpenID-Anbieter sendet. Sowohl die gcloud-Befehlszeile als auch die Cloud Console nutzen diese ID.
  • clientSecret: optional. Das Secret für die Clientanwendung. Sowohl die gcloud-Befehlszeile als auch die Cloud Console nutzen dieses Secret.
  • username: optional. Die JWT-Anforderung, die als Nutzername verwendet wird. Der Standardwert ist sub. Dies ist eine eindeutige ID des Endnutzers. Je nach OpenID-Anbieter können Sie andere Anforderungen auswählen, wie beispielsweise email oder name. Allerdings wird anderen Anforderungen als email die Aussteller-URL vorangestellt, um Namenskonflikte mit anderen Plug-ins zu vermeiden.
  • usernamePrefix: optional. Das Präfix, das Nutzernamensanforderungen vorangestellt wird, um Konflikte mit vorhandenen Namen zu vermeiden. Wenn Sie dieses Feld nicht angeben und username ein anderer Wert als email ist, wird standardmäßig das Präfix issuerurl# verwendet. Sie können mit dem Wert - alle Präfixe deaktivieren.
  • group: optional. Die JWT-Anforderung, mit der der Anbieter Ihre Sicherheitsgruppen zurückgibt.
  • groupPrefix: optional. Das Präfix, das Gruppenanforderungen vorangestellt wird, um Konflikte mit vorhandenen Namen zu vermeiden. Ein Beispiel ist gid-foobar für die Gruppe foobar und das Präfix gid-. Standardmäßig ist dieser Wert leer und es gibt kein Präfix.
  • scopes: optional. Zusätzliche Bereiche, die als durch Kommas getrennte Liste an den OpenID-Anbieter gesendet werden.
    • Für die Authentifizierung mit Microsoft Azure oder Okta übergeben Sie offline_access.

  • extraParams: optional. Zusätzliche Schlüssel/Wert-Paar-Parameter, die als durch Kommas getrennte Liste an den OpenID-Anbieter gesendet werden.
  • deployCloudConsoleProxy: optional. Gibt an, ob ein Reverse-Proxy im Cluster bereitgestellt werden soll, um der Google Cloud Console für das Authentifizieren von Nutzern Zugriff auf den lokalen OIDC-Anbieter zu gewähren. Der Wert muss ein String sein: "true" oder "false". Wenn Ihr Identitätsanbieter nicht über das öffentliche Internet erreichbar ist und Sie sich mit der Google Cloud Console authentifizieren möchten, muss für dieses Feld "true" festgelegt werden. Wenn Sie hier nichts eingeben, wird standardmäßig "false" verwendet.
  • caPath: optional. Pfad zum Zertifikat der Zertifizierungsstelle, die das Webzertifikat Ihres Identitätsanbieters ausgestellt hat. Dieser Wert ist möglicherweise nicht erforderlich. Wenn das Zertifikat Ihres Identitätsanbieters beispielsweise von einer bekannten öffentlichen Zertifizierungsstelle ausgestellt wurde, müssen Sie hier keinen Wert angeben. Wenn für "deployCloudConsoleProxy" aber "true" gilt, müssen Sie diesen Wert auch für eine bekannte öffentliche Zertifizierungsstelle angeben.

Beispiel: Nutzer und Gruppen autorisieren

Viele Anbieter codieren nutzeridentifizierende Attribute wie E-Mail-Adressen und Nutzer-IDs in einem Token. Diese Attribute bringen jedoch implizite Risiken für Authentifizierungsrichtlinien mit sich:

  • Nutzer-IDs können das Lesen und Prüfen von Richtlinien erschweren.
  • E-Mail-Adressen können sowohl zu einem Verfügbarkeitsrisiko (wenn ein Nutzer seine primäre E-Mail-Adresse ändert) als auch zu einem Sicherheitsrisiko (wenn eine E-Mail neu zugewiesen werden kann) führen.

Daher wird empfohlen, Gruppenrichtlinien zu verwenden, da eine Gruppen-ID sowohl persistent als auch einfacher zu prüfen ist.

Beispiel: Ihr Anbieter erstellt Identitätstokens, die die folgenden Felder enthalten:

{
  'iss': 'https://server.example.com'
  'sub': 'u98523-4509823'
  'groupList': ['developers@example.corp', 'us-east1-cluster-admins@example.corp']
  ...
}

Bei diesem Tokenformat würde dann die oidc-Spezifikation Ihrer Konfigurationsdatei so aussehen:

issuerURL: 'https://server.example.com'
username: 'sub'
usernamePrefix: 'uid-'
group: 'groupList'
groupPrefix: 'gid-'
extraParams: 'resource=token-groups-claim'
...

Nachdem Sie den Nutzercluster erstellt haben, können Sie den authentifizierten Nutzern mithilfe der rollenbasierten Zugriffssteuerung (Role-based Access Control, RBAC) autorisierten Zugriff gewähren. Sie haben beispielsweise die Möglichkeit, eine ClusterRole zu erstellen, die ihren Nutzern Lesezugriff auf die Secrets des Clusters gewährt, sowie eine ClusterRoleBinding-Ressource, um die Rolle an die authentifizierte Gruppe zu binden:

ClusterRole

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: secret-reader
rules:
- apiGroups: [""]
  # The resource type for which access is granted
  resources: ["secrets"]
  # The permissions granted by the ClusterRole
  verbs: ["get", "watch", "list"]

ClusterRoleBinding

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: read-secrets-admins
subjects:
  # Allows anyone in the "us-east1-cluster-admins" group to
  # read Secrets in any namespace within this cluster.
- kind: Group
  name: gid-us-east1-cluster-admins # Name is case sensitive
  apiGroup: rbac.authorization.k8s.io
  # Allows this specific user to read Secrets in any
  # namespace within this cluster
- kind: User
  name: uid-u98523-4509823
  apiGroup: rbac.authorization.k8s.io
roleRef:
  kind: ClusterRole
  name: secret-reader
  apiGroup: rbac.authorization.k8s.io

Konfigurationsdatei für die Authentifizierung erstellen und verteilen

Dieser Abschnitt richtet sich an Clusteradministratoren.

Nachdem Sie einen Nutzercluster erstellt haben, legen Sie für diesen Cluster eine Konfigurationsdatei für die Authentifizierung an. Sie können in einer einzigen Konfigurationsdatei für die Authentifizierung mehrere Cluster konfigurieren. Sie müssen die Konfigurationsdatei für die Authentifizierung dann allen Nutzern bereitstellen, die sich bei jedem dieser Cluster authentifizieren möchten.

Konfigurationsdatei für die Authentifizierung erstellen

Wenn Sie die Konfigurationsdatei für die Authentifizierung im aktuellen Verzeichnis erstellen möchten, führen Sie den folgenden gkectl-Befehl aus:

gkectl create-login-config --kubeconfig [USER_CLUSTER_KUBECONFIG]

Dabei ist [USER_CLUSTER_KUBECONFIG] der Pfad zur kubeconfig-Datei Ihres Nutzerclusters. Ihre kubeconfig-Datei wurde erstellt, als Sie Ihren Nutzercluster mit gkectl create cluster erstellt haben.

Ergebnis: Im aktuellen Verzeichnis wird die Konfigurationsdatei für die Authentifizierung mit dem Namen kubectl-anthos-config.yaml erstellt.

Mehrere Cluster zur Konfigurationsdatei für die Authentifizierung hinzufügen

Sie können für mehrere Cluster die Details der Authentifizierungskonfiguration in einer einzigen Konfigurationsdatei für die Authentifizierung speichern.

Mit dem folgenden Befehl haben Sie die Möglichkeit, zusätzliche Authentifizierungsdetails für Nutzercluster mit vorhandenen Details in einer Konfigurationsdatei für die Authentifizierung zusammenzuführen. Bei einer vorhandenen Konfigurationsdatei für die Authentifizierung können Sie zusätzliche Authentifizierungsdetails für Nutzercluster entweder mit den vorhandenen Details zusammenführen oder kombinieren:

  • Führen Sie entweder die zusätzlichen Authentifizierungsdetails für Nutzercluster mit den Details in der vorhandenen Konfigurationsdatei für die Authentifizierung zusammen
  • oder kombinieren Sie die zusätzlichen Details zur Nutzercluster-Authentifizierung mit den vorhandenen Details in einer neuen Datei.

Beispielsweise kann es sein, dass Sie die beiden Konfigurationsdateien für die Authentifizierung anthos-config-1cluster.yaml und anthos-config-3clusters.yaml verwalten müssen, um die Zugriffsanforderungen mehrerer Nutzergruppen in Ihrer Organisation zu erfüllen.

So fügen Sie Ihrer vorhandenen Konfigurationsdatei für die Authentifizierung zusätzliche Nutzercluster hinzu:

  1. Achten Sie darauf, dass jeder Cluster einen eindeutigen Namen hat. Wenn Ihre Cluster gleiche Namen haben, können ihre Details nicht in einer Konfigurationsdatei für die Authentifizierung kombiniert werden. Ein einmal erstellter Cluster kann nicht umbenannt werden.

  2. Führen Sie den folgenden gkectl-Befehl aus, um Konfigurationsdetails zusammenzuführen oder zu kombinieren:

    gkectl create-login-config --kubeconfig [USER_CLUSTER_KUBECONFIG] \
    --merge-from [IN_AUTH_CONFIG_FILE] --output [OUT_AUTH_CONFIG_FILE]

    Dabei gilt:

    • [USER_CLUSTER_KUBECONFIG] gibt die kubeconfig-Datei des Nutzerclusters an, den Sie hinzufügen möchten.

    • [IN_AUTH_CONFIG_FILE] gibt den Pfad der vorhandenen Konfigurationsdatei für die Authentifizierung an, deren Details Sie mit den zusätzlichen Clusterinformationen zusammenführen möchten.

    • [OUT_AUTH_CONFIG_FILE] gibt den Pfad der Datei an, in der Sie die zusammengeführte Konfiguration für die Authentifizierung speichern möchten:

      • Geben Sie dieselbe Datei wie unter [IN_AUTH_CONFIG_FILE] an, wenn Sie die zusätzlichen Clusterinformationen in dieser vorhandenen Datei zusammenführen möchten.
      • Geben Sie einen neuen Pfad und Dateinamen an, wenn die Details der Konfiguration für die Authentifizierung in einer neuen Datei kombiniert werden sollen.

Konfigurationsdatei für die Authentifizierung verteilen

Damit sich Ihre Nutzer bei Ihren Nutzerclustern authentifizieren können, müssen Sie ihnen Zugriff auf eine oder mehrere von Ihnen erstellte Konfigurationsdateien für die Authentifizierung gewähren. In den folgenden Schritten werden der Standarddateiname und der Standardspeicherort verwendet, die von der gcloud-Befehlszeile erwartet werden. Informationen zur Verwendung alternativer Dateinamen und Speicherorte finden Sie unter Benutzerdefinierte Konfiguration.

Konfigurationsdateien für die Authentifizierung können so verteilt werden:

  • Durch Hosten der Datei unter einer zugänglichen URL. Wenn Sie den Befehl gcloud anthos auth login mit dem Flag --login-config verwenden, ruft die gcloud-Befehlszeile die Konfigurationsdatei für die Authentifizierung von diesem Speicherort ab.

    Durch Hosten der Datei auf einem sicheren Host. Weitere Informationen zur Verwendung von PEM-Zertifikaten für sicheren HTTPS-Zugriff finden Sie im Flag --login-config-cert der gcloud-Befehlszeile.

  • Durch manuelles Bereitstellen der Datei für jeden Nutzer. Wenn Nutzer die Datei heruntergeladen haben, müssen sie die Datei am Standardspeicherort und mit dem Standarddateinamen speichern, den die gcloud-Befehlszeile erwartet.

    Nutzer können beispielsweise mit den folgenden Befehlen die Konfigurationsdatei für die Authentifizierung mit dem Standarddateinamen kubectl-anthos-config.yaml am Standardspeicherort speichern:

    Linux

    mkdir -p  $HOME/.config/google/anthos/
    cp [AUTH_CONFIG_FILE] $HOME/.config/google/anthos/kubectl-anthos-config.yaml

    Dabei ist [AUTH_CONFIG_FILE] der Name Ihrer Konfigurationsdatei für die Authentifizierung. Beispiel: kubectl-anthos-config.yaml.

    macOS

    mkdir -p  $HOME/Library/Preferences/google/anthos/
    cp [AUTH_CONFIG_FILE] $HOME/Library/Preferences/google/anthos/kubectl-anthos-config.yaml

    Dabei ist [AUTH_CONFIG_FILE] der Name Ihrer Konfigurationsdatei für die Authentifizierung. Beispiel: kubectl-anthos-config.yaml.

    Windows

    md "%APPDATA%\google\anthos"
    copy [AUTH_CONFIG_FILE] "%APPDATA%\google\anthos\kubectl-anthos-config.yaml"

    Dabei ist [AUTH_CONFIG_FILE] der Name Ihrer Konfigurationsdatei für die Authentifizierung. Beispiel: kubectl-anthos-config.yaml.

  • Übertragen Sie mit Ihren internen Tools die Konfigurationsdatei für die Authentifizierung per Push auf den Computer jedes Nutzers. Sie können beispielsweise Ihre Tools verwenden, um Dateien mit dem Standarddateinamen kubectl-anthos-config.yaml zu deren Standardspeicherorten auf jedem Nutzercomputer per Push zu übertragen:

    Linux

    $HOME/.config/google/anthos/kubectl-anthos-config.yaml

    macOS

    $HOME/Library/Preferences/google/anthos/kubectl-anthos-config.yaml

    Windows

    %APPDATA%\google\anthos\kubectl-anthos-config.yaml

Benutzerdefinierte Konfiguration

Die gcloud-Befehlszeile erwartet, dass die Konfigurationsdatei für die Authentifizierung am Standardspeicherort und mit dem Standarddateinamen kubectl-anthos-config.yaml gespeichert wird, wie im vorherigen Abschnitt dargestellt. Sie haben aber die Möglichkeit, die Konfigurationsdatei für die Authentifizierung umzubenennen oder an einem anderen Speicherort zu speichern. Wenn der Name und der Speicherort der Datei vom Standard abweichen, müssen Sie das Flag --login-config an jeden Befehl anhängen, den Sie für die Authentifizierung beim Cluster ausführen. Das zusätzliche Befehls-Flag übergibt den benutzerdefinierten Pfad und den Dateinamen. Weitere Informationen zum Befehls-Flag finden Sie unter Über die gcloud-Befehlszeile authentifizieren.

gcloud-Befehlszeile installieren

Dieser Abschnitt richtet sich sowohl an Clusteradministratoren als auch an Entwickler.

Jeder Entwickler oder Nutzer, der sich bei einem Cluster authentifizieren muss, muss auf seinem eigenen Computer das Cloud SDK installieren. Die Anthos-Authentifizierungsbefehle wurden in die gcloud-Befehlszeile als Komponente anthos-auth eingebunden.

Alte Plug-ins entfernen

Damit Sie die Komponente anthos-auth des Cloud SDK verwenden können, müssen Sie das alte Plug-in deinstallieren. Mit dem folgenden Befehl können Sie prüfen, ob eines der bisherigen kubectl-basierten Plug-ins auf Ihrem Computer vorhanden ist:

kubectl anthos version

  • Wenn der Befehl die Meldung Error: unknown command "anthos" for "kubectl" ausgibt, wurde kein Plug-in gefunden und Sie können mit dem nächsten Abschnitt fortfahren.

  • Wenn die Version 1.0beta des Plug-ins gefunden wurde, müssen Sie die Plug-in-Binärdatei suchen und löschen. Mit dem folgenden Befehl können Sie den Speicherort feststellen und anschließend die Binärdatei von Ihrem Computer entfernen:

    kubectl plugin list

Cloud SDK und die gcloud-Befehlszeile installieren

Sie müssen zuerst das Cloud SDK installieren, bevor die gcloud-Befehlszeile installiert werden kann.

  1. Installieren Sie das Cloud SDK. Überspringen Sie aber dabei den Befehl gcloud init.

  2. Führen Sie die folgenden Befehle aus, um die Komponente anthos-auth zu installieren:

    gcloud components update
    gcloud components install anthos-auth
  3. Führen Sie einen der folgenden Befehle aus, um zu prüfen, ob die gcloud-Befehlszeile installiert wurde:

    gcloud anthos auth
    gcloud anthos auth login

    Ergebnis: Jeder Befehl sollte Details zu den erforderlichen Argumenten und verfügbaren Optionen ausgeben.

Konfigurationsdatei für die Authentifizierung abrufen

Dieser Abschnitt richtet sich an Entwickler.

Ihr Administrator ist dafür verantwortlich, dass Ihre Konfigurationsdatei für die Authentifizierung erstellt und Ihnen dann zur Verfügung gestellt wird. Weitere Informationen finden Sie unter Konfigurationsdatei für die Authentifizierung verteilen.

Standardmäßig verwendet die gcloud-Befehlszeile einen Standarddateinamen und -speicherort für Ihre Konfigurationsdatei für die Authentifizierung. Wenn Ihnen die Datei manuell zur Verfügung gestellt wurde und auf Ihrem Computer gespeichert werden muss, verwenden Sie die Standardeinstellungen, um die gcloud-Authentifizierungsbefehle zu vereinfachen.

Verwenden Sie die im Folgenden aufgeführten Befehle, um die Konfigurationsdatei für die Authentifizierung an den Standardspeicherort zu kopieren:

Linux

mkdir -p  $HOME/.config/google/anthos/
cp [AUTH_CONFIG_FILE] $HOME/.config/google/anthos/kubectl-anthos-config.yaml

Dabei ist [AUTH_CONFIG_FILE] der Name Ihrer Konfigurationsdatei für die Authentifizierung. Beispiel: kubectl-anthos-config.yaml.

macOS

mkdir -p  $HOME/Library/Preferences/google/anthos/
cp [AUTH_CONFIG_FILE] $HOME/Library/Preferences/google/anthos/kubectl-anthos-config.yaml

Dabei ist [AUTH_CONFIG_FILE] der Name Ihrer Konfigurationsdatei für die Authentifizierung. Beispiel: kubectl-anthos-config.yaml.

Windows

md "%APPDATA%\google\anthos"
copy [AUTH_CONFIG_FILE] "%APPDATA%\google\anthos\kubectl-anthos-config.yaml"

Dabei ist [AUTH_CONFIG_FILE] der Name Ihrer Konfigurationsdatei für die Authentifizierung. Beispiel: kubectl-anthos-config.yaml.

Wenn Sie einen anderen Dateinamen oder Speicherort verwenden möchten, können Sie dafür das Flag --login-config in jede Authentifizierungsanfrage einfügen. Weitere Informationen zur Verwendung des Befehls gcloud anthos auth login finden Sie im folgenden Abschnitt.

Bei Nutzerclustern authentifizieren

Dieser Abschnitt richtet sich an Entwickler.

Nachdem das Cloud SDK auf Ihrem Computer installiert ist und der Administrator Ihnen die Konfigurationsdatei für die Authentifizierung zur Verfügung gestellt hat, können Sie sich entweder über die gcloud-Befehlszeile oder über die Cloud Console bei Ihren Clustern authentifizieren.

Über die gcloud-Befehlszeile authentifizieren

Zum Authentifizieren bei Ihren Clustern verwenden Sie gcloud-Befehle.

  1. Führen Sie den Befehl gcloud anthos auth login aus, um den Authentifizierungsvorgang zu starten:

    gcloud anthos auth login \
     --cluster [CLUSTER_NAME] \
     --user [USER_NAME] \
     --login-config [AUTH_CONFIG_FILE_PATH] \
     --login-config-cert [CA_CERT_PEM_FILE] \
     --kubeconfig [USER_CLUSTER_KUBECONFIG]

    Dabei gilt:

    • [CLUSTER_NAME] ist optional und gibt den Namen des Nutzerclusters an. Wenn dieses Flag weggelassen wird, werden Sie aufgefordert, einen der Nutzercluster auszuwählen, die in Ihrer Konfigurationsdatei für die Authentifizierung angegeben sind.

    • [USER_NAME] ist optional und gibt den Nutzernamen für die in der kubeconfig-Datei gespeicherten Anmeldedaten an. Der Standardwert ist [CLUSTER_NAME]-anthos-default-user.

    • [AUTH_CONFIG_FILE_PATH] ist optional und gibt den benutzerdefinierten Pfad oder die URL an, unter dem bzw. unter der die Konfigurationsdatei für die Authentifizierung gespeichert ist oder gehostet wird. Sie können diesen Parameter weglassen, wenn sich die Datei am Standardspeicherort befindet. Beispiel: --login-config /path/to/custom/authentication-config.yaml.

    • [CA_CERT_PEM_FILE] ist optional und gibt den Pfad zu einer PEM-Zertifikatsdatei von Ihrer Zertifizierungsstelle an. Wenn Ihre Konfigurationsdatei für die Authentifizierung sicher gehostet wird, können Sie über eine HTTPS-Verbindung auf die Datei zugreifen. Beispiel: --login-config-cert my-cert.pem.

    • [USER_CLUSTER_KUBECONFIG] ist optional und gibt den benutzerdefinierten Pfad zur kubeconfig-Datei Ihres Nutzerclusters an. Die OIDC-ID-Tokens, die von Ihrem OpenID-Anbieter zurückgegeben werden, sind in der kubeconfig-Datei gespeichert.

      Verwenden Sie dieses Flag, wenn sich die kubeconfig-Datei nicht am Standardspeicherort befindet. Wird dieses Flag nicht angegeben, wird am Standardspeicherort eine neue kubeconfig-Datei erstellt. Beispiel: --kubeconfig /path/to/custom.kubeconfig.

    Beispiele:

    • Bei einem bestimmten Cluster authentifizieren:

      gcloud anthos auth login --cluster my-production-cluster
      
    • Mithilfe einer Eingabeaufforderung den Cluster für die Authentifizierung auswählen:

      gcloud anthos auth login
      

      Ergebnis:

      Please use the --cluster flag to specify a cluster from the list below:
      Source: $HOME/.config/google/anthos/kubectl-anthos-config.yaml
      1. Cluster: test-cluster ServerIP: https://192.168.0.1:6443
      2. Cluster: test-cluster-2 ServerIP: https://192.168.0.2:6443
      3. Cluster: my-production-cluster ServerIP: https://192.168.0.3:6443
      
    • Gehostete Konfigurationsdatei für die Authentifizierung verwenden:

      gcloud anthos auth login \
       --cluster my-production-cluster \
       --login-config HTTPS://my-secure-server/kubectl-anthos-config.yaml \
       --login-config-cert my-cert.pem
      
  2. Geben Sie im browserbasierten Zustimmungsbildschirm Ihre Anmeldedaten ein.

  3. Führen Sie einen kubectl-Befehl aus, um Details zu Ihrem Cluster abzurufen und zu prüfen, ob die Authentifizierung erfolgreich war. Beispiel:

    kubectl get nodes --kubeconfig [USER_CLUSTER_KUBECONFIG]

Ergebnis: Die kubeconfig-Datei enthält jetzt ein ID-Token, das von Ihren kubectl-Befehlen zur Authentifizierung beim Kubernetes API-Server auf Ihrem Nutzercluster verwendet wird.

SSH zur Authentifizierung von einen Remote-Computer aus verwenden

Angenommen, Sie möchten eine SSH-Verbindung zu einem Remote-Computer herstellen und sich von diesem aus bei einem Nutzercluster authentifizieren. Dazu muss sich Ihre Konfigurationsdatei für die Authentifizierung auf dem Remote-Computer befinden und Sie müssen Ihren Open-ID-Anbieter von Ihrem lokalen Computer aus erreichen können.

Führen Sie auf Ihrem lokalen Computer den folgenden Befehl aus:

ssh [USER_NAME]@[REMOTE_MACHINE] -L [LOCAL_PORT]:localhost:[REMOTE_PORT]

Dabei gilt:

  • [USER_NAME] und [REMOTE_MACHINE] sind die Standardwerte, die für die Anmeldung mit SSH verwendet werden.

  • [LOCAL_PORT] ist ein offener Port Ihrer Wahl auf Ihrem lokalen Computer, über den Sie auf den Remote-Computer zugreifen.

  • [REMOTE_PORT] ist der Port, den Sie für Ihre OIDC-Weiterleitungs-URL konfiguriert haben. Diesen Port finden Sie im Feld kubectlRedirectURI Ihrer Konfigurationsdatei für die Authentifizierung.

Führen Sie in Ihrer SSH-Shell den folgenden Befehl aus, um die Authentifizierung zu starten:

gcloud anthos auth login --login-config [AUTH_CONFIG_FILE]

Dabei ist [AUTH_CONFIG_FILE] der Pfad Ihrer Konfigurationsdatei für die Authentifizierung auf dem Remote-Computer.

Geben Sie auf Ihrem lokalen Computer in einem Browser http://localhost:[LOCAL_PORT]/login ein und schließen Sie den OIDC-Anmeldevorgang ab.

Die kubeconfig-Datei auf Ihrem Remote-Computer enthält jetzt das Token, das Sie für den Zugriff auf den Nutzercluster benötigen.

Prüfen Sie in der SSH-Shell, ob Sie Zugriff auf den Nutzercluster haben:

kubectl --kubeconfig [USER_CLUSTER_KUBECONFIG] get nodes

Über die Google Cloud Console authentifizieren

Starten Sie in der Cloud Console den Authentifizierungsvorgang auf der Seite "Kubernetes-Cluster":

  1. Öffnen Sie die Cloud Console.

    Zur Seite „Kubernetes-Cluster“

  2. Suchen Sie in der Liste Ihren GKE On-Prem-Cluster und klicken Sie auf Anmelden.

  3. Wählen Sie Mit dem für den Cluster konfigurierten Identitätsanbieter authentifizieren aus und klicken Sie dann auf ANMELDEN.

    Sie werden zu Ihrem Identitätsanbieter weitergeleitet. Dort müssen Sie sich möglicherweise anmelden oder dem Zugriff der Cloud Console auf Ihr Konto zustimmen. Anschließend werden Sie wieder zurück zur Seite Kubernetes-Cluster in der Cloud Console geleitet.

Fehlerbehebung bei der OIDC-Konfiguration

Prüfen Sie die folgenden Verhaltensweisen und Fehler zur Behebung von OIDC-Problemen:

Ungültige Konfiguration
Wenn in der Cloud Console die OIDC-Konfiguration aus Ihrem Cluster nicht gelesen werden kann, wird die Schaltfläche ANMELDEN deaktiviert.
Ungültige Anbieterkonfiguration
Wenn die Konfiguration Ihres Identitätsanbieters ungültig ist, wird nach dem Klicken auf ANMELDEN eine Fehlermeldung Ihres Identitätsanbieters angezeigt. Folgen Sie der anbieterspezifischen Anleitung, um den Anbieter oder Ihren Cluster richtig zu konfigurieren.
Ungültige Berechtigungen
Wenn Sie den Authentifizierungsvorgang abgeschlossen haben, die Details des Clusters aber noch nicht sichtbar sind, prüfen Sie, ob Sie dem mit OIDC verwendeten Konto die erforderlichen RBAC-Berechtigungen erteilt haben. Dieses Konto kann sich von dem Konto unterscheiden, mit dem Sie auf die Cloud Console zugreifen.
Error: missing 'RefreshToken' field in 'OAuth2Token' in credentials struct
Dieser Fehler tritt möglicherweise auf, wenn der Autorisierungsserver zur Zustimmung auffordert, der erforderliche Authentifizierungsparameter jedoch nicht angegeben wurde. Geben Sie den Parameter prompt=consent im Feld oidc: extraparams der GKE On-Prem-Konfigurationsdatei an und generieren Sie die Clientauthentifizierungsdatei mit dem Flag --extra-params prompt=consent neu.

Weitere Informationen