Administra Gems de Ruby

En esta página, se describe cómo agregar, ver y borrar gemas y versiones de gemas de Ruby.

Antes de comenzar

  1. Instala y, luego, inicializa Google Cloud CLI.

    Se requiere la versión 354.0.0 o posterior de Google Cloud CLI para ejecutar comandos en repositorios de Ruby. Puedes verificar la versión con el siguiente comando:

    gcloud version

  2. Si el repositorio de destino no existe, crea un repositorio de paquetes de Ruby.

  3. Verifica que Ruby esté instalado. Para obtener instrucciones de instalación, consulta elGoogle Cloud instructivo para configurar Ruby.

  4. (Opcional) Establece valores predeterminados para los comandos de gcloud.

Roles obligatorios

Para obtener los permisos que necesitas para administrar gems, pídele a tu administrador que te otorgue los siguientes roles de IAM en el repositorio:

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

Cómo agregar gemas

Los paquetes en Ruby se denominan gems, y cada uno contiene un nombre, una versión y una plataforma. Un proyecto de Ruby también debe contener un gemfile, que es un archivo de configuración que especifica las dependencias de gemas requeridas.

Modos de repositorio: estándar

Cuando compilas un proyecto de Ruby, los archivos de distribución se guardan en un subdirectorio lib en tu proyecto. Luego, puedes usar RubyGems para subir gems a un repositorio estándar.

Sigue estos pasos para agregar una gem a tu repositorio de Artifact Registry:

gem push GEM_NAME --host https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY

Aquí:

  • GEM_NAME es el nombre de la gem que se enviará a tu repositorio.
  • LOCATION es la ubicación de tu repositorio.
  • PROJECT es el ID del proyecto. Si se omite esta marca, se usa el proyecto predeterminado o actual.
  • REPOSITORY es el nombre de tu repositorio en Artifact Registry.

Cómo ver Gems y versiones

Modos de repositorio: estándar

Para ver los paquetes y sus versiones con la Google Cloud consola o gcloud, haz lo siguiente:

Console

  1. Abre la página Repositorios en la consola de Google Cloud .

    Abrir la página repositorios

  2. En la lista de repositorios, haz clic en el repositorio correspondiente.

    En la página Paquetes, se enumeran los paquetes del repositorio.

  3. Haz clic en un paquete para ver las versiones de este.

gcloud

Para generar una lista de los paquetes en un repositorio, ejecuta el siguiente comando:

gcloud artifacts packages list [--repository=REPOSITORY] [--location=LOCATION]

Reemplaza lo siguiente:

  • REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
  • LOCATION es la ubicación regional o multirregional del repositorio. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.

Para ver las versiones de un paquete, ejecuta el siguiente comando:

gcloud artifacts versions list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

Reemplaza lo siguiente:

  • PACKAGE es el ID del paquete o el identificador completamente calificado del paquete.
  • REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
  • LOCATION es la ubicación regional o multirregional del repositorio. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.

En el caso de los repositorios remotos, la lista que se devuelve debe incluir todas las dependencias directas y transitivas.

Enumerar archivos

Modos de repositorio: estándar

Puedes enumerar los archivos de un repositorio, los archivos de todas las versiones de un paquete especificado o los archivos de una versión específica de un paquete.

Para todos los siguientes comandos, puedes establecer una cantidad máxima de archivos que se devolverán agregando la marca --limit al comando.

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

gcloud artifacts files list

Para enumerar los archivos en un proyecto, un repositorio y una 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 un paquete específico, haz lo siguiente:

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

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

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

Reemplaza los siguientes valores:

  • LOCATION: Es la ubicación regional o multirregional del repositorio.
  • PROJECT: El Google Cloud ID de tu proyecto. 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 del paquete.
  • VERSION: Es la versión del paquete.

Ejemplos

Considera la siguiente información del paquete:

  • Proyecto: my-project
  • Repositorio: my-repo
  • Ubicación del repositorio: us-west1
  • Paquete: my-app

El siguiente comando enumera todos los archivos del repositorio my-repo en la ubicación us-west1 dentro del proyecto predeterminado:

gcloud artifacts files list \
    --location=us-west1 \
    --repository=my-repo
El siguiente comando enumera los archivos en la versión 1.0 del paquete.

gcloud artifacts files list \
    --project=my-project \
    --location=us-west1 \
    --repository=my-repo \
    --package=my-app \
    --version=1.0

Instala gemas

Modos de repositorio: estándar

Para instalar la versión estable más reciente de un paquete, haz lo siguiente:

gem install GEM_NAME

En el caso de los repositorios estándar, descargas un paquete directamente desde el repositorio.

En el caso de un repositorio remoto, descargas una copia almacenada en caché del paquete y sus dependencias. Si no existe una copia en caché, el repositorio remoto descarga el paquete de la fuente upstream y lo almacena en caché antes de entregártelo. Para verificar que el repositorio remoto recuperó los paquetes de la fuente upstream, consulta la lista de paquetes en el repositorio.

En el caso de un repositorio virtual, Artifact Registry busca el paquete solicitado en los repositorios directos.

  • Los repositorios remotos upstream descargarán y almacenarán en caché el paquete solicitado si no existe una copia en caché. Los repositorios virtuales solo entregan los paquetes solicitados, no los almacenan.
  • Si solicitas una versión que está disponible en más de un repositorio upstream, Artifact Registry elige un repositorio upstream para usarlo según la configuración de prioridad establecida para el repositorio virtual.

Por ejemplo, considera un repositorio virtual con los siguientes parámetros de configuración de prioridad para los repositorios upstream:

  • main-repo: Prioridad establecida en 100
  • secondary-repo1: La prioridad se estableció en 80.
  • secondary-repo2: La prioridad se estableció en 80.
  • test-repo: La prioridad se estableció en 20.

main-repo tiene el valor de prioridad más alto, por lo que el repositorio virtual siempre lo busca primero.

Tanto secondary-repo1 como secondary-repo2 tienen la prioridad establecida en 80. Si un paquete solicitado no está disponible en main-repo, Artifact Registry buscará en estos repositorios a continuación. Dado que ambos tienen el mismo valor de prioridad, Artifact Registry puede optar por entregar un paquete desde cualquiera de los repositorios si la versión está disponible en ambos.

test-repo tiene el valor de prioridad más bajo y publicará un artefacto almacenado si ninguno de los otros repositorios upstream lo tiene.

Información adicional

Cuando envías o extraes gems de un repositorio de Artifact Registry, si la gem solicitada o sus dependencias no se encuentran en el repositorio especificado, tu cliente de gem usa cualquier otra fuente definida en el Gemfile de tu gem. Si solo deseas recuperar e instalar directamente desde Artifact Registry, ejecuta el siguiente comando para quitar una fuente que no sea de Artifact Registry de tu Gemfile:

gem sources --remove SOURCE

Para volver a agregar rubygems.org como fuente, haz lo siguiente:

gem sources --add SOURCE

Donde SOURCE es la dirección de la fuente, como https://rubygems.org.

Borra paquetes y versiones

Modos de repositorio: estándar

Puedes borrar un paquete y todas sus versiones, o bien borrar una versión específica.

  • Una vez que borres un paquete, no podrás deshacer la acción.
  • En el caso de los repositorios remotos, solo se borra la copia almacenada en caché del paquete. La fuente upstream no se ve afectada. Si borras un paquete almacenado en caché, Artifact Registry lo volverá a descargar y almacenar en caché la próxima vez que el repositorio reciba una solicitud para la misma versión del paquete.

Antes de borrar un paquete o una versión de un paquete, verifica que se haya comunicado o abordado cualquier dependencia importante en este.

Para borrar un paquete, haz lo siguiente:

Console

  1. Abre la página Repositorios en la consola de Google Cloud .

    Abrir la página repositorios

  2. En la lista de repositorios, haz clic en el repositorio correspondiente.

    En la página Paquetes, se enumeran los paquetes del repositorio.

  3. Selecciona el paquete que quieres borrar.

  4. Haz clic en BORRAR.

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

gcloud

Ejecuta el siguiente comando:

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Reemplaza lo siguiente:

  • PACKAGE es el nombre del paquete en el repositorio.
  • REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
  • LOCATION es la ubicación regional o multirregional del repositorio. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.

La marca --async hace que el comando se muestre de inmediato, sin necesidad de esperar a que se complete la operación en curso.

Para borrar versiones de un paquete, haz lo siguiente:

Console

  1. Abre la página Repositorios en la consola de Google Cloud .

    Abrir la página repositorios

  2. En la lista de repositorios, haz clic en el repositorio correspondiente.

    En la página Paquetes, se enumeran los paquetes del repositorio.

  3. Haz clic en un paquete para ver las versiones de este.

  4. Selecciona las versiones que quieres borrar.

  5. Haz clic en BORRAR.

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

gcloud

Ejecuta el siguiente comando:

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

Reemplaza lo siguiente:

  • VERSION es el nombre de la versión que se borrará.
  • PACKAGE es el nombre del paquete en el repositorio.
  • REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
  • LOCATION es la ubicación regional o multirregional del repositorio. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.

La marca --async hace que el comando se muestre de inmediato, sin necesidad de esperar a que se complete la operación en curso.

Limitaciones

  • Artifact Registry no admite la adición de repositorios como fuentes con el comando gem sources -add. Sin embargo, puedes agregar fuentes manualmente a tu archivo .gemrc o pasar la marca --source directamente en tu comando gem.

  • Artifact Registry no admite la extracción de gems con gem fetch.

¿Qué sigue?