Authentifizierung für Artifact Registry für Ruby-Gem-Repositories konfigurieren

Auf dieser Seite wird beschrieben, wie Sie die Authentifizierung mit einem Artifact Registry-Ruby-Gem-Repository konfigurieren.

Sie müssen sich bei Artifact Registry authentifizieren, wenn Sie eine Drittanbieteranwendung für die Verbindung mit einem Repository verwenden.

Sie müssen die Authentifizierung nicht für Cloud Build oder Google Cloud Laufzeitumgebungen wie Google Kubernetes Engine und Cloud Run konfigurieren.

Hinweis

  1. Wenn das Ziel-Repository nicht vorhanden ist, erstellen Sie ein Ruby-Gem-Repository.
  2. Prüfen Sie, ob Ruby installiert ist. Eine Installationsanleitung finden Sie im Google Cloud Tutorial zum Einrichten von Ruby.
  3. Prüfen Sie, ob das verwendete Nutzerkonto oder Dienstkonto die erforderlichen Berechtigungen für den Zugriff auf das Repository hat.

  4. Installieren Sie die Google Cloud CLI. Initialisieren Sie die Google Cloud CLI nach der Installation mit dem folgenden Befehl: 

    gcloud init

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  5. (Optional) Konfigurieren Sie die Standardeinstellungen für gcloud CLI-Befehle.

Übersicht

Ruby unterstützt zwei Methoden zum Authentifizieren von Anfragen an Ihr Artifact Registry-Repository:

  • RubyGems CLI: Unterstützt Push- und Pull-Anfragen. Diese CLI ist standardmäßig in Ruby verfügbar. Wenn Sie sich mit RubyGems authentifizieren, müssen Sie sich jedes Mal authentifizieren, wenn Sie eine Push- oder Pull-Anfrage an Ihr Repository senden.

  • Bundler CLI: Unterstützt Pull-Anfragen. Bundler speichert Pakete und Upstreams in einer Gemfile-Datei. So können Nutzer Setups auf mehreren Computern standardisieren, ohne jede einzelne Pull-Anfrage authentifizieren zu müssen. Sie müssen Ihre Anmeldedaten jedoch gelegentlich neu bei Bundler authentifizieren.

    Geben Sie gem install bundler ein, um die Bundler CLI zu installieren.

Mit der RubyGems CLI authentifizieren

Die RubyGems CLI verwendet OAuth2-Tokens, um eine Anfrage zu authentifizieren. Wenn Sie OAuth2-Tokens an Aufrufe Ihrer Artifact Registry-Repositories übergeben möchten, müssen Sie zuerst das Token generieren und es dann mit der Adresse Ihres Repositorys übergeben, wenn Sie eine Anfrage senden. Tokens haben eine Lebensdauer von einer Stunde und müssen stündlich aktualisiert werden.

Pull-Anfragen authentifizieren

Sie können eine Pull-Anfrage in der Google Cloud CLI-Befehlszeile authentifizieren oder Ihre .gemrc-Datei aktualisieren.

Pull-Anfragen in der Befehlszeile authentifizieren

Führen Sie den folgenden Befehl aus, um sich für die neueste Version des Gems in Ihrer Pull-Anfrage zu authentifizieren:

export GEM_TOKEN="oauth2accesstoken:$(gcloud auth print-access-token)"
gem install GEM_NAME --source https://$GEM_TOKEN@LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY

Wenn Sie sich für eine bestimmte Gem-Version authentifizieren möchten, fügen Sie -v GEM_VERSION dem gem install Befehl hinzu.

Wobei:

  • GEM_NAME ist der Name des Gems, für das die Anfrage gestellt wird.
  • LOCATION ist der regionale oder multiregionale Standort für das Repository.
  • PROJECT ist die ID des Projekts, das das Repository enthält.
  • REPOSITORY ist die ID des Repositorys.

In einer .gemrc-Datei authentifizieren

Sie können Ihre globale oder projektspezifische /.gemrc-Datei so konfigurieren, dass Sie sich bei Pull-Anfragen bei Ihren Quellen authentifizieren können. Fügen Sie dazu Folgendes hinzu:

# File: ~/.gemrc

# Use the GEM_TOKEN retrieved from export GEM_TOKEN="oauth2accesstoken:$(gcloud auth print-access-token)"

