Authentifizierung für Docker einrichten

Auf dieser Seite wird beschrieben, wie Sie Docker für die Authentifizierung bei Artifact Registry-Docker-Repositories konfigurieren.

Die Authentifizierung für Cloud Build- oder Google Cloud-Laufzeitumgebungen wie Google Kubernetes Engine und Cloud Run muss nicht konfiguriert werden. Sie sollten jedoch prüfen, ob die erforderlichen Berechtigungen konfiguriert wurden. aus.

Hinweis

  1. Aktivieren Sie die Artifact Registry API und installieren Sie das Cloud SDK. Eine Anleitung finden Sie unter Dienst aktivieren und deaktivieren.
  2. Wenn das Ziel-Repository nicht vorhanden ist, erstellen Sie ein neues Repository.
  3. Installieren und initialisieren Sie das Cloud SDK.
  4. (Optional) Konfigurieren Sie die Standardeinstellungen für gcloud-Befehle.
  5. Prüfen Sie, ob das für die Authentifizierung verwendete Konto Berechtigungen für den Zugriff auf Artifact Registry hat. Wir empfehlen, ein Dienstkonto anstelle eines Nutzerkontos zu verwenden.
  6. Installieren Sie Docker, falls es noch nicht installiert ist. Docker ist in Cloud Shell enthalten.
  7. Docker benötigt für die Interaktion mit Registries Zugriff. Fügen Sie unter Linux oder Windows den Nutzer hinzu, mit dem Sie Docker-Befehle in der Docker-Sicherheitsgruppe ausführen. Dieser Schritt ist nicht für Mac OS erforderlich, da Docker Desktop auf einer virtuellen Maschine als Root-Nutzer ausgeführt wird.

    Linux

    Die Docker-Sicherheitsgruppe heißt docker. Führen Sie den folgenden Befehl aus, um Ihren Nutzernamen hinzuzufügen:

    sudo usermod -a -G docker ${USER}
    

    Windows

    Die Docker-Sicherheitsgruppe heißt docker-users. Führen Sie den folgenden Befehl aus, um einen Nutzer über die Administrator-Eingabeaufforderung hinzuzufügen:

    net localgroup docker-users DOMAIN\USERNAME /add
    

    Dabei gilt:

    • DOMAIN ist Ihre Windows-Domain.
    • USERNAME ist Ihr Nutzername.

    Melden Sie sich ab und wieder an, damit Änderungen an der Gruppenmitgliedschaft wirksam werden. Wenn Sie eine virtuelle Maschine verwenden, müssen Sie sie unter Umständen neu starten, damit die Mitgliedschaftsänderungen wirksam werden.

Authentifizierungsmethode auswählen

Die folgenden Authentifizierungsmethoden sind verfügbar:

gcloud Credential Helper
Konfigurieren Sie Ihre Artifact Registry-Anmeldedaten für die Verwendung mit Docker direkt in gcloud. Dies ist die einfachste Authentifizierungsmethode, sie kann aber langsamer sein als das eigenständige Credential Helper.
Eigenständiger Docker Credential Helper
Diese Option dient hauptsächlich zur Konfiguration Ihrer Anmeldedaten zur Verwendung mit Docker, wenn kein Cloud SDK vorhanden ist. Sie ist deutlich schneller als das gcloud Credential Helper und verwendet die Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC), um Anmeldedaten in Ihrer Umgebung automatisch zu finden.
Zugriffstoken
Sie können ein kurzlebiges Zugriffstoken für ein Dienstkonto generieren und dieses dann für die Passwortauthentifizierung verwenden. Da das Token nur 60 Minuten lang gültig ist, ist es sicherer als ein Dienstkontoschlüssel.
Dienstkontoschlüssel
Ein nutzerverwaltetes Schlüsselpaar, das Sie als Anmeldedaten für ein Dienstkonto verwenden können. Da die Anmeldedaten langlebig sind, ist es die sicherste Option aller verfügbaren Authentifizierungsmethoden.

Verwenden Sie nach Möglichkeit ein Zugriffstoken oder einen Credential Helper, um das Risiko unbefugter Zugriffe auf Ihre Container-Images zu verringern. Wenn Sie einen Dienstkontoschlüssel verwenden müssen, folgen Sie den Best Practices für die Verwaltung von Anmeldedaten.

Authentifizierungseinstellungen in der Docker-Konfigurationsdatei

Docker speichert die Authentifizierungseinstellungen in der Konfigurationsdatei config.json.

  • Linux: ~/.docker/config.json
  • Windows: %USERPROFILE%\.docker\config.json

