Cambios para Docker

En este documento, se explican las diferencias entre Container Registry y Artifact Registry para autenticar, enviar y extraer imágenes de contenedor con Docker.

En esta guía, las comparaciones se enfocan en los repositorios estándar de Artifact Registry, los repositorios normales de Artifact Registry que son independientes de Container Registry y admiten todas las características de Artifact Registry.

Si tu administrador configura repositorios compatibles con el dominio gcr.io, las solicitudes a nombres de host gcr.io se redireccionan de forma automática al repositorio de Artifact Registry correspondiente. Para usar un repositorio gcr.io alojado en Artifact Registry, debes tener una función de Artifact Registry adecuada o una función con permisos equivalentes.

Para obtener información sobre las diferencias entre Container Registry y Artifact Registry cuando se compila con Cloud Build y se implementa en Cloud Run o Google Kubernetes Engine, consulta Cambios para Cloud Build, Cloud Run y GKE.

Usa esta información para adaptar los comandos, la configuración o la documentación existentes enfocados en Container Registry con Docker.

Antes de comenzar

En este documento, se supone que cuentas con lo siguiente:

  1. Habilitar Artifact Registry en tu proyecto
  2. Docker está instalado. Docker está incluido en Cloud Shell.

Descripción general

En un nivel alto, el flujo de trabajo para usar Docker con Container Registry o Artifact Registry es el mismo.

Container Registry Artifact Registry
Administrador
  1. Habilita la API de Container Registry
  2. Envía una imagen inicial al host para agregar un host de registro, como “gcr.io”.
  3. Otorga roles de Cloud Storage en el bucket de almacenamiento para que el host del registro proporcione acceso a las imágenes.
Administrador
  1. Habilita la API de Artifact Registry
  2. Agregar un repositorio de Docker
  3. Otorga roles de Artifact Registry para proporcionar acceso a las imágenes.
Usuarios del registro
  1. Define la imagen como un archivo Dockerfile.
  2. Compila la imagen.
  3. Autentícate en el registro.
  4. Etiqueta la imagen y envíala al registro.
  5. Extrae la imagen del registro o impleméntala en un entorno de ejecución de Google Cloud.
Usuarios del registro
  1. Define la imagen como un archivo Dockerfile.
  2. Compila la imagen.
  3. Autentícate en el registro.
  4. Etiqueta la imagen y envíala al registro.
  5. Extrae la imagen del registro o impleméntala en un entorno de ejecución de Google Cloud.

Sin embargo, un acceso directo para Container Registry es combinar las funciones de administrador y de usuario en un solo flujo de trabajo. Esta combinación de teclas es común en los siguientes casos:

  • Consulta instructivos y guías de inicio rápido en los que realizas pruebas en un entorno en el que tienes permisos amplios.
  • Workflows que usan Cloud Build, ya que la cuenta de servicio de Cloud Build tiene permisos para agregar un host de registro al mismo proyecto de Google Cloud

El flujo de trabajo del acceso directo se ve de la siguiente manera:

  1. Habilita la API de Container Registry.
  2. Otorga permisos a la cuenta que accederá a Container Registry.
  3. Autentícate en el registro. La opción de autenticación más simple es usar el auxiliar de credenciales de Docker en Google Cloud CLI. Este es un paso de configuración único.

    gcloud auth configure-docker
    
  4. Compila y etiqueta la imagen. Por ejemplo, con este comando, se compila y etiqueta la imagen gcr.io/my-project/my-image:tag1:

    docker build -t gcr.io/my-project/my-image:tag1
    
  5. Envía la imagen al registro. Por ejemplo:

    docker push gcr.io/my-project/my-image:tag1
    

    Si el host de registro gcr.io no existe en el proyecto, Container Registry agrega el host antes de subir la imagen.

  6. Extrae la imagen del registro o impleméntala en un entorno de ejecución de Google Cloud. Por ejemplo:

    docker pull gcr.io/my-project/my-image:tag1
    

Este flujo de trabajo se basa en las siguientes combinaciones de teclas:

  • La cuenta que envía imágenes tiene la función de administrador de almacenamiento o una con los mismos permisos, como Propietario. Los permisos amplios de esta función otorgan acceso de lectura y escritura a todos los buckets de almacenamiento de un proyecto, incluidos los buckets que Container Registry no usa.
  • Cuando habilitas algunas de las API de Google Cloud, la API de Container Registry se habilita automáticamente. Esto significa que los usuarios de estos servicios tienen acceso implícito a Container Registry en el mismo proyecto. Por ejemplo, los usuarios que pueden ejecutar compilaciones en Cloud Build pueden enviar imágenes a registros y agregar hosts de registro de forma predeterminada.

En Artifact Registry, hay una separación clara de los roles de usuario del administrador y del repositorio que cambian los pasos del flujo de trabajo de compilación e implementación. Para adaptar el flujo de trabajo de Container Registry a Artifact Registry, realiza los siguientes cambios. Cada paso se vincula a información adicional sobre la modificación del flujo de trabajo.

  1. Nuevo: Habilita la API de Artifact Registry.

    Debes habilitar la API de Artifact Registry. Cloud Build y los entornos de ejecución, como Cloud Run y GKE, no habilitan automáticamente la API.

  2. Nuevo: Crea el repositorio de Docker de destino si aún no existe. Debes crear un repositorio para poder enviarle imágenes. El envío de una imagen no puede activar la creación de un repositorio, y la cuenta de servicio de Cloud Build no tiene permisos para crear repositorios.

  3. Otorga permisos a la cuenta que interactuará con Artifact Registry.

  4. Modificada: Autentícate en el repositorio. Si usas el auxiliar de credenciales en gcloud CLI, debes especificar los hosts que deseas agregar a la configuración del cliente de Docker. Por ejemplo, este comando agrega el host us-central1-docker.pkg.dev:

    gcloud auth configure-docker us-central1-docker.pkg.dev
    
  5. Cambiada: Compila y etiqueta la imagen.

    El siguiente comando de ejemplo es el mismo que el de Container Registry, pero usa una ruta de repositorio de Artifact Registry para la imagen.

    docker build -t us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1
    
  6. Cambiada: Envía la imagen al repositorio mediante la ruta de acceso de Artifact Registry. Por ejemplo:

    docker push us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1
    
  7. Modificada: Extrae la imagen del repositorio mediante la ruta de acceso de Artifact Registry. Por ejemplo:

    docker pull us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag1
    

Habilitar la API

Puntos clave:

En la siguiente comparación, se describe cómo habilitar la API para cada servicio:

Container Registry

Debes habilitar la API de Container Registry antes de usar Docker o algún otro cliente de terceros con Container Registry.

Cuando habilitas las siguientes API de Google Cloud, la API de Container Registry también se habilita automáticamente:

  • Entorno flexible de App Engine
  • Cloud Build
  • Cloud Functions
  • Cloud Run
  • Análisis de contenedores o análisis a pedido en Artifact Analysis
  • Google Kubernetes Engine

Con los permisos predeterminados, los usuarios que pueden ejecutar compilaciones en Cloud Build, analizar contenedores con Artifact Analysis o implementar contenedores en los entornos de ejecución de Google Cloud tienen acceso de forma implícita a las imágenes en Container Registry cuando el registro está en el mismo proyecto.

Artifact Registry

Debes habilitar la API de Artifact Registry antes de usar clientes de Docker o algún otro servicio de Google Cloud con Artifact Registry.

Los servicios como Cloud Build, Cloud Run y GKE no habilitan automáticamente la API de Artifact Registry.

Puedes habilitar varias APIs en el mismo proyecto con gcloud. Por ejemplo, para habilitar la API de Cloud Build y de Artifact Registry, ejecuta el siguiente comando:

gcloud services enable
    artifactregistry.googleapis.com \
    cloudbuild.googleapis.com

Agrega registros y repositorios

Puntos clave:

  • Debes crear un repositorio de Docker de Artifact Registry antes de enviarle una imagen.

    Un paso de creación de registro suele excluirse de la documentación en la que se describe el envío de imágenes a Container Registry, ya que una cuenta con permisos de administrador de almacenamiento puede agregar un registro a un proyecto con el envío inicial al host de registro.

  • Container Registry almacena todas las imágenes en una sola multirregión en el mismo bucket de almacenamiento. En Artifact Registry, puedes crear varios repositorios en la misma región o multirregión con políticas de acceso independientes.

En la siguiente comparación, se describe la configuración del repositorio en cada servicio:

Container Registry

En Container Registry, puedes agregar hasta cuatro hosts de registro a tu proyecto. Para agregar un host de registro, envía la primera imagen.

  1. Para agregar un registro como gcr.io a tu proyecto, una cuenta con la función de administrador de almacenamiento a nivel de proyecto envía una imagen inicial.

    Por ejemplo, si el host gcr.io no existe en el proyecto my-project, enviar la imagen gcr.io/my-project/my-image:1.0 activa los siguientes pasos:

    1. Agrega el host gcr.io al proyecto
    2. Crea un bucket de almacenamiento para gcr.io en el proyecto.
    3. Almacena la imagen como gcr.io/my-project/my-image:1.0
  2. Después de este envío inicial, puedes otorgar permisos al bucket de almacenamiento para otros usuarios.

Dentro de un proyecto, un host de registro almacena todas las imágenes en el mismo bucket de almacenamiento. En el siguiente ejemplo, el proyecto my-project tiene dos imágenes llamadas web-app en el registro gcr.io. Uno está directamente en el ID del proyecto my-project. La otra imagen se encuentra en el repositorio team1.

gcr.io/my-project/web-app
gcr.io/my-project/team1/web-app

Artifact Registry

Una cuenta con la función de administrador del repositorio de Artifact Registry debe crear el repositorio antes de enviarle imágenes. Luego, puedes otorgar permisos al repositorio para otros usuarios.

En Artifact Registry, cada repositorio es un recurso independiente. Por lo tanto, todas las rutas de imagen deben incluir un repositorio.

Rutas de acceso de imagen válidas:

us-central1-docker.pkg.dev/my-project/team1/web-app:1.0
us-central1-docker.pkg.dev/my-project/team2/web-app:1.0

La ruta de acceso a la imagen no es válida (no incluye un repositorio) :

us-central1-docker.pkg.dev/my-project/web-app:1.0

En los siguientes ejemplos, se muestran situaciones en las que falla el envío de una imagen a un repositorio faltante.

  • Envía una imagen a us-central1-docker.pkg.dev/my-project/team1 si us-central1-docker.pkg.dev/my-project/team1 no existe.
  • Envía una imagen a us-central1-docker.pkg.dev/my-project/team2 cuando us-central1-docker.pkg.dev/my-project/team1 existe, pero us-central1-docker.pkg.dev/my-project/team2 no existe.

Otorgando permisos

Puntos clave:

  • Otorga el rol adecuado de Artifact Registry a la cuenta que usas con Artifact Registry.
  • Los servicios de Google Cloud tienen acceso de lectura o escritura equivalente a Container Registry y Artifact Registry. Sin embargo, la cuenta de servicio predeterminada de Cloud Build no puede crear repositorios.
  • Container Registry admite el control de acceso a nivel de bucket de almacenamiento. Artifact Registry admite el control de acceso a nivel del repositorio.

En la siguiente comparación, se describe la configuración de permisos en cada servicio:

Container Registry

Container Registry usa los roles de Cloud Storage para controlar el acceso.

Visualizador de objetos de Storage a nivel del bucket de almacenamiento
Extrae (lectura) imágenes de los hosts de registro existentes en el proyecto.
Escritor de buckets heredados de almacenamiento a nivel del bucket de almacenamiento
Enviar (escribir) y extraer (leer) imágenes para los hosts de registro existentes en el proyecto
Administrador de almacenamiento a nivel de proyecto
Para agregar un host de registro a un proyecto, envía una imagen inicial al host.

Después del envío inicial de imágenes a un registro, otorgas funciones de Cloud Storage a otras cuentas que requieren acceso al bucket de almacenamiento. Ten en cuenta que cualquier cuenta con todos los permisos en el rol de administrador de almacenamiento puede leer, escribir y borrar buckets y objetos de almacenamiento en todo el proyecto.

Los permisos de un bucket de almacenamiento se aplican a todos los repositorios del registro. Por ejemplo, cualquier usuario con permisos de Visualizador de objetos de Storage en el bucket de gcr.io/my-project puede leer imágenes en todos estos repositorios:

gcr.io/my-project/team1
gcr.io/my-project/team2
gcr.io/my-project/test
gcr.io/my-project/production

Artifact Registry

Artifact Registry tiene sus propios roles para controlar el acceso. Estos roles proporcionan una separación clara entre los roles de administrador y del usuario del repositorio.

Solo las cuentas que administran repositorios deben tener la función de administrador del repositorio de Artifact Registry o de administrador de Artifact Registry.

Lector de Artifact Registry
Enumerar artefactos y repositorios Descarga los artefactos.
Escritor de Artifact Registry
Enumerar artefactos y repositorios Descarga artefactos, sube versiones nuevas de ellos y agrega o actualiza etiquetas.
Administrador del repositorio de Artifact Registry
Permisos y permisos de escritor de Artifact Registry para borrar artefactos y etiquetas.
Administrador de Artifact Registry
Permisos y permisos de administrador del repositorio de Artifact Registry para crear, actualizar, borrar y otorgar permisos a los repositorios.

Puedes aplicar estos permisos a nivel de repositorio. Por ejemplo:

  • Otorgar acceso al Equipo 1 para us-central1-docker.pkg.dev/my-project/team1
  • Otorga acceso al Equipo 2 para us-central1-docker.pkg.dev/my-project/team2.

Para obtener detalles sobre cómo otorgar permisos de Artifact Registry, consulta la documentación de control de acceso.

Autentica en el registro

Puntos clave:

  • Artifact Registry admite los mismos métodos de autenticación que Container Registry.
  • Para el auxiliar de credenciales de Docker, debes especificar los hosts que deseas agregar a la configuración del cliente de Docker.
  • Para la autenticación con docker login, usa el host de Artifact Registry en lugar de un host de Container Registry.

Cómo usar el auxiliar de credenciales

El comando gcloud auth configure-docker y el auxiliar de credenciales independiente solo configuran Docker para los nombres de host *.gcr.io de forma predeterminada. En Artifact Registry, debes especificar una lista de los hosts de Artifact Registry que deseas agregar a la configuración del cliente de Docker.

Por ejemplo, para configurar la autenticación en repositorios de Docker en la región us-central1, ejecuta el siguiente comando:

gcloud auth configure-docker us-central1-docker.pkg.dev

Si luego agregas repositorios en us-east1 y asia-east1, debes volver a ejecutar el comando para agregar los nombres de host regionales correspondientes a tu configuración de Docker.

gcloud auth configure-docker us-east-docker.pkg.dev,asia-east1-docker.pkg.dev

Para obtener más información sobre los métodos de autenticación de Artifact Registry, consulta Configura la autenticación para Docker.

Cómo usar la autenticación con contraseña

Cuando accedas a Docker, usa el nombre de host de Artifact Registry en lugar de un nombre de host *.gcr.io. En el siguiente ejemplo, se muestra la autenticación con una clave de cuenta de servicio codificada en base64 en el host us-central1-docker.pkg.dev:

cat key.json | docker login -u _json_key_base64 --password-stdin \
https://us-central1-docker.pkg.dev

Cómo compilar y etiquetar imágenes

Puntos clave: - Artifact Registry usa un nombre de host diferente para los repositorios.

Cuando etiquetes una imagen, usa la ruta de acceso de Artifact Registry en lugar de la de Container Registry. Por ejemplo:

docker tag my-image us-central1-docker.pkg.dev/my-project/my-repo/my-image:1.0

Envía imágenes al registro

Puntos clave: - En Artifact Registry, el repositorio de destino debe existir antes de enviarle una imagen. - Artifact Registry usa un nombre de host diferente para los repositorios.

Cuando envíes una imagen, usa la ruta de acceso de Artifact Registry en lugar de la ruta de Container Registry. Por ejemplo:

docker push us-central1-docker.pkg.dev/my-project/my-repo/my-image:1.0

Extrae imágenes del registro

Punto clave:

  • Los nombres de host de Artifact Registry son diferentes de los nombres de host de Container Registry.

Cuando extraigas una imagen, usa la ruta de acceso de Artifact Registry en lugar de la ruta de Container Registry. Por ejemplo:

docker pull us-central1-docker.pkg.dev/my-project/my-repo/my-image:1.0

Para ver ejemplos de la implementación de imágenes en los entornos de ejecución de Google Cloud, como Cloud Run y GKE, consulta Implementa imágenes.