Privates Paket in Dataform authentifizieren

In diesem Dokument erfahren Sie, wie Sie ein privates NPM-Paket in Dataform authentifizieren, um die Installation in einem Dataform-Repository zu ermöglichen.

Wenn Sie ein privates NPM-Paket in einem Dataform-Repository installieren und zum Entwickeln Ihres SQL-Workflows verwenden möchten, müssen Sie das Paket zuerst in Dataform authentifizieren. Der Authentifizierungsprozess unterscheidet sich für das erste private Paket in einem Repository und ein nachfolgendes privates Paket in einem Repository.

Hinweis

  1. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zur Seite „Dataform“

  2. Wählen Sie ein Repository aus oder erstellen Sie ein neues.

  3. Wählen Sie einen Entwicklungsarbeitsbereich aus oder erstellen Sie einen.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen für Repositories und Arbeitsbereiche die IAM-Rolle Dataform Editor (roles/dataform.editor) zuzuweisen, damit Sie die Berechtigungen erhalten, die Sie zum Authentifizieren privater NPM-Pakete in Dataform 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.

Erstes privates Paket in einem Dataform-Repository authentifizieren

Wenn Sie private NPM-Pakete in Dataform authentifizieren möchten, müssen Sie Folgendes tun, bevor Sie das erste private NPM-Paket in einem Dataform-Repository installieren:

  1. Erstellen Sie ein Secret Manager-Secret, um Authentifizierungstokens privater NPM-Pakete im Dataform-Repository zu speichern.

    1. Fügen Sie dem Secret das Authentifizierungstoken des Pakets hinzu, das Sie aus Ihrer NPM-Registry abgerufen haben.

    Sie müssen alle Authentifizierungstokens der privaten NPM-Pakete in Ihrem Repository in einem einzigen Secret speichern. Sie müssen ein eigenes Secret pro Dataform-Repository erstellen. Das Geheimnis muss im JSON-Format vorliegen.

  2. Laden Sie das Secret in das Dataform-Repository hoch.

  3. Erstellen Sie eine .npmrc-Datei und fügen Sie der Datei das Authentifizierungstoken des Pakets hinzu.

    Das Authentifizierungstoken in der .npmrc-Datei muss mit dem Authentifizierungstoken im hochgeladenen Secret übereinstimmen.

Nachdem Sie das private NPM-Paket authentifiziert haben, können Sie es im Dataform-Repository installieren.

Secret für die Authentifizierung privater Pakete erstellen

Wenn Sie private NPM-Pakete in einem Dataform-Repository authentifizieren möchten, müssen Sie ein Secret Manager-Secret erstellen und Authentifizierungstokens für alle privaten Pakete definieren, die Sie im Secret im Dataform-Repository installieren möchten. Definieren Sie ein Authentifizierungstoken pro privates NPM-Paket und speichern Sie alle Authentifizierungstokens in einem einzelnen Secret pro Repository. Das Geheimnis muss im JSON-Format vorliegen.

So erstellen Sie ein Secret mit Authentifizierungstokens für private NPM-Pakete:

  1. Erstellen Sie ein Secret in Secret Manager.

    1. Geben Sie im Feld Secret-Wert ein oder mehrere Authentifizierungstokens im folgenden Format ein:
    {
  "AUTHENTICATION_TOKEN_NAME": "TOKEN_VALUE"
}

    Ersetzen Sie Folgendes:

    • AUTHENTICATION_TOKEN_NAME: Ein eindeutiger Name für das Token, der das zu authentifizierende Paket identifiziert
    • TOKEN_VALUE: der Wert des Authentifizierungstokens, der aus Ihrer NPM-Registry abgerufen wurde

  2. Gewähren Sie dem Dataform-Dienstkonto Zugriff auf das Secret.

    Das Dataform-Dienstkonto hat folgendes Format:

    service-PROJECT_NUMBER@gcp-sa-dataform.iam.gserviceaccount.com
    1. Achten Sie beim Gewähren des Zugriffs darauf, Ihrem Dataform-Dienstkonto die Rolle roles/secretmanager.secretAccessor zuzuweisen.

Geheimes Schlüssel für die Authentifizierung privater Pakete in ein Dataform-Repository hochladen

Bevor Sie ein privates NPM-Paket zum ersten Mal in einem Dataform-Repository installieren, laden Sie das Secret mit dem Authentifizierungstoken des Pakets in das Repository hoch.

So laden Sie das Secret mit den Authentifizierungstokens für private NPM-Pakete in ein Dataform-Repository hoch:

  1. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zu Dataform

  2. Wählen Sie das Repository aus, in dem Sie private NPM-Pakete installieren möchten.

  3. Klicken Sie auf der Repository-Seite auf Einstellungen > Private NPM-Pakete konfigurieren.

  4. Wählen Sie im Bereich Secret-Token für npm-Paket hinzufügen im Drop-down-Menü Secret das Secret mit den Authentifizierungstokens für private npm-Pakete aus.

  5. Klicken Sie auf Speichern.

.npmrc-Datei zur Authentifizierung privater Pakete erstellen