Die Datei enthält separate Abschnitte für verschiedene Authentifizierungsmethoden:

credHelpers
Wenn Sie den Docker Credential Helper für die Authentifizierung verwenden, werden die Einstellungen für den Credential Helper im Abschnitt credHelpers der Datei gespeichert.
auths
Wenn Sie sich mit Docker mit einem Token oder Dienstkontoschlüssel als Passwort anmelden, speichert Docker eine base64-codierte Version Ihrer Anmeldedaten imauths der Datei.
credStore
Wenn Sie einen Anmeldedatenspeicher zum Verwalten Ihrer Anmeldedaten konfiguriert haben, befinden sich die Einstellungen für den Anmeldedatenspeicher im Abschnitt credStore der Datei.

Wenn Docker eine Verbindung zu einer Registry herstellt, wird zuerst nach einem Credential Helper gesucht, der dem Host zugeordnet ist. Wenn config.json die Artifact Registry-Einstellungen im Abschnitt credHelpers und auths enthält, werden die Einstellungen im Abschnitt auths ignoriert.

gcloud Credential Helper

Der gcloud Credential Helper bietet sicheren, kurzlebigen Zugriff auf Ihre Projektressourcen. Es konfiguriert Docker für die Authentifizierung bei Artifact Registry-Hosts in jeder Umgebung, in der das Cloud SDK installiert ist. Cloud Shell umfasst das Cloud SDK und eine aktuelle Version von Docker.

gcloud Credential Helper ist die einfachste Authentifizierungsmethode, die eingerichtet werden kann. Es konfiguriert Docker mit den Anmeldedaten des aktiven Nutzers oder Dienstkontos in Ihrer gcloud-Sitzung. Da dieses Credential Helper vom gcloud-Tool abhängt, kann es erheblich langsamer sein als das eigenständige Credential Helper. Verwenden Sie für automatisierte Builds mit Drittanbietertools oder Docker-Clients mit einer großen Anzahl konfigurierter Registry-Hosts stattdessen den eigenständigen Credential Helper.

So authentifizieren Sie sich bei Artifact Registry:

  1. Melden Sie sich im Cloud SDK als den Nutzer an, der die Docker-Befehle ausführt.

    • Führen Sie den folgenden Befehl aus, um die Authentifizierung mit Nutzeranmeldedaten zu konfigurieren:

      gcloud auth login
      
    • Führen Sie den folgenden Befehl aus, um die Authentifizierung mit Dienstkonto-Anmeldedaten zu konfigurieren:

      gcloud auth activate-service-account ACCOUNT --key-file=KEY-FILE
      

      Wo

  2. Führen Sie dazu diesen Befehl aus:

    gcloud auth configure-docker HOSTNAME-LIST
    

    Dabei ist HOSTNAME-LIST eine durch Kommas getrennte Liste von Repository-Hostnamen, die der Credential Helper-Konfiguration hinzugefügt werden sollen.

    Führen Sie beispielsweise den folgenden Befehl aus, um die Regionen us-central1 und asia-northeast1 hinzuzufügen:

    gcloud auth configure-docker us-central1-docker.pkg.dev,asia-northeast1-docker.pkg.dev
    

    Die angegebenen Hostnamen werden der Konfiguration des Credential Helper hinzugefügt. Sie können der Konfiguration später weitere Hostnamen hinzufügen, indem Sie den Befehl noch einmal ausführen.

    Führen Sie den folgenden Befehl aus, um eine Liste der unterstützten Repository-Speicherorte anzuzeigen:

    gcloud artifacts locations list
    
  3. Der Befehl zeigt den Abschnitt credHelpers Ihrer aktuellen Docker-Konfiguration und die aktualisierte Konfiguration an, nachdem Sie die angegebenen Hostnamen hinzugefügt haben.

    Geben Sie y ein, um die Konfigurationsänderungen zu akzeptieren.

    Ihre Anmeldedaten werden im Basisverzeichnis des Nutzers gespeichert.

    • Linux: $HOME/.docker/config.json
    • Windows: %USERPROFILE%/.docker/config.json
  4. Für Docker müssen sich Credential Helper im System-PATH befinden. Prüfen Sie, ob der Befehl gcloud im System PATH ist.

Eigenständiger Credential Helper

