Configurare l'autenticazione per Helm

Questa pagina descrive come configurare Helm per eseguire l'autenticazione con i repository Artifact Registry.

Prima di iniziare

  1. Se non esiste un repository per i tuoi grafici, creane uno nuovo. Scegli Docker come formato del repository.

  2. Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init
  3. (Facoltativo) Configura i valori predefiniti per i comandi Google Cloud CLI.

  4. Installa Helm 3.8.0 o versioni successive. Nelle versioni precedenti di Helm, il supporto dei grafici in formato OCI è una funzionalità sperimentale.

    Esegui helm version per verificare la versione.

Scelta di un metodo di autenticazione

Nella maggior parte dei casi, ti consigliamo di utilizzare un account di servizio per autenticarti in Artifact Registry.

Sono disponibili i seguenti metodi di autenticazione:

Utilizzare le credenziali di Artifact Registry configurate per Docker
Per impostazione predefinita, Helm può autenticarsi con le stesse credenziali che utilizzi per Docker.
Token di accesso
Le
credenziali predefinite dell'applicazione forniscono token di accesso di breve durata che un account di servizio utilizza per accedere alle tue Google Cloud risorse.
File di chiavi JSON

Una coppia di chiavi gestita dall'utente che puoi utilizzare come credenziale per un account di servizio. Poiché la credenziale è permanente, è l'opzione meno sicura tra tutti i metodi di autenticazione disponibili.

Se possibile, utilizza un token di accesso per ridurre il rischio di accessi non autorizzati ai tuoi elementi.

Utilizzo della configurazione Docker

Per impostazione predefinita, Helm supporta le impostazioni del registry nel file di configurazione Docker config.json. Helm trova le impostazioni del registry nella posizione predefinita o in quella specificata dalla variabile di ambiente DOCKER_CONFIG.

Se hai configurato Docker con un assistente alle credenziali per eseguire l'autenticazione con Artifact Registry, Helm utilizza la configurazione esistente per i repository Docker di Artifact Registry.

Utilizzo di un token di accesso

I token di accesso sono token a breve durata che forniscono l'accesso alle tue Google Cloud risorse. Poiché il token ha una durata breve, devi richiederlo meno di un'ora prima di utilizzarlo per connetterti ai repository Artifact Registry.

Google Cloud ottiene un token di accesso utilizzando le Credenziali predefinite dell'applicazione.

Per utilizzare un token di accesso:

  1. Crea un account di servizio per agire per conto della tua applicazione o scegli un account di servizio esistente che utilizzi per l'automazione.

    Per configurare l'autenticazione con Artifact Registry, devi conoscere la posizione del file della chiave dell'account di servizio. Per gli account esistenti, puoi visualizzare le chiavi e crearne di nuove nella pagina Account di servizio.

    Vai alla pagina Account di servizio

  2. Concedi il ruolo Artifact Registry appropriato all'account di servizio per fornire l'accesso al repository.

  3. Assegna il percorso del file della chiave dell'account di servizio alla variabile GOOGLE_APPLICATION_CREDENTIALS in modo che l'helper per le credenziali di Artifact Registry possa ottenere la chiave quando si connette ai repository.

    export GOOGLE_APPLICATION_CREDENTIALS=KEY-FILE

    dove KEY-FILE è il percorso del file della chiave dell'account di servizio.

  4. Ottieni un token di accesso come credenziali quando esegui l'autenticazione su Artifact Registry con Docker.

    Linux / macOS

    Esegui questo comando:

    gcloud auth application-default print-access-token | helm registry login -u oauth2accesstoken \
--password-stdin https://LOCATION-docker.pkg.dev

    Windows

    Esegui questo comando:

    gcloud auth application-default print-access-token
ya29.8QEQIfY_...

helm registry login -u oauth2accesstoken -p "ya29.8QEQIfY_..." \
https://LOCATION-docker.pkg.dev

    Dove

    • oauth2accesstoken è il nome utente da utilizzare per l'autenticazione con un token di accesso.
    • gcloud auth application-default print-access-token è il comando Google Cloud CLI per ottenere il token di accesso per l'account di servizio. Il token di accesso è la password per l'autenticazione.
    • LOCATION è la posizione regionale o multiregionale del repository.

Helm è ora autenticato con Artifact Registry.

Utilizzo di un file di chiavi JSON

Chiunque abbia accesso a una chiave privata valida per un account di servizio potrà accedere alle risorse tramite l'account di servizio. Tieni presente che il ciclo di vita dell'accesso della chiave all'account di servizio (e quindi ai dati a cui ha accesso l'account di servizio) è indipendente dal ciclo di vita dell'utente che ha scaricato la chiave.

Utilizza le seguenti linee guida per limitare l'accesso ai tuoi repository:

  • Crea account di servizio dedicati che vengono utilizzati solo per interagire con i repository.
  • Concedi il ruolo Artifact Registry specifico per l'accesso richiesto dall'account di servizio. Ad esempio, un account di servizio che scarica solo gli elementi richiede solo il ruolo Artifact Registry Reader.
  • Configura le autorizzazioni per i tuoi account di servizio dedicati su ogni repository anziché a livello di progetto. Puoi quindi specificare l'accesso in base al contesto del repository. Ad esempio, un account di servizio per le build di sviluppo potrebbe avere il ruolo Lettore di Artifact Registry per un repository di produzione e il ruolo Writer di Artifact Registry per un repository di staging.
  • Segui le best practice per la gestione delle chiavi degli account di servizio.

Per creare un nuovo account di servizio e una chiave dell'account di servizio da utilizzare solo con i repository Artifact Registry:

  1. Crea un account di servizio per agire per conto della tua applicazione o scegli un account di servizio esistente che utilizzi per l'automazione.

    Per configurare l'autenticazione con Artifact Registry, devi conoscere la posizione del file della chiave dell'account di servizio. Per gli account esistenti, puoi visualizzare le chiavi e crearne di nuove nella pagina Account di servizio.

    Vai alla pagina Account di servizio

  2. Se vuoi, puoi codificare in base64 tutti i contenuti del file della chiave.

    Linux

    base64 FILE-NAME > NEW-FILE-NAME

    macOS

    base64 -i FILE-NAME -o NEW-FILE-NAME

    Windows

    Base64.exe -e FILE-NAME > NEW-FILE-NAME

    dove FILE-NAME è il nome file della chiave originale e NEW-FILE-NAME è il file della chiave codificato in base64.

  3. Concedi il ruolo Artifact Registry appropriato all'account di servizio per fornire l'accesso al repository.

  4. Utilizza la chiave dell'account di servizio per l'autenticazione:

    Linux / macOS

    Esegui questo comando:

    cat KEY-FILE | helm registry login -u KEY-TYPE --password-stdin \
https://LOCATION-docker.pkg.dev

    Windows

    Esegui questo comando:

    helm registry login -u KEY-TYPE --password-stdin https://LOCATION-docker.pkg.dev < KEY-FILE

    Dove

    • KEY-TYPE è uno dei seguenti:
      • _json_key se utilizzi la chiave dell'account di servizio in formato JSON come fornito al momento della creazione del file.
      • _json_key_base64 se hai codificato in base64 tutti i contenuti del file.
    • KEY-FILE è il nome del file della chiave dell'account di servizio in formato JSON.
    • LOCATION è la posizione regionale o multiregionale del repository.

Helm è ora autenticato con Artifact Registry.

Passaggi successivi