Wenn Sie private NPM-Pakete in einem Dataform-Repository authentifizieren möchten, müssen Sie im Repository eine .npmrc-Datei auf oberster Ebene erstellen. Sie müssen Authentifizierungstokens für alle privaten NPM-Pakete speichern, die im Repository in der .npmrc-Datei installiert werden sollen. Die Authentifizierungstokens in der Datei .npmrc müssen mit den Authentifizierungstokens in dem Geheimnis übereinstimmen, das in das Repository hochgeladen wurde. Weitere Informationen zu .npmrc-Dateien finden Sie in der npmrc-Dokumentation.

So erstellen Sie eine .npmrc-Datei der obersten Ebene in Ihrem Repository:

  1. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zu Dataform

  2. Wählen Sie das Repository aus, in dem Sie private NPM-Pakete installieren möchten, und dann einen Arbeitsbereich.

  3. Klicken Sie im Bereich Dateien auf das Dreipunkt-Menü  Mehr und dann auf Datei erstellen.

  4. Führen Sie im Bereich Neue Datei erstellen die folgenden Schritte aus:

    1. Geben Sie im Feld Dateipfad hinzufügen .npmrc ein.

    2. Klicken Sie auf Datei erstellen.

Datei .npmrc in einem Dataform-Repository ein Authentifizierungstoken hinzufügen

Wenn Sie ein privates NPM-Paket in einem Dataform-Repository authentifizieren möchten, das bereits ein Secret mit Paketauthentifizierungstokens und eine .npmrc-Datei enthält, müssen Sie der .npmrc-Datei im Repository das Authentifizierungstoken für das private Paket hinzufügen.

In der Datei .npmrc müssen Sie den Umfang Ihrer NPM-Registry definieren und das Authentifizierungstoken für das private Paket hinzufügen, auf das in diesem Umfang zugegriffen wird. Weitere Informationen zu .npmrc-Dateien finden Sie in der npmrc-Dokumentation.

Das Authentifizierungstoken in der Datei .npmrc muss mit dem Authentifizierungstoken in dem Secret übereinstimmen, das in das Repository hochgeladen wurde.

So fügen Sie der Datei .npmrc in einem Dataform-Repository ein Authentifizierungstoken hinzu:

  1. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zu Dataform

  2. Wählen Sie das Repository aus, in dem Sie private NPM-Pakete installieren möchten, und dann einen Arbeitsbereich.

  3. Wählen Sie im Bereich Dateien die Datei .npmrc aus.

  4. Definieren Sie in der Datei .npmrc den NPM-Registry-Umfang und das Authentifizierungstoken für das private Paket im folgenden Format:

   @REGISTRY-SCOPE:registry=NPM-REGISTRY-URL
   NPM-REGISTRY-URL:_authToken=$AUTHENTICATION-TOKEN

Ersetzen Sie Folgendes:

  • REGISTRY-SCOPE: der NPM-Registrybereich, auf den Sie das Authentifizierungstoken anwenden möchten
  • NPM-REGISTRY-URL: die URL Ihrer NPM-Registry, z. B. https://npm.pkg.github.com

  • AUTHENTICATION-TOKEN: das Authentifizierungstoken für das private NPM-Paket. Das Authentifizierungstoken in der Datei .npmrc muss mit dem Authentifizierungstoken im hochgeladenen Secret übereinstimmen. Das Authentifizierungstoken wird in der Datei .npmrc als Umgebungsvariable angegeben. Fügen Sie also die öffnenden Klammern ${ und die schließenden Klammern } hinzu.

    Sie können mehrere Authentifizierungstokens eingeben.

Das folgende Codebeispiel zeigt ein Authentifizierungstoken für ein privates NPM-Paket, das der Datei .npmrc in einem Dataform-Repository hinzugefügt wurde:

@company:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${AUTHENTICATION_TOKEN}

Ein nachfolgendes privates Paket in einem Dataform-Repository authentifizieren

So authentifizieren Sie ein privates NPM-Paket in einem Dataform-Repository, das bereits ein Secret mit Paketauthentifizierungstokens und eine .npmrc-Datei enthält:

  1. Liste die Secrets in Secret Manager auf und wähle das Secret aus, in dem die Authentifizierungstokens der privaten NPM-Pakete deines Repositories gespeichert sind.

  2. Fügen Sie dem Secret eine neue Version hinzu.

    Dataform verwendet standardmäßig die neueste Version des Secrets.

    1. Fügen Sie dem geheimen Wert das Authentifizierungstoken für das private Paket im folgenden Format hinzu:
    {
  "AUTHENTICATION_TOKEN_NAME": "TOKEN_VALUE"
}

    Ersetzen Sie Folgendes:

    • AUTHENTICATION_TOKEN_NAME: Ein eindeutiger Name für das Token, der das zu authentifizierende Paket identifiziert
    • TOKEN_VALUE: der Wert des Authentifizierungstokens, der aus Ihrer NPM-Registry abgerufen wurde

    Sie können mehrere Authentifizierungstokens gleichzeitig hinzufügen.

  3. Fügen Sie in Dataform das Authentifizierungstoken der Datei .npmrc in Ihrem Repository hinzu.

Nachdem Sie das private NPM-Paket authentifiziert haben, können Sie das Paket im Dataform-Repository installieren.

Nächste Schritte