Autentica un pacchetto privato in Dataform

Questo documento mostra come autenticare un pacchetto NPM privato in Dataform per abilitarne l'installazione in un repository Dataform.

Per installare un pacchetto NPM privato in un repository Dataform e utilizzarlo per sviluppare il flusso di lavoro SQL, devi prima autenticare il pacchetto in Dataform. Il processo di autenticazione è diverso per il primo pacchetto privato in un repository e per un pacchetto privato successivo in un repository.

Prima di iniziare

  1. Nella console Google Cloud, vai alla pagina Dataform.

    Vai alla pagina Dataform

  2. Seleziona o crea un repository.

  3. Seleziona o crea un'area di lavoro di sviluppo.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per autenticare i pacchetti di Gestione dei partner di rete privati in Dataform, chiedi all'amministratore di concederti il ruolo IAM Editor Dataform (roles/dataform.editor) per i repository e le aree di lavoro. Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso.

Potresti anche essere in grado di ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Autentica il primo pacchetto privato in un repository Dataform

Per autenticare i pacchetti di Gestione dei partner di rete privati in Dataform, devi eseguire le seguenti operazioni prima di installare il primo pacchetto NPM privato in un repository Dataform:

  1. Crea un secret Secret Manager dedicato all'archiviazione dei token di autenticazione dei pacchetti di Gestione dei partner di rete privati nel repository Dataform.

    1. Aggiungi al secret il token di autenticazione del pacchetto, ottenuto dal registro Gestione dei partner di rete.

    Devi archiviare tutti i token di autenticazione dei pacchetti di Gestione dei partner di rete privati nel tuo repository in un singolo secret. devi creare un secret dedicato per un repository Dataform. Il secret deve essere in formato JSON.

  2. Carica il secret nel repository Dataform.

  3. Crea un file .npmrc e aggiungi al file il token di autenticazione del pacchetto.

    Il token di autenticazione nel file .npmrc deve corrispondere al token di autenticazione nel secret caricato.

Dopo aver autenticato il pacchetto NPM privato, puoi installare il pacchetto nel repository Dataform.

Creazione di un secret per l'autenticazione dei pacchetti privati

Per autenticare i pacchetti privati di Gestione dei partner di rete in un repository Dataform, devi creare un secret Secret Manager e definire i token di autenticazione per tutti i pacchetti privati che vuoi installare nel repository Dataform all'interno del secret. Definisci un token di autenticazione per ogni pacchetto NPM privato e archivia tutti i token di autenticazione in un singolo secret per repository. Il secret deve essere in formato JSON.

Per creare un secret con token di autenticazione per i pacchetti di Gestione dei partner di rete privati, segui questi passaggi:

  1. In Secret Manager, crea un secret.

    1. Nel campo Valore secret, inserisci uno o più token di autenticazione nel seguente formato:
    {
  "AUTHENTICATION_TOKEN_NAME": "TOKEN_VALUE"
}

    Sostituisci quanto segue:

    • AUTHENTICATION_TOKEN_NAME: nome univoco per il token che identifica il pacchetto che autentica
    • TOKEN_VALUE: il valore del token di autenticazione, ottenuto dal registro di Gestione dei partner di rete

  2. Concedi l'accesso al secret al tuo account di servizio Dataform.

    Il tuo account di servizio Dataform ha il seguente formato:

    service-PROJECT_NUMBER@gcp-sa-dataform.iam.gserviceaccount.com
    1. Quando concedi l'accesso, assicurati di concedere il ruolo roles/secretmanager.secretAccessor al tuo account di servizio Dataform.

Carica il secret per l'autenticazione dei pacchetti privati in un repository Dataform

Prima di installare per la prima volta un pacchetto NPM privato in un repository Dataform, carica nel repository il secret contenente il token di autenticazione del pacchetto.

Per caricare il secret con token di autenticazione dei pacchetti di Gestione dei partner di rete privati in un repository Dataform, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Dataform.

    Vai a Dataform

  2. Seleziona il repository in cui vuoi installare i pacchetti di Gestione dei partner di rete privati.

  3. Nella pagina del repository, fai clic su Impostazioni > Configura pacchetti di Gestione dei partner di rete privati.

  4. Nel riquadro Aggiungi token segreto del pacchetto NPM, nell'elenco a discesa Segreto, seleziona il secret contenente i token di autenticazione per i pacchetti di Gestione dei partner di rete privati.

  5. Fai clic su Salva.

