Konfiguration und Verwendung von RubyGems und Bundler mit CodeArtifact

1. Öffnen Sie die AWS CodeArtifact Konsole unter https://console.aws.amazon.com/codesuite/codeartifact/home.

2. Wählen Sie im Navigationsbereich Repositories und dann das Repository aus, das Sie für die Installation oder Übertragung von Ruby Gems verwenden möchten.

3. Wählen Sie Verbindungsanweisungen anzeigen.

4. Wählen Sie Ihr Betriebssystem.

5. Wählen Sie den Ruby-Paketmanager-Client aus, den Sie mit Ihrem CodeArtifact Repository konfigurieren möchten.

6. Folgen Sie den generierten Anweisungen, um den Package Manager-Client so zu konfigurieren, dass er Ruby-Gems aus dem Repository installiert oder Ruby-Gems im Repository veröffentlicht.

1. Verwenden Sie in einer Befehlszeile den folgenden Befehl, um ein CodeArtifact Autorisierungstoken abzurufen und es in einer Umgebungsvariablen zu speichern.

   • Ersetzen Sie es my_domain durch Ihren CodeArtifact Domainnamen.

   • 111122223333Ersetzen Sie es durch die AWS Konto-ID des Inhabers der Domain. Wenn Sie auf ein Repository in einer Domain zugreifen, die Sie besitzen, müssen Sie nichts angeben--domain-owner. Weitere Informationen finden Sie unter Kontenübergreifende Domänen.

   macOS and Linux

   export CODEARTIFACT_AUTH_TOKEN=`aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text`

   Windows

   • Windows (unter Verwendung der Standard-Befehlsshell):

     for /f %i in ('aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text') do set CODEARTIFACT_AUTH_TOKEN=%i

   • Windows PowerShell:

     $env:CODEARTIFACT_AUTH_TOKEN = aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text

2. Um Ruby-Gems in Ihrem Repository zu veröffentlichen, verwenden Sie den folgenden Befehl, um den Endpunkt Ihres CodeArtifact Repositorys abzurufen und ihn in der RUBYGEMS_HOST Umgebungsvariablen zu speichern. Die gem CLI verwendet diese Umgebungsvariable, um zu bestimmen, wo Gems veröffentlicht werden.

   Anmerkung

   Anstatt die RUBYGEMS_HOST Umgebungsvariable zu verwenden, können Sie dem Repository-Endpunkt bei der Verwendung des gem push Befehls --host diese Option zur Verfügung stellen.

   • Ersetze es my_domain durch deinen CodeArtifact Domainnamen.

   • 111122223333Ersetzen Sie es durch die AWS Konto-ID des Inhabers der Domain. Wenn Sie auf ein Repository in einer Domain zugreifen, die Sie besitzen, müssen Sie nichts angeben--domain-owner. Weitere Informationen finden Sie unter Kontenübergreifende Domänen.

   • Ersetze es my_repo durch deinen CodeArtifact Repository-Namen.

   macOS and Linux

   export RUBYGEMS_HOST=`aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text | sed 's:/*$::'`

   Windows

   Die folgenden Befehle rufen den Repository-Endpunkt ab, kürzen die nachfolgenden / Befehle und speichern sie dann in einer Umgebungsvariablen.

   • Windows (unter Verwendung der Standard-Befehlsshell):

     for /f %i in ('aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text') do set RUBYGEMS_HOST=%i
                                     
     set RUBYGEMS_HOST=%RUBYGEMS_HOST:~0,-1%

   • Windows PowerShell:

     $env:RUBYGEMS_HOST = (aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text).TrimEnd("/")

   Die folgende URL ist ein Beispiel für einen Repository-Endpunkt:

   https://my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/

   Anmerkung

   Um einen Dual-Stack-Endpunkt zu verwenden, verwenden Sie den codeartifact.region.on.aws Endpunkt.

3. Um Ruby-Gems in Ihrem Repository zu veröffentlichen, müssen Sie sich CodeArtifact bei authentifizieren, RubyGems indem Sie Ihre ~/.gem/credentials Datei so bearbeiten, dass sie Ihr Authentifizierungstoken enthält. Erstellen Sie ein ~/.gem/ Verzeichnis und eine ~/.gem/credentials Datei, falls das Verzeichnis oder die Datei nicht existiert.

   macOS and Linux

   echo ":codeartifact_api_key: Bearer $CODEARTIFACT_AUTH_TOKEN" >> ~/.gem/credentials

   Windows

   • Windows (unter Verwendung der Standard-Befehlsshell):

     echo :codeartifact_api_key: Bearer %CODEARTIFACT_AUTH_TOKEN% >> %USERPROFILE%/.gem/credentials

   • Windows PowerShell:

     echo ":codeartifact_api_key: Bearer $env:CODEARTIFACT_AUTH_TOKEN" | Add-Content ~/.gem/credentials

4. Um Ruby Gems aus Ihrem Repository gem zu installieren, müssen Sie Ihrer .gemrc Datei die Repository-Endpunktinformationen und das Authentifizierungstoken hinzufügen. Sie können es der Globaldatei (~/.gemrc) oder Ihrer .gemrc Projektdatei hinzufügen. Die CodeArtifact Informationen, die Sie hinzufügen müssen, sind .gemrc eine Kombination aus dem Repository-Endpunkt und dem Authentifizierungstoken. Sie ist wie folgt formatiert:

   https://aws:${CODEARTIFACT_AUTH_TOKEN}@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/

   • Für das Authentifizierungstoken können Sie die CODEARTIFACT_AUTH_TOKEN Umgebungsvariable verwenden, die in einem früheren Schritt festgelegt wurde.

   • Um den Repository-Endpunkt abzurufen, können Sie den Wert der RUBYGEMS_HOST Umgebungsvariablen lesen, die zuvor festgelegt wurde, oder Sie können den folgenden get-repository-endpoint Befehl verwenden und die Werte nach Bedarf ersetzen:

     aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text

   Wenn Sie den Endpunkt gefunden haben, fügen Sie ihn mit einem Texteditor aws:${CODEARTIFACT_AUTH_TOKEN}@ an der entsprechenden Position hinzu. Sobald Sie den Repository-Endpunkt und die Authentifizierungstoken-Zeichenfolge erstellt haben, fügen Sie sie mit dem folgenden echo Befehl zum :sources: Abschnitt Ihrer .gemrc Datei hinzu:

   Warnung

   CodeArtifact unterstützt das Hinzufügen von Repositorys als Quellen mit dem gem sources -add Befehl nicht. Sie müssen die Quelle direkt zur Datei hinzufügen.

   macOS and Linux

   echo ":sources:
       - https://aws:${CODEARTIFACT_AUTH_TOKEN}@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" > ~/.gemrc

   Windows

   • Windows (unter Verwendung der Standard-Befehlsshell):

     echo ":sources:
         - https://aws:%CODEARTIFACT_AUTH_TOKEN%@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" > "%USERPROFILE%\.gemrc"

   • Windows PowerShell:

     echo ":sources:
         - https://aws:$env:CODEARTIFACT_AUTH_TOKEN@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" | Add-Content ~/.gemrc

5. Um Bundler zu verwenden, müssen Sie Bundler mit Ihrer Repository-Endpunkt-URL und Ihrem Authentifizierungstoken konfigurieren, indem Sie den folgenden bundle config Befehl ausführen:

   macOS and Linux

   bundle config $RUBYGEMS_HOST aws:$CODEARTIFACT_AUTH_TOKEN 

   Windows

   • Windows (unter Verwendung der Standard-Befehlsshell):

     bundle config %RUBYGEMS_HOST% aws:%CODEARTIFACT_AUTH_TOKEN%

   • Windows PowerShell:

     bundle config $Env:RUBYGEMS_HOST aws:$Env:CODEARTIFACT_AUTH_TOKEN

Um Ruby-Gems aus einem CodeArtifact Repository zu installieren mit gem

1. Falls nicht, folgen Sie den Schritten unter So konfigurieren Sie die gem CLI so, dass sie Ihr CodeArtifact Repository mit den richtigen Anmeldeinformationen verwendet. Configure RubyGems (gem) und Bundler (bundle) mit CodeArtifact

   Anmerkung

   Das generierte Autorisierungstoken ist 12 Stunden gültig. Sie müssen ein neues erstellen, wenn seit der Erstellung eines Tokens 12 Stunden vergangen sind.

2. Verwenden Sie den folgenden Befehl, um Ruby Gems von zu installieren CodeArtifact:

   gem install my_ruby_gem --version 1.0.0

Um Ruby-Gems aus einem CodeArtifact Repository zu installieren mit bundle

1. Falls nicht, folgen Sie den Schritten unter So konfigurieren Sie die bundle CLI so, dass sie Ihr CodeArtifact Repository mit den richtigen Anmeldeinformationen verwendet. Configure RubyGems (gem) und Bundler (bundle) mit CodeArtifact

   Anmerkung

   Das generierte Autorisierungstoken ist 12 Stunden gültig. Sie müssen ein neues erstellen, wenn seit der Erstellung eines Tokens 12 Stunden vergangen sind.

2. Fügen Sie Ihre CodeArtifact Repository-Endpunkt-URL zu Ihrem Gemfile AS hinzusource, um konfigurierte Ruby-Gems aus Ihrem CodeArtifact Repository und seinen Upstreams zu installieren.

   source "https://my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/"
                   
   gem 'my_ruby_gem'

3. Verwenden Sie den folgenden Befehl, um die Ruby-Gems wie in Ihrem Gemfile angegeben zu installieren:

   bundle install

1. Falls nicht, folgen Sie den Schritten unter So konfigurieren Sie die gem CLI so, dass sie Ihr CodeArtifact Repository mit den richtigen Anmeldeinformationen verwendet. Configure RubyGems (gem) und Bundler (bundle) mit CodeArtifact

   Anmerkung

   Das generierte Autorisierungstoken ist 12 Stunden gültig. Sie müssen ein neues erstellen, wenn seit der Erstellung eines Tokens 12 Stunden vergangen sind.

2. Verwenden Sie den folgenden Befehl, um Ruby-Gems in einem CodeArtifact Repository zu veröffentlichen. Beachten Sie, dass Sie, wenn Sie die RUBYGEMS_HOST Umgebungsvariable nicht festgelegt haben, Ihren CodeArtifact Repository-Endpunkt in der --host Option angeben müssen.

   gem push --key codeartifact_api_key my_ruby_gem-0.0.1.gem