Der eigenständige Docker Credential Helper konfiguriert Docker für die Authentifizierung bei Artifact Registry auf einem System, auf dem das Cloud SDK nicht verfügbar ist. Sie ist deutlich schneller als das gcloud Credential Helper und verwendet Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC), um Anmeldedaten in Ihrer Umgebung automatisch zu finden. Für andere Vorgänge als das Hoch- und Herunterladen von Images, zum Beispiel zum Taggen oder Auflisten von Images. Wir empfehlen, diese Authentifizierungsmethode für automatisierte Builds mit Drittanbietertools oder Docker-Clients mit einer großen Anzahl konfigurierter Registry-Hosts zu verwenden.

Mit dem eigenständigen Docker Credential Helper werden Ihre Artifact Registry-Anmeldedaten abgerufen und in die Docker-Konfigurationsdatei geschrieben. Auf diese Weise können Sie das Docker-Befehlszeilentool docker verwenden, um direkt mit Artifact Registry zu interagieren.

So verwenden Sie Docker Credential Helper:

  1. Melden Sie sich auf dem Computer als der Nutzer an, der Docker-Befehle ausführt.

  2. Laden Sie den eigenständigen Docker Credential Helper von GitHub herunter.

    Sie können optional das curl-Befehlszeilentool verwenden. Beispiel:

    VERSION=2.1.0
    OS=linux  # or "darwin" for OSX, "windows" for Windows.
    ARCH=amd64  # or "386" for 32-bit OSs
    
    curl -fsSL "https://github.com/GoogleCloudPlatform/docker-credential-gcr/releases/download/v${VERSION}/docker-credential-gcr_${OS}_${ARCH}-${VERSION}.tar.gz" \
    | tar xz --to-stdout ./docker-credential-gcr \
    > /usr/bin/docker-credential-gcr && chmod +x /usr/bin/docker-credential-gcr
    
  3. Konfigurieren Sie Docker so, dass die Anmeldedaten von Artifact Registry für die Interaktion mit Artifact Registry verwendet werden. Sie müssen dies nur einmal tun:

    docker-credential-gcr configure-docker --registries=HOSTNAME-LIST
    

    Dabei ist HOSTNAME-LIST eine durch Kommas getrennte Liste von Repository-Hostnamen, die der Credential Helper-Konfiguration hinzugefügt werden sollen.

    Führen Sie beispielsweise den folgenden Befehl aus, um die Regionen us-central1 und asia-northeast1 hinzuzufügen:

    docker-credential-gcr configure-docker --registries=us-central1-docker.pkg.dev,asia-northeast1-docker.pkg.dev
    

    Die angegebenen Hostnamen werden der Konfiguration des Credential Helper hinzugefügt. Sie können der Konfiguration später weitere Hostnamen hinzufügen, indem Sie den Befehl noch einmal ausführen.

    Führen Sie den folgenden Befehl aus, um eine Liste der unterstützten Repository-Speicherorte anzuzeigen:

    gcloud artifacts locations list
    

    Weitere Informationen finden Sie in der Dokumentation zum eigenständigen Docker-Credential Helper auf GitHub.

    Ihre Anmeldedaten werden im Basisverzeichnis des Nutzers gespeichert.

    • Linux: $HOME/.docker/config.json
    • Windows: %USERPROFILE%/.docker/config.json
  4. Für Docker müssen sich Credential Helper im System-PATH befinden. Prüfen Sie, ob der Befehl docker-credential-gcr im System PATH ist.

  5. Führen Sie den folgenden Befehl aus, um zu prüfen, ob Credential Helper Ihre Anmeldedaten erfolgreich abrufen kann:

    echo "https://HOSTNAME" | docker-credential-gcr get
    

    Ersetzen Sie HOSTNAME durch einen Hostnamen, den Sie der Konfiguration hinzugefügt haben. Beispiel:

    echo "https://us-central1-docker.pkg.dev" | docker-credential-gcr get
    

    Wenn der Befehl erfolgreich ausgeführt wurde, enthält die zurückgegebene JSON-Ausgabe ein Token im Feld Secret. Beispiel:

    {"ServerURL":"https://us-central1-docker.pkg.dev","Username":"_dcgcr_2_0_0_token","Secret":"ya29..."}
    

Docker ist jetzt für die Authentifizierung bei Artifact Registry konfiguriert. Prüfen Sie, ob die Berechtigungen richtig konfiguriert sind, um Images hoch- und herunterzuladen.

Zugriffstoken

Sie können ein kurzlebiges OAuth-Zugriffstoken generieren, um sich bei Artifact Registry zu authentifizieren. Da das Token 60 Minuten lang gültig ist, sollten Sie es weniger als eine Stunde anfordern, bevor Sie es für die Verbindung mit Artifact Registry verwenden.