<...>
:sources:
    - https://GEM_TOKEN@LOCATION-ruby.pkg.dev/PROJECT/REPO/
<...>

So installieren Sie ein Gem mit der oder den in Ihrer /.gemrc-Datei definierten Quelle(n):

gem install GEM_NAME

Push-Anfragen authentifizieren

Sie können eine Push-Anfrage in der Google Cloud CLI-Befehlszeile authentifizieren oder Ihre Datei mit den Anmeldedaten aktualisieren.

Push-Anfragen in der Befehlszeile authentifizieren

Führen Sie den folgenden Befehl aus, um Ihre Push-Anfrage zu authentifizieren:

export GEM_HOST_API_KEY="Bearer $(gcloud auth print-access-token)"
gem push GEM_NAME --host https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY

Wobei:

  • GEM_NAME ist der Name des Gems, für das die Anfrage gestellt wird.
  • LOCATION ist der regionale oder multiregionale Standort für das Repository.
  • PROJECT ist die ID des Projekts, das das Repository enthält.
  • REPOSITORY ist die ID des Repositorys.

Push-Anfragen in einer Datei mit Anmeldedaten authentifizieren

Das Befehlszeilentool gem verwendet die Datei ~/.gem/credentials, um API-Schlüssel für das Pushen und Pullen von Gems zu speichern. So konfigurieren Sie Ihre Datei mit den Anmeldedaten, um sich bei Push-Anfragen bei Ihren Quellen zu authentifizieren:

  1. Generieren Sie ein OAuth2-Zugriffstoken, indem Sie den folgenden Befehl ausführen:

    gcloud auth print-access-token

    Dieses Token dient als API-Schlüssel für Artifact Registry.

  2. Aktualisieren Sie die Datei mit den Anmeldedaten:

    1. Öffnen Sie ~/.gem/credentials und fügen Sie eine Zeile für Ihr Repository hinzu. Der Schlüssel ist die URL Ihres Repositorys und der Wert ist Bearer, gefolgt von Ihrem Token:

      :rubygems_api_key: RUBYGEMS_ORG_KEY
https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY: Bearer OAUTH_TOKEN

      Wobei:

      • RUBYGEMS_ORG_KEY ist der API-Schlüssel für RubyGems.org.
      • LOCATION ist der regionale oder multiregionale Standort für das Repository.
      • PROJECT ist die ID des Projekts, das das Repository enthält.
      • REPOSITORY ist die ID des Repositorys.
      • OAUTH_TOKEN ist Ihr OAuth2-Zugriffstoken.

    2. Pushen Sie Ihr Gem. Sie müssen GEM_HOST_API_KEY nicht festlegen, da Sie den Schlüssel bereits in Ihrer Datei mit den Anmeldedaten definiert haben.

      gem push GEM_NAME --host https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY

Mit Bundler authentifizieren

Der Ruby Bundler verwaltet Anwendungsabhängigkeiten in einem oder mehreren Gems. So richten Sie Bundler ein:

  1. Fügen Sie die Adresse Ihres Repositorys als source in Ihrer Gemfile-Datei hinzu:

    # Gemfile
# <...>
source "https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY"

  2. Authentifizieren Sie sich mit bundle config bei Ihrem Repository:

    export GEM_TOKEN="oauth2accesstoken:$(gcloud auth print-access-token)"
export HOST="https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY"
bundle config $HOST $GEM_TOKEN

Wobei:

  • LOCATION ist der regionale oder multiregionale Standort für das Repository.
  • PROJECT ist die Projekt-ID. Wenn dieses Flag nicht angegeben ist, wird das aktuelle Projekt oder das Standardprojekt verwendet.
  • REPOSITORY ist die ID des Repositorys. Wenn Sie ein Standard Artifact Registry Repository konfiguriert haben, wird es verwendet, wenn dieses Flag im Befehl ausgelassen wird.

Sie müssen sich gelegentlich neu bei Ihrem Remote-Repository authentifizieren. Führen Sie in diesem Fall denselben Authentifizierungsbefehl aus Schritt 2 aus.

Weitere Informationen zum Konfigurieren von Bundler, siehe Gemfiles in der Dokumentation zu bundler.io.

Nächste Schritte