Archiviare i grafici Helm in Artifact Registry

Helm è il gestore di pacchetti per Kubernetes. Artifact Registry consente di archiviare e gestire i grafici Helm nei repository in formato Docker per controllare le versioni ed eseguire il deployment delle risorse Kubernetes. In questa guida rapida, creerai un repository privato, creerai un pacchetto e invierai un grafico di esempio ed eseguirai il deployment di una release in un cluster.

Prima di iniziare

  1. Accedi al tuo account Google Cloud . Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei carichi di lavoro.

  2. 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.

    Go to project selector

  3. 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.

  4. Verify that billing is enabled for your Google Cloud project.

  5. Enable the Artifact Registry, Google Kubernetes Engine APIs, if any are not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

  6. 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.

    Go to project selector

  7. 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.

  8. Verify that billing is enabled for your Google Cloud project.

  9. Enable the Artifact Registry, Google Kubernetes Engine APIs, if any are not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

    10.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per creare e gestire grafici Helm nei repository di pacchetti Docker di Artifact Registry, chiedi all'amministratore di concederti il ruolo IAM Artifact Registry Administrator (roles/artifactregistry.admin) sul tuo progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Scegliere una shell

Per completare questa guida rapida, utilizza Cloud Shell o la shell locale.

Cloud Shell
Cloud Shell è un ambiente shell per la gestione delle risorse ospitate su Google Cloud. È preinstallato con Docker, Helm e Google Cloud CLI, l'interfaccia a riga di comando principale per Google Cloud.
Shell locale
Se preferisci utilizzare la shell locale, devi installare Docker e gcloud CLI nel tuo ambiente.

Avviare Cloud Shell

Per avviare Cloud Shell, segui questi passaggi:

  1. Vai alla console Google Cloud .

    Google Cloud console

  2. Fai clic sul pulsante Attiva Cloud Shell: .

    Una sessione di Cloud Shell si apre in un frame nella parte inferiore della console. Utilizza questa shell per eseguire i comandi gcloud.

  3. 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.

Configurazione di una shell locale

Per installare gcloud CLI e Helm, segui questi passaggi:

  1. Installa gcloud CLI. Per aggiornare un'installazione esistente, esegui il comando gcloud components update.

  2. 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.

Crea un repository

Crea un repository Docker per archiviare il grafico di esempio per questa guida rapida.

Console

  1. Apri la pagina Repository nella console Google Cloud .

    Apri la pagina Repositori

  2. Fai clic su Crea repository.

  3. Specifica quickstart-helm-repo come nome del repository.

  4. Scegli Docker come formato.

  5. In Tipo di località, seleziona Regione, quindi scegli la località us-west1.

  6. Fai clic su Crea.

Il repository viene aggiunto all'elenco dei repository.

gcloud

  1. Esegui il comando seguente per creare un nuovo repository Docker denominato quickstart-helm-repo nella località us-west1 con la descrizione "docker repository".

    gcloud artifacts repositories create quickstart-helm-repo --repository-format=docker \
--location=us-west1 --description="Helm repository"

  2. Esegui questo comando per verificare che il repository sia stato creato.

    gcloud artifacts repositories list

Per ulteriori informazioni sui comandi di Artifact Registry, esegui il comando gcloud artifacts.

Creare un grafico

Per questa guida rapida, creerai un grafico di esempio denominato hello-chart.

  1. Passa a una directory in cui vuoi creare il grafico.

  2. Esegui questo comando per creare il grafico:

    helm create hello-chart

    Helm crea una directory denominata hello-chart con un insieme predefinito di file del grafico. Uno dei file è Chart.yaml, che include informazioni sul grafico.

  3. Pacchettizza il grafico in un archivio.

    helm package hello-chart/

    Helm crea un archivio denominato hello-chart-0.1.0.tgz utilizzando il nome del grafico e il numero di versione in Chart.yaml.

Esegui l'autenticazione con il repository

Prima di poter eseguire il push o l'installazione delle immagini, Helm deve autenticarsi in Artifact Registry.

Helm può utilizzare le impostazioni del registro esistenti in un file di configurazione Docker. Se non hai ancora configurato Docker per l'utilizzo con Artifact Registry, puoi eseguire l'autenticazione con un token di accesso per questa guida rapida.

Per saperne di più sull'autenticazione, consulta Configurazione dell'autenticazione per Helm.

Esegui l'autenticazione con la configurazione Docker

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

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

Autenticarsi con un token di accesso

Per eseguire l'autenticazione con un token di accesso:

  1. Ottieni un token di accesso come credenziali quando esegui l'autenticazione in Artifact Registry con Helm.

    Linux / macOS

    Esegui questo comando:

    gcloud auth print-access-token | helm registry login -u oauth2accesstoken \
--password-stdin us-west1-docker.pkg.dev

    Windows

    Esegui questo comando:

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

helm registry login -u oauth2accesstoken -p "ya29.8QEQIfY_..." \
us-west1-docker.pkg.dev/PROJECT-ID/REPOSITORY

    Dove

    • oauth2accesstoken è il nome utente da utilizzare per l'autenticazione con un token di accesso.
    • gcloud auth print-access-token è il comando gcloud per ottenere il token di accesso. Il token di accesso è la password per l'autenticazione.

Helm ora è autenticato con Artifact Registry. Ora puoi eseguire il push del grafico nel repository.

Esegui il push del grafico in Artifact Registry

Dopo aver creato l'archivio del grafico e aver eseguito l'autenticazione al repository Artifact Registry, puoi eseguire il push del grafico nel repository.

Per eseguire il push del grafico, esegui questo comando:

helm push hello-chart-0.1.0.tgz oci://us-west1-docker.pkg.dev/PROJECT/quickstart-helm-repo

Sostituisci PROJECT con l'ID progetto Google Cloud.

Helm utilizza i valori di Chart.yaml per l'immagine:

  • Il nome del grafico è il nome dell'immagine: hello-chart
  • La versione del grafico è il tag immagine: 0.1.0

Helm restituisce un output simile al seguente esempio:

Login Succeeded
Pushed: us-west1-docker.pkg.dev/my-project/quickstart-helm-repo/hello-chart:0.1.0
Digest: sha256:67a72...

Esegui questo comando per verificare che il grafico sia ora archiviato nel repository:

gcloud artifacts docker images list us-west1-docker.pkg.dev/PROJECT/quickstart-helm-repo

L'output del comando è simile al seguente esempio:

Listing items under project my-project, location us-west1, repository quickstart-helm-repo.

IMAGE: us-west1-docker.pkg.dev/my-project/quickstart-helm-repo/hello-chart
DIGEST: sha256:67a72...
CREATE_TIME: 2021-11-08T22:59:57
UPDATE_TIME: 2021-11-08T22:59:57

Ora puoi eseguire il deployment di una release utilizzando il grafico archiviato in Artifact Registry.

Esegui il deployment del grafico

In Helm, un'istanza di cui è stato eseguito il deployment della tua applicazione è chiamata release. Dopo aver aggiunto il repository alla configurazione di Helm, puoi eseguire il deployment di una release del grafico.

  1. Crea un cluster denominato chart-cluster per il deployment con il comando:

    gcloud container clusters create --zone us-west1-a chart-cluster

    Quando viene creato il cluster, il comando restituisce un riepilogo simile al seguente esempio:

    kubeconfig entry generated for chart-cluster.
NAME: chart-cluster
LOCATION: us-west1-a
MASTER_VERSION: 1.20.10-gke.1600
MASTER_IP: 34.66.36.211
MACHINE_TYPE: e2-medium
NODE_VERSION: 1.20.10-gke.1600
NUM_NODES: 3
STATUS: RUNNING

  2. Recupera le credenziali del cluster in modo che kubectl possa accedere al cluster:

    gcloud container clusters get-credentials --zone us-west1-a chart-cluster

  3. Esegui questo comando per eseguire il deployment di una release di hello-chart utilizzando i file del grafico estratti localmente:

    helm install hello-chart oci://us-west1-docker.pkg.dev/PROJECT/quickstart-helm-repo/hello-chart --version 0.1.0

    Il comando restituisce un riepilogo del deployment:

    NAME: hello-chart
LAST DEPLOYED: Mon Nov  8 23:15:13 2021
NAMESPACE: default
STATUS: deployed
REVISION: 1

Hai eseguito il deployment di una release utilizzando il grafico che hai creato e di cui hai eseguito il push ad Artifact Registry.

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questa pagina, segui questi passaggi.

  1. Elimina il repository che hai creato con il seguente comando:

    gcloud artifacts repositories delete quickstart-helm-repo --location=us-west1

  2. Elimina il cluster che hai creato:

    gcloud container clusters delete --zone=us-west1-a chart-cluster

Passaggi successivi