So verwenden Sie ein Zugriffstoken mit Anmeldedaten für ein Dienstkonto:

  1. Erstellen Sie ein Dienstkonto, das im Namen Ihrer Anwendung agieren soll, oder wählen Sie ein vorhandenes Dienstkonto für die Automatisierung aus.

    Sie benötigen den Speicherort der Dienstkonto-Schlüsseldatei, um damit die Authentifizierung bei Artifact Registry einzurichten. Auf der Seite „Dienstkonten“ können Sie die Schlüssel vorhandener Konten aufrufen und neue Schlüssel erstellen.

    Zur Seite „Dienstkonten“

  2. Weisen Sie dem Dienstkonto die entsprechende Artifact Registry-Rolle zu, um Repository-Zugriff zu gewähren.

  3. Generieren Sie mit einer der folgenden Optionen ein Zugriffstoken für das Dienstkonto:

    • Wenn Sie die Berechtigungen in der Rolle "Ersteller von Dienstkonto-Tokens" (roles/iam.serviceAccountTokenCreator) haben, können Sie die Identität eines Dienstkontos übergeben, um ein Token dafür zu erhalten. Anschließend mit dem Dienstkonto authentifizieren.

      Linux

      Führen Sie den folgenden Befehl aus und ersetzen Sie dabei ACCOUNT durch die E-Mail-Adresse Ihres Dienstkontos und den regionalen oder multiregionalen Standort des Repositorys LOCATION.

      gcloud auth print-access-token \
          --impersonate-service-account ACCOUNT | docker login \
          -u oauth2accesstoken \
          --password-stdin https://LOCATION-docker.pkg.dev
      

      Windows

      Führen Sie den folgenden Befehl aus und ersetzen Sie dabei ACCOUNT durch die E-Mail-Adresse Ihres Dienstkontos und den regionalen oder multiregionalen Standort des Repositorys LOCATION.

      gcloud auth print-access-token
          --impersonate-service-account ACCOUNT
      
      ya29.8QEQIfY_...
      
      docker login -u oauth2accesstoken -p "ya29.8QEQIfY_..." \
      https://LOCATION-docker.pkg.dev
      
    • Aktivieren Sie in Ihrer gcloud-Sitzung ein Dienstkonto und rufen Sie ein Zugriffstoken ab.

      1. Aktivieren Sie das Dienstkonto, das Sie verwenden möchten. Ersetzen Sie ACCOUNT durch die E-Mail-Adresse Ihres Dienstkontos und KEY-FILE durch den Dateinamen Ihres Dienstkontoschlüssels.

        gcloud auth activate-service-account ACCOUNT \
            --key-file=KEY-FILE
        
      2. Rufen Sie zur Authentifizierung bei Artifact Registry mit Docker ein Zugriffstoken ab.

      3. Token generieren und beim Repository authentifizieren

        Linux

        Führen Sie den folgenden Befehl aus und ersetzen Sie dabei LOCATION durch den regionalen oder multiregionalen Standort des Repositorys.

        gcloud auth print-access-token | docker login -u oauth2accesstoken \
            --password-stdin https://LOCATION-docker.pkg.dev
        

        Windows

        Führen Sie den folgenden Befehl aus und ersetzen Sie dabei LOCATION durch den regionalen oder multiregionalen Standort des Repositorys.

        gcloud auth print-access-token
        ya29.8QEQIfY_...
        
        docker login -u oauth2accesstoken -p "ya29.8QEQIfY_..." \
            https://LOCATION-docker.pkg.dev
        

Docker ist jetzt bei Artifact Registry authentifiziert.

Dienstkontoschlüssel

Ein Dienstkontoschlüssel ist ein langlebiges Schlüsselpaar, das Sie als Anmeldedaten für ein Dienstkonto verwenden können. Im Gegensatz zum OAuth-Zugriffstoken läuft ein Dienstkontoschlüssel nicht ab. Sie sind für die Sicherheit des privaten Schlüssels und andere Schlüsselverwaltungsvorgänge wie die Schlüsselrotation verantwortlich.

Jeder, der Zugriff auf einen gültigen privaten Schlüssel für ein Dienstkonto hat, kann über das Dienstkonto auf Ressourcen zugreifen. Beachten Sie, dass der Lebenszyklus des Schlüsselzugriffs auf das Dienstkonto (und damit die Daten, auf die das Dienstkonto Zugriff hat) vom Lebenszyklus des Nutzers unabhängig ist, der den Schlüssel heruntergeladen hat.