Crea un file .npmrc per l'autenticazione dei pacchetti privati

Per autenticare i pacchetti di Gestione dei partner di rete privati in un repository Dataform, devi creare un file .npmrc di primo livello nel repository. Devi archiviare i token di autenticazione per tutti i pacchetti di Gestione dei partner di rete privati da installare nel repository all'interno del file .npmrc. I token di autenticazione nel file .npmrc devono corrispondere a quelli contenuti nel secret caricato nel repository. Per ulteriori informazioni sui file .npmrc, consulta la documentazione npmrc.

Per creare un file .npmrc di primo livello nel repository, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Dataform.

    Vai a Dataform

  2. Seleziona il repository in cui vuoi installare pacchetti di Gestione dei partner di rete privati, quindi seleziona un'area di lavoro.

  3. Nel riquadro File, fai clic sul menu Altro , quindi su Crea file.

  4. Nel riquadro Crea nuovo file, procedi nel seguente modo:

    1. Nel campo Aggiungi un percorso file, inserisci .npmrc.

    2. Fai clic su Crea file.

Aggiungi un token di autenticazione al file .npmrc in un repository Dataform

Per autenticare un pacchetto NPM privato in un repository Dataform che contiene già un secret con token di autenticazione dei pacchetti e un file .npmrc, devi aggiungere il token di autenticazione per il pacchetto privato al file .npmrc nel repository.

Nel file .npmrc devi definire l'ambito del registro di Gestione dei partner di rete e aggiungere il token di autenticazione per il pacchetto privato a cui si accede in quell'ambito. Per ulteriori informazioni sui file .npmrc, consulta la documentazione npmrc.

Il token di autenticazione nel file .npmrc deve corrispondere a quello nel secret caricato nel repository.

Per aggiungere un token di autenticazione al file .npmrc in un repository Dataform, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Dataform.

    Vai a Dataform

  2. Seleziona il repository in cui vuoi installare pacchetti di Gestione dei partner di rete privati, quindi seleziona un'area di lavoro.

  3. Nel riquadro File, seleziona il file .npmrc.

  4. Nel file .npmrc, definisci l'ambito del Registro di sistema di Gestione dei partner di rete e il token di autenticazione per il pacchetto privato nel seguente formato:

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

Sostituisci quanto segue:

  • REGISTRY-SCOPE: l'ambito del registro NPM a cui vuoi applicare il token di autenticazione
  • NPM-REGISTRY-URL: l'URL del registro di Gestione dei partner di rete, ad esempio https://npm.pkg.github.com

  • AUTHENTICATION-TOKEN: il token di autenticazione per il pacchetto NPM privato. Il token di autenticazione nel file .npmrc deve corrispondere a quello nel secret caricato. Il token di autenticazione viene fornito come variabile di ambiente nel file .npmrc, quindi assicurati di aggiungere le parentesi di apertura ${ e }.

    Puoi inserire più token di autenticazione.

Il seguente esempio di codice mostra un token di autenticazione per un pacchetto NPM privato aggiunto al file .npmrc in un repository Dataform:

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

Autentica un pacchetto privato successivo in un repository Dataform

Per autenticare un pacchetto NPM privato in un repository Dataform che contiene già un secret con i token di autenticazione dei pacchetti e un file .npmrc, segui questi passaggi:

  1. In Secret Manager, elenca i secret e seleziona il secret che archivia i token di autenticazione dei pacchetti di Gestione dei partner di rete privati del tuo repository.

  2. Aggiungi una nuova versione al secret.

    Dataform utilizza la versione più recente del secret per impostazione predefinita.

    1. Aggiungi il token di autenticazione per il pacchetto privato al valore del secret nel seguente formato:
    {
  "AUTHENTICATION_TOKEN_NAME": "TOKEN_VALUE"
}

    Sostituisci quanto segue:

    • AUTHENTICATION_TOKEN_NAME: nome univoco per il token che identifica il pacchetto che autentica
    • TOKEN_VALUE: il valore del token di autenticazione, ottenuto dal registro di Gestione dei partner di rete

    Puoi aggiungere più token di autenticazione contemporaneamente.

  3. In Dataform, aggiungi il token di autenticazione al file .npmrc nel tuo repository.

Dopo aver autenticato il pacchetto NPM privato, puoi installare il pacchetto nel repository Dataform.

Passaggi successivi