Node.js-Pakete in Artifact Registry speichern

Node.js-Pakete in Artifact Registry speichern

In dieser Kurzanleitung wird gezeigt, wie Sie ein privates Artifact Registry-Repository für Node.js-Pakete einrichten und ein Paket in dieses hochladen.

Hinweis

Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie noch kein Google Cloud-Kunde sind, erstellen Sie ein Konto, um zu sehen, wie sich unsere Produkte in realen Szenarien schlagen. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Installieren Sie die Google Cloud CLI.

Hinweis: Wenn Sie die gcloud CLI zuvor installiert haben, prüfen Sie, ob Sie die aktuelle Version haben, indem Sie gcloud components update ausführen.

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

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Installieren Sie die Google Cloud CLI.

Hinweis: Wenn Sie die gcloud CLI zuvor installiert haben, prüfen Sie, ob Sie die aktuelle Version haben, indem Sie gcloud components update ausführen.

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

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

1. Installieren Sie PowerShell, wenn Sie von Windows eine Verbindung zu einem Node.js-Paket-Repository herstellen möchten.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die Artifact Registry-Administrator (roles/artifactregistry.admin) IAM-Rolle für Ihr Projekt zu erteilen, um die Berechtigungen zu erhalten, die Sie zum Erstellen und Verwalten von Artifact Registry-Repositories für Node.js-Pakete benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Cloud Shell starten

In dieser Kurzanleitung verwenden Sie Cloud Shell, eine Shellumgebung für die Verwaltung von Ressourcen, die in gehostet werden Google Cloud.

Die Google Cloud CLI ist in Cloud Shell vorinstalliert. Die gcloud CLI bietet die primäre Befehlszeile für Google Cloud.

Cloud Shell aufrufen

1. Zur Google Cloud Console.

   Google Cloud Console

2. Klicken Sie in der Google Cloud Symbolleiste derConsole auf Cloud Shell aktivieren:

In einem Frame im unteren Teil der Console wird eine Cloud Shell-Sitzung geöffnet. Mit dieser Shell führen Sie gcloud-Befehle aus.

Node.js-Paket-Repository erstellen

Erstellen Sie das Repository für Ihre Node.js-Artefakte:

1. Im Folgenden wird gezeigt, wie Sie das Repository anlegen.

   Console

   1. Öffnen Sie in der Google Cloud console die Seite Repositories.

      Zur Seite „Repositories“

   2. Klicken Sie auf Repository erstellen.

   3. Geben Sie quickstart-nodejs-repo als Repository-Namen an.

   4. Wählen Sie npm als Format und Standard als Modus aus.

   5. Wählen Sie unter Standorttyp die Option Region und dann den Standort us-central1 aus.

   6. Klicken Sie auf Erstellen.

   Das Repository wird der Repository-Liste hinzugefügt.

   gcloud

   1. Führen Sie den folgenden Befehl aus, um ein neues Node.js-Paket-Repository mit dem Namen quickstart-nodejs-repo am Standort us-central1 mit der Beschreibung „Node.js repository“ zu erstellen.

      gcloud artifacts repositories create quickstart-nodejs-repo --repository-format=npm \
      --location=us-central1 --description="Node.js package repository"
      

   2. Führen Sie den folgenden Befehl aus, um zu prüfen, ob Ihr Repository erstellt wurde:

      gcloud artifacts repositories list
      

   Weitere Informationen zu Artifact Registry-Befehlen erhalten Sie mit dem Befehl gcloud artifacts.

2. Um die gcloud-Befehle zu vereinfachen, legen Sie für das Standard-Repository den Wert quickstart-nodejs-repo und für den Standard-Speicherort us-central1 fest. Nachdem Sie die Werte festgelegt haben, müssen Sie diese nicht mehr in gcloud-Befehlen angeben, für die ein Repository oder Speicherort erforderlich ist.

   Führen Sie den folgenden Befehl aus, um das Repository festzulegen:

   gcloud config set artifacts/repository quickstart-nodejs-repo
   

   Führen Sie den folgenden Befehl aus, um den Standort festzulegen:

   gcloud config set artifacts/location us-central1
   

   Weitere Informationen zu diesen Befehlen finden Sie in der Dokumentation zu gcloud config set.

npm konfigurieren

Zum Hochladen und Herunterladen von Paketen müssen Sie Ihre npm-Projekte mit Einstellungen für die Authentifizierung beim erstellten Repository konfigurieren. In dieser Kurzanleitung laden Sie ein Paket hoch und installieren es dann als Abhängigkeit in einem zweiten Paket.

1. Laden Sie das Paket emoji-regex herunter. Dieses Paket enthält einen regulären Ausdruck, der mit allen Emoji-Symbolen und -Sequenzen übereinstimmt.

   npm pack emoji-regex
   

   Mit dem Befehl wird ein Archiv des Pakets heruntergeladen.

2. Extrahieren Sie das Archiv in ein Verzeichnis emoji-regex. Der folgende Befehl gilt für ein Archiv von emoji-regex Version 10.1.0:

   mkdir emoji-regex && tar xvf emoji-regex-10.1.0.tgz -C emoji-regex --strip-components 1
   

3. Erstellen Sie ein zweites npm-Paket, mit dem Sie das Paket emoji-regex aus Artifact Registry installieren. Verwenden Sie für dieses Paket den Befehl npm init, um ein einfaches Paket zu erstellen.

   mkdir npm-package2
   cd npm-package2
   
   npm init -y
   

   Übernehmen Sie bei der Aufforderung die Standardwerte.

4. Konfigurieren Sie sowohl das Projekt emoji-regex als auch das Projekt npm-package2 für die Authentifizierung beim erstellten Artifact Registry-Repository.

   1. Führen Sie den folgenden Befehl aus: Der Befehl gibt Konfigurationseinstellungen zurück, die Ihrer npm-Konfigurationsdatei hinzugefügt werden können.

      gcloud artifacts print-settings npm --scope=@quickstart
      

      Der quickstart Bereich ist mit Ihrem Repository verknüpft. Wenn Sie den Bereich in Befehle zum Veröffentlichen oder Installieren von Paketen einfügen, verwendet npm Ihr Repository. Wenn Sie Pakete ohne Bereich veröffentlichen oder installieren, wird Ihr konfiguriertes Standard-Repository verwendet. Weitere Informationen finden Sie in der Übersicht zu Node.js overview.

      Die Ausgabe des gcloud-Befehls sieht so aus wie im folgenden Beispiel. PROJECT ist Ihre Google Cloud Projekt-ID.

      @quickstart:registry=https://us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/
      //us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/:always-auth=true
      

   2. Fügen Sie die Konfigurationseinstellungen aus dem vorherigen Schritt der Datei .npmrc des Projekts in jedem npm-Projekt hinzu. Die Datei befindet sich im selben Verzeichnis wie die Datei package.json.

      Weitere Informationen zur Datei .npmrc finden Sie in der Übersicht zu Node.js overview.

      Jedes Artifact Registry-Repository für Node.js-Pakete ist mit einem npm Registry-Endpunkt https://LOCATION-npm.pkg.dev/PROJECT/REPOSITORY verknüpft. Wenn Sie ein weiteres Artifact Registry-Repository für Node.js-Pakete erstellen, nutzt npm dieses Repository als separate Registry mit eigenem Bereich.

5. Bearbeiten Sie package.json sowohl im Projekt emoji-regex als auch im Projekt npm-package2.

   1. Achten Sie darauf, dass der Wert für name den Bereich quickstart enthält.

      • Für emoji-regex:

      "name": "@quickstart/emoji-regex"
      

      • Für npm-package2:

      "name": "@quickstart/npm-package2"
      

   2. Fügen Sie unter scripts ein Skript für google-artifactregistry-auth hinzu. Diese Clientbibliothek aktualisiert Anmeldedaten für Artifact Registry-Repositories.

      "scripts": {
        "artifactregistry-login": "npx google-artifactregistry-auth --repo-config=./.npmrc --credential-config=./.npmrc"
      }
      

Paket in das Repository hochladen

1. Aktualisieren Sie das Zugriffstoken für die Verbindung mit dem Repository.

   npm run artifactregistry-login
   

2. Fügen Sie das Paket dem Repository hinzu. Sie können dazu einen npm- oder yarn-Befehl verwenden.

   npm publish
   

   yarn publish
   

Paket im Repository aufrufen

So prüfen Sie, ob das Paket dem Repository hinzugefügt wurde:

Console

1. Öffnen Sie in der Google Cloud console die Seite Repositories.

   Zur Seite „Repositories“

2. Klicken Sie in der Repository-Liste auf das Repository quickstart-nodejs-repo.

   Auf der Seite Pakete sind die Pakete des Repositorys aufgeführt.

3. Klicken Sie auf ein Paket, um die Paketversionen aufzurufen.

gcloud

Um die Images im Standard-Repository quickstart-nodejs-repo aufzulisten, führen Sie folgenden Befehl aus:

 gcloud artifacts packages list

Um die Versionen für ein Paket aufzurufen, führen Sie folgenden Befehl aus:

gcloud artifacts versions list --package=PACKAGE

Dabei ist PACKAGE die Paket-ID.

Pakete installieren

Installieren Sie das Paket emoji-regex aus Ihrem Artifact Registry-Repository in npm-package2.

Führen Sie im Verzeichnis npm-package2 den Befehl npm install oder yarn add aus:

npm install @quickstart/emoji-regex

yarn add @quickstart/emoji-regex

Mit dem Befehl wird das Paket emoji-regex im Projekt npm-package2 installiert. Außerdem wird package.json aktualisiert, um emoji-regex als Abhängigkeit festzulegen.

"dependencies": {
  "@quickstart/emoji-regex": "^10.1.0"
}

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud -Konto die auf dieser Seite verwendeten Ressourcen in Rechnung gestellt werden:

Prüfen Sie vor dem Entfernen eines Repositorys, ob alle Pakete, die Sie beibehalten möchten, an einem anderen Speicherort verfügbar sind.

So löschen Sie das Repository:

Console

1. Öffnen Sie in der Google Cloud console die Seite Repositories.

   Zur Seite „Repositories“

2. Wählen Sie in der Repository-Liste das Repository quickstart-nodejs-repo aus.

3. Klicken Sie auf Löschen.

gcloud

1. Um das Repository quickstart-nodejs-repo zu löschen, führen Sie folgenden Befehl aus:

   gcloud artifacts repositories delete quickstart-nodejs-repo
   

2. Wenn Sie die Einstellungen für das Standard-Repository und den Standard-Speicherort entfernen möchten, die Sie für die aktive gcloud-Konfiguration festgelegt haben, führen Sie die folgenden Befehle aus:

   gcloud config unset artifacts/repository
   gcloud config unset artifacts/location
   

Nächste Schritte

• Authentifizierung konfigurieren
• Repositories verwalten
• Pakete verwalten
• Lesen Sie unser Infomaterial zu DevOps und informieren Sie sich über unser Forschungsprogramm.