Verwenden Sie die folgenden Richtlinien, um den Zugriff auf Ihre Repositories einzuschränken:

  • Erstellen Sie dedizierte Dienstkonten, die nur für die Interaktion mit Repositories verwendet werden.
  • Erteilen Sie die spezifische Artifact Registry-Rolle für den Zugriff, der für das Dienstkonto erforderlich ist. Beispielsweise benötigt ein Dienstkonto, das nur Artefakte herunterlädt, nur die Rolle Artifact Registry-Leser.
  • Konfigurieren Sie die Berechtigungen für Ihre dedizierten Dienstkonten für jedes Repository und nicht auf Projektebene. Anschließend können Sie den Zugriff basierend auf dem Repository-Kontext festlegen. Beispielsweise kann ein Dienstkonto für Entwicklungs-Builds die Rolle Artifact Registry-Leser für ein Produktions-Repository und die Artifact Registry-Autor-Rolle für ein Staging-Repository haben.
  • Folgen Sie den Best Practices für die Verwaltung von Anmeldedaten.

So erstellen Sie ein neues Dienstkonto und einen Dienstkontoschlüssel nur für die Verwendung mit Artifact Registry-Repositories:

  1. Erstellen Sie ein Dienstkonto, das im Namen Ihrer Anwendung agieren soll, oder wählen Sie ein vorhandenes Dienstkonto für die Automatisierung aus.

    Sie benötigen den Speicherort der Dienstkonto-Schlüsseldatei, um damit die Authentifizierung bei Artifact Registry einzurichten. Auf der Seite „Dienstkonten“ können Sie die Schlüssel vorhandener Konten aufrufen und neue Schlüssel erstellen.

    Zur Seite „Dienstkonten“

  2. Sie können den gesamten Inhalt der Schlüsseldatei optional base64-codieren.

    Linux

    base64 FILE-NAME > NEW-FILE-NAME
    

    macOS

    base64 -i FILE-NAME -o NEW-FILE-NAME
    

    Windows

    Base64.exe -e FILE-NAME > NEW-FILE-NAME
    

    Dabei ist FILE-NAME der ursprüngliche Schlüsseldatei und NEW-FILE-NAME Ihre base64-codierte Schlüsseldatei.

  3. Prüfen Sie, ob die Berechtigungen für das Dienstkonto ordnungsgemäß konfiguriert sind. Wenn Sie das Compute Engine-Dienstkonto verwenden, müssen Sie sowohl Berechtigungen als auch Zugriffsbereiche richtig konfigurieren.

  4. Verwenden Sie den Dienstkontoschlüssel, um die Integration in Docker zu konfigurieren:

    Linux/macOS

    Führen Sie dazu diesen Befehl aus:

    cat KEY-FILE | docker login -u KEY-TYPE --password-stdin \
    https://LOCATION-docker.pkg.dev
    

    Alternative für ältere Docker-Clients, die --password-stdin nicht unterstützen:

    docker login -u KEY-TYPE -p "$(cat FILE-NAME.json)" \
    https://LOCATION-docker.pkg.dev
    

    Dabei gilt:

    • KEY-TYPE ist einer der folgenden Werte:
      • _json_key, wenn Sie den Dienstkontoschlüssel im JSON-Format verwenden, wie er beim Erstellen der Datei angegeben wurde.
      • _json_key_base64, wenn Sie den gesamten Inhalt der Datei base64-codiert haben.
    • KEY-FILE ist der Name der Dienstkonto-Schlüsseldatei im JSON-Format.
    • LOCATION ist der regionale oder multiregionale Speicherort des Repositorys, an dem das Image gespeichert wird.

    Windows

    Führen Sie dazu diesen Befehl aus:

    docker login -u KEY-TYPE --password-stdin https://LOCATION-docker.pkg.dev < KEY-FILE
    

    Alternative für ältere Docker-Clients, die --password-stdin nicht unterstützen:

    set /p PASS=<KEY-FILE
    docker login -u KEY-TYPE -p "%PASS%" https://LOCATION-docker.pkg.dev
    

    Dabei gilt:

    • KEY-TYPE ist einer der folgenden Werte:
      • _json_key, wenn Sie den Dienstkontoschlüssel im JSON-Format verwenden, wie er beim Erstellen der Datei angegeben wurde.
      • _json_key_base64, wenn Sie den gesamten Inhalt der Datei base64-codiert haben.
    • KEY-FILE ist der Name der Dienstkonto-Schlüsseldatei im JSON-Format.
    • LOCATION ist der regionale oder multiregionale Standort des Repositorys, in dem das Image gespeichert ist.

Docker ist jetzt bei Artifact Registry authentifiziert.