Administrar gráficos de Helm

En esta página, se explica cómo administrar los gráficos de Helm 3 guardados como imágenes de contenedor de OCI, lo que incluye enviar (subir), extraer (descargar), enumerar, etiquetar y borrar gráficos.

Antes de comenzar

  1. Si el repositorio de destino no existe, crea un repositorio nuevo. Elige Docker como el formato del repositorio.
  2. Verifica que tengas los permisos necesarios para el repositorio.
  3. (Opcional) Configura valores predeterminados para los comandos de gcloud.
  4. Instala Helm 3.8.0 o una versión posterior. En las versiones anteriores de Helm, la compatibilidad con gráficos en formato de OCI es una función experimental.

    Ejecuta helm version para verificar tu versión.

  5. Configura Helm para autenticar con Artifact Registry.

Cómo crear u obtener un gráfico

Esta documentación se centra en la administración de imágenes de gráficos y supone que tienes gráficos existentes o que estás familiarizado con la creación de gráficos. Para obtener más información sobre cómo crear gráficos o conseguir gráficos disponibles de manera pública en Artifact Hub, consulta la siguiente información en la documentación de Helm.

Empaquetar un gráfico

Antes de enviar un gráfico a Artifact Registry, debes empaquetarlo como un archivo de gráficos.

  1. Cambie al directorio que contiene su gráfico.

  2. Empaqueta el gráfico.

    helm package CHART-PATH
    

    Reemplaza CHART-PATH por la ruta de acceso al directorio que contiene tu archivo Chart.yaml.

Helm usa el nombre y la versión del gráfico del nombre del archivo. Por ejemplo, si tienes un gráfico con el nombre my-chart y el número de versión 0.1.0, el nombre del paquete es my-chart-0.1.0.tgz.

Ahora puedes enviar el gráfico a Artifact Registry.

Envía un gráfico

Después de empaquetar el gráfico, puedes enviarlo a Artifact Registry.

Para enviar el gráfico, ejecuta el siguiente comando:

helm push my-chart-0.1.0.tgz oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY

Reemplaza los siguientes valores:

Helm usa información de Chart.yaml para el nombre y la etiqueta de la imagen del contenedor de OCI. Considera el siguiente comando de ejemplo:

helm push my-chart-0.1.0.tgz oci://us-east4-docker.pkg.dev/my-project/my-repo

Helm sube el archivo de gráfico como la imagen my-chart con la etiqueta 0.1.0.

Para verificar que la operación de envío se haya realizado correctamente, enumera las imágenes en el repositorio.

gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT/REPOSITORY

Obteniendo gráficos

Para extraer un gráfico, sigue estos pasos:

  1. Ejecute el siguiente comando para extraer el archivo de gráfico:

    helm pull oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \
        --version VERSION
    

    Si deseas extraer el archivo del gráfico y extraer su contenido, agrega la marca --untar.

    helm pull oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \
        --version VERSION \
        --untar
    

    Reemplaza los siguientes valores:

    • LOCATION es la ubicación regional o multirregional del repositorio.
    • PROJECT es el ID de tu proyecto de Google Cloud. Si el ID de tu proyecto contiene dos puntos (:), consulta Proyectos con alcance de dominio.
    • REPOSITORY es el nombre del repositorio en el que se almacena la imagen.
    • IMAGE es el nombre de la imagen en el repositorio.
    • VERSION es la versión semántica del gráfico. Esta marca es obligatoria. Helm no admite extraer un gráfico con una etiqueta.

Instala un gráfico

Instala un gráfico almacenado en Artifact Registry con el comando helm install.

helm install RELEASE \
    oci://LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \
    --version VERSION

En el siguiente ejemplo, se instala una versión llamada release1 mediante la versión 0.1.0 del gráfico us-east4-docker.pkg.dev/nyap-test/helm-repo/my-chart:

helm install release1 oci://us-east4-docker.pkg.dev/nyap-test/helm-repo/my-chart --version 0.1.0

Enumerar gráficos

Puedes enumerar los gráficos con Google Cloud Console o la línea de comandos. Si almacenas imágenes y gráficos de contenedor en el mismo repositorio de Docker, ambos tipos de artefactos aparecen en la lista.

Console

Para ver imágenes en un repositorio, sigue estos pasos:

  1. Abre la página Repositories en Console.

    Abrir la página Repositorios

  2. Haz clic en el repositorio con la imagen de contenedor.

  3. Haz clic en una imagen para ver sus versiones.

gcloud

Para enumerar todas las imágenes en el proyecto, el repositorio y la ubicación predeterminados cuando los valores predeterminados están configurados, haz lo siguiente:

gcloud artifacts docker images list

Para enumerar imágenes en un repositorio en una ubicación específica, ejecuta el siguiente comando:

gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT/REPOSITORY

Para enumerar todos los resúmenes y las etiquetas de una imagen específica, ejecuta el siguiente comando:

gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE \
--include-tags

Reemplaza los siguientes valores:

  • LOCATION es la ubicación regional o multirregional del repositorio.
  • PROJECT es el ID de tu proyecto de Google Cloud. Si el ID de tu proyecto contiene dos puntos (:), consulta Proyectos con alcance de dominio.
  • REPOSITORY es el nombre del repositorio en el que se almacena la imagen.
  • IMAGE es el nombre de la imagen en el repositorio.
  • --include-tags muestra todas las versiones de las imágenes, incluidos los resúmenes y las etiquetas. Si se omite esta marca, en la lista que se muestra, solo se incluyen imágenes de contenedores de nivel superior.

Por ejemplo, considera una imagen con las siguientes características:

  • Ubicación del repositorio: us
  • Nombre del repositorio: my-repo
  • ID del proyecto: my-project
  • Nombre de la imagen: my-image

El nombre completo del repositorio es el siguiente:

us-docker.pkg.dev/my-project/my-repo

El nombre completo de la imagen es el siguiente:

us-docker.pkg.dev/my-project/my-repo/my-image

Para obtener detalles sobre el formato del nombre de la imagen, consulta Nombres de repositorios y de imágenes.

Muestra una lista de archivos

Puedes enumerar archivos en un repositorio, archivos en todas las versiones de una imagen de contenedor especificada o archivos en una versión específica de una imagen.

En todos los comandos siguientes, puedes agregar la marca --limit al comando para configurar una cantidad máxima de archivos que se mostrarán.

Para enumerar todos los archivos en el proyecto, el repositorio y la ubicación predeterminados cuando los valores predeterminados están configurados, haz lo siguiente:

gcloud artifacts files list

Para enumerar los archivos en un proyecto, repositorio y ubicación especificados, ejecuta el siguiente comando:

gcloud artifacts files list
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

Para enumerar los archivos de todas las versiones de una imagen de contenedor específica, sigue estos pasos:

gcloud artifacts files list
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE

Para enumerar los archivos de una versión específica de la imagen de contenedor, haz lo siguiente:

gcloud artifacts files list
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --version=VERSION
Para enumerar los archivos de una etiqueta específica, sigue estos pasos:

gcloud artifacts files list
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --tag=TAG

Reemplaza los siguientes valores:

  • LOCATION es la ubicación regional o multirregional del repositorio.
  • PROJECT es el ID de tu proyecto de Google Cloud. Si el ID de tu proyecto contiene dos puntos (:), consulta Proyectos con alcance de dominio.
  • REPOSITORY es el nombre del repositorio en el que se almacena la imagen.
  • PACKAGE es el nombre de la imagen.
  • VERSION es el resumen de la imagen, una string que comienza con sha256:.
  • TAG es la etiqueta asociada con la imagen de contenedor.

Borra imágenes

En un repositorio de Artifact Registry, puedes borrar una imagen de contenedor completa o una versión de imagen específica asociada con una etiqueta o un resumen. Una vez que hayas borrado una imagen, no podrás deshacer la acción.

Para borrar una imagen almacenada en Artifact Registry, sigue estos pasos:

Console

  1. Abre la página Repositories en Console.

    Abrir la página Repositorios

  2. Haz clic en el nombre de la imagen para ver la versión correspondiente.

  3. Selecciona las versiones que quieres borrar.

  4. Haz clic en BORRAR.

  5. En el cuadro de diálogo de confirmación, haz clic en BORRAR.

gcloud

Para borrar una imagen y todas sus etiquetas, ejecuta el siguiente comando:

gcloud artifacts docker images delete LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE --delete-tags

Para borrar una versión específica de una imagen, usa uno de los siguientes comandos.

gcloud artifacts docker images delete LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE:TAG [--delete-tags]

o

gcloud artifacts docker images delete LOCATION-docker.pkg.dev/PROJECT/REPOSITORY/IMAGE@IMAGE-DIGEST [--delete-tags]

Donde

  • LOCATION es la ubicación regional o multirregional del repositorio.
  • PROJECT es el ID de tu proyecto de Google Cloud. Si el ID de tu proyecto contiene dos puntos (:), consulta Proyectos con alcance de dominio.
  • REPOSITORY es el nombre del repositorio en el que se almacena la imagen.
  • IMAGE es el nombre de la imagen en el repositorio.
  • TAG es la etiqueta de la versión que deseas borrar. Si varias etiquetas están asociadas a la misma versión de una imagen, debes incluir --delete-tags para borrar la versión de la imagen sin quitar primero las etiquetas.
  • IMAGE-DIGEST es el valor de hash SHA256 de la versión que deseas borrar. Si una etiqueta está asociada con el resumen de la imagen, debes incluir --delete-tags para borrar la versión de la imagen sin quitar primero la etiqueta.
  • --delete-tags quita todas las etiquetas aplicadas a la versión de la imagen. Esta marca te permite forzar la eliminación de una versión de imagen en los siguientes casos:
    • Especificaste una etiqueta, pero hay otras etiquetas asociadas con la versión de la imagen.
    • Especificaste un resumen de la imagen que tiene al menos una etiqueta.

¿Qué sigue?