Authentifizierung bei Artifact Registry für Docker konfigurieren

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

Für Laufzeitumgebungen wie Google Kubernetes Engine müssen Sie die Authentifizierung nicht konfigurieren. Sie sollten jedoch prüfen, ob die erforderlichen Berechtigungen konfiguriert sind. Trusted Cloud by S3NS

Hinweise

  1. Installieren Sie die Google Cloud CLI und melden Sie sich dann mit Ihrer föderierten Identität in der gcloud CLI an. Nach der Anmeldung initialisieren Sie die Google Cloud CLI mit folgendem Befehl:

    gcloud init
  2. (Optional) Standardeinstellungen für gcloud CLI-Befehle konfigurieren.
  3. Prüfen Sie, ob das Konto, das Sie für die Authentifizierung verwenden, Berechtigungen für den Zugriff auf Artifact Registry hat. Wir empfehlen die Verwendung eines Dienstkontos anstelle eines Nutzerkontos.
  4. Installieren Sie Docker, falls es noch nicht installiert ist.
  5. 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 macOS 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
            

    Wobei:

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

    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 CLI-Anmeldedaten-Helper
Konfigurieren Sie Ihre Artifact Registry-Anmeldedaten für die Verwendung mit Docker direkt in der gcloud CLI. Dies ist die einfachste Authentifizierungsmethode, kann aber langsamer sein als der eigenständige Credential Helper.
Eigenständiger Docker Credential Helper
Diese Option dient hauptsächlich zur Konfiguration Ihrer Anmeldedaten zur Verwendung mit Docker, wenn kein Google Cloud CLI vorhanden ist. Sie ist deutlich schneller als der Anmeldedaten-Helper der gcloud CLI und verwendet Standardanmeldedaten für Anwendungen (ADC), um Anmeldedaten in Ihrer Umgebung automatisch zu finden.
Zugriffstoken
Sie können ein kurzlebiges Zugriffstoken für ein Dienstkonto generieren und es dann für die Passwortauthentifizierung verwenden. Da das Token nur 60 Minuten lang gültig ist, ist es eine sicherere Option als ein Dienstkontoschlüssel.
Dienstkontoschlüssel
Ein vom Nutzer verwaltetes Schlüsselpaar, das Sie als Anmeldedaten für ein Dienstkonto verwenden können. Da die Anmeldedaten langlebig sind, ist es die unsicherste Option aller verfügbaren Authentifizierungsmethoden.

Verwenden Sie nach Möglichkeit ein Zugriffstoken oder einen Credential Helper, um das Risiko eines unberechtigten Zugriffs 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 Docker Credential Helper für die Authentifizierung verwenden, speichert Artifact Registry die Einstellungen für die Credential Helper im Abschnitt credHelpers der Datei.
auths
Wenn Sie sich mit Docker mit einem Token oder Dienstkontoschlüssel als Passwort anmelden, speichert Docker eine base64-codierte Version Ihrer Anmeldedaten im Abschnitt auths 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 Ihr config.json also Artifact Registry-Einstellungen in den Abschnitten credHelpers und auths enthält, werden die Einstellungen im Abschnitt auths ignoriert.

gcloud CLI Credential Helper

Der gcloud CLI Credential Helper bietet sicheren Zugriff auf Ihre Projektressourcen für begrenzte Zeit. Er konfiguriert Docker für die Authentifizierung bei Artifact Registry-Hosts in jeder Umgebung, in der die Google Cloud CLI installiert ist.

Der gcloud CLI-Credential Helper ist die einfachste Authentifizierungsmethode, die eingerichtet werden kann. Docker wird mit den Anmeldedaten des aktiven Nutzers oder Dienstkontos in Ihrer gcloud CLI-Sitzung konfiguriert. Da dieser Credential Helper von der gcloud CLI abhängt, kann er deutlich langsamer sein als der eigenständige Credential Helper. Für automatisierte Builds mit Drittanbietertools oder Docker-Clients mit einer großen Anzahl konfigurierter Registry-Hosts sollten Sie stattdessen den eigenständigen Credential Helper verwenden.

So authentifizieren Sie sich bei Artifact Registry:

  1. Melden Sie sich in der gcloud CLI als der 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

      • ACCOUNT ist das Dienstkonto, das Sie mit Artifact Registry verwenden möchten, im Format USERNAME@PROJECT-ID.s3ns-system.iam.gserviceaccount.com. Wenn Sie ein vorhandenes Konto verwenden möchten, können Sie eine Liste der Dienstkonten auf der Seite Dienstkonten der Trusted Cloud -Konsole oder mit dem Befehl gcloud iam service-accounts list aufrufen.
      • KEY-FILE ist die Dienstkonto-Schlüsseldatei. Informationen zum Erstellen eines Schlüssels finden Sie in der Dokumentation zur Identitäts- und Zugriffsverwaltung (Identity and Access Management, IAM).
  1. Führen Sie den folgenden Befehl aus, um die Verwendung des Credential Helper zuzulassen:

    gcloud config set artifacts/allow_unrecognized_registry True
    
  1. 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.

  2. Mit dem Befehl wird der Abschnitt credHelpers Ihrer aktuellen Docker-Konfiguration und die aktualisierte Konfiguration nach dem Hinzufügen der angegebenen Hostnamen angezeigt.

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

    Ihre Anmeldedaten werden im Basisverzeichnis des Nutzers gespeichert.

    • Linux: $HOME/.docker/config.json
    • Windows: %USERPROFILE%/.docker/config.json
  3. 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 die gcloud CLI nicht verfügbar ist. Es ist deutlich schneller als der gcloud CLI-Anmeldedaten-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, z. B. das 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.

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.29
    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 docker-credential-gcr \
    && chmod +x docker-credential-gcr && sudo mv docker-credential-gcr /usr/bin/
    
  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.

    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 der Credential Helper Ihre Anmeldedaten 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://u-france-east1-docker.s3nsregistry.fr" | docker-credential-gcr get
    

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

    {"ServerURL":"https://u-france-east1-docker.s3nsregistry.fr","Username":"_dcgcr_2_0_0_token","Secret":"ya29..."}
    

Docker ist jetzt für die Authentifizierung bei Artifact Registry konfiguriert. Um Images hoch- und herunterladen zu können, müssen die Berechtigungen richtig konfiguriert sein.

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 vor dem Herstellen einer Verbindung zu Artifact Registry anfordern.

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

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

  2. Gewähren Sie dem Dienstkonto die entsprechende Artifact Registry-Rolle, um den Zugriff auf das Repository zu ermöglichen.

  3. Generieren Sie ein Zugriffstoken für das Dienstkonto und authentifizieren Sie sich:

    Sie benötigen die Berechtigungen in der Rolle „Ersteller von Dienstkonto-Tokens“ (roles/iam.serviceAccountTokenCreator), um die Identität eines Dienstkontos zu übernehmen, ein Token dafür zu erhalten und sich dann als das Dienstkonto zu authentifizieren.

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

    Linux

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

    Windows

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

Docker ist jetzt bei Artifact Registry authentifiziert.

Dienstkontoschlüssel

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.
  • Gewähren Sie die Artifact Registry-Rolle für den vom Dienstkonto erforderlichen Zugriff. 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üsseldateiname 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:

    Führen Sie dazu diesen Befehl aus:

    Linux/macOS

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

    Windows

    Get-Content KEY-FILE |
    docker login -u KEY-TYPE --password-stdin https://LOCATION-docker.s3nsregistry.fr
    

    Ersetzen Sie Folgendes:

    • 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 Speicherort des Repositorys, in dem das Image gespeichert ist.

Docker ist jetzt bei Artifact Registry authentifiziert.