View a markdown version of this page

Configura RubyGems y usa un paquete con CodeArtifact - CodeArtifact
Configure RubyGems (gem) y Bundler () bundle con CodeArtifactInstalación de gemas de RubyPublicación de gemas de Ruby

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Configura RubyGems y usa un paquete con CodeArtifact

Después de crear un repositorio en CodeArtifact, puedes usar RubyGems (gem) y Bundler (bundle) para instalar y publicar gemas. En este tema se describe cómo configurar los administradores de paquetes para autenticarse y usar un CodeArtifact repositorio.

Configure RubyGems (gem) y Bundler () bundle con CodeArtifact

Si quieres usar RubyGems (gem) o Bundler (bundle) para publicar o consumir gemas AWS CodeArtifact, primero tendrás que configurarlas con la información de tu CodeArtifact repositorio, incluidas las credenciales para acceder a él. Siga los pasos de uno de los siguientes procedimientos para configurar las herramientas gem y bundle CLI con la información y las credenciales del punto final del CodeArtifact repositorio.

Configure RubyGems y agrupe mediante las instrucciones de la consola

Puedes usar las instrucciones de configuración de la consola para conectar tus administradores de paquetes de Ruby a tu CodeArtifact repositorio. Las instrucciones de la consola proporcionan comandos personalizados que puede ejecutar para configurar sus administradores de paquetes sin necesidad de buscar y completar su CodeArtifact información.

  1. Abre la AWS CodeArtifact consola en https://console.aws.amazon.com/codesuite/codeartifact/home.

  2. En el panel de navegación, elija Repositorios y luego elija el nombre del que desee utilizar para instalar o insertar gemas de Ruby.

  3. Seleccione Ver instrucciones de conexión.

  4. Elija su sistema operativo.

  5. Elige el cliente administrador de paquetes Ruby que deseas configurar con tu repositorio. CodeArtifact

  6. Siga las instrucciones generadas a fin de configurar el cliente administrador de paquetes para instalar gemas de Ruby desde el repositorio o instalarlas en este.

Configura RubyGems y agrupa manualmente

Si no puedes o no quieres usar las instrucciones de configuración de la consola, puedes usar las siguientes instrucciones para conectarte manualmente a tus administradores de paquetes de Ruby a tu CodeArtifact repositorio.

  1. En una línea de comandos, usa el siguiente comando para obtener un token de CodeArtifact autorización y almacenarlo en una variable de entorno.

    • my_domainSustitúyalo por tu nombre CodeArtifact de dominio.

    • 111122223333Sustitúyelo por el ID de AWS cuenta del propietario del dominio. Si va a acceder a un repositorio de un dominio de su propiedad, no tiene que incluir --domain-owner. Para obtener más información, consulte Dominios entre cuentas.

    macOS and Linux
    export CODEARTIFACT_AUTH_TOKEN=`aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text`
    Windows

    • Windows (mediante el intérprete de comandos predeterminado):

      for /f %i in ('aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text') do set CODEARTIFACT_AUTH_TOKEN=%i

    • Windows PowerShell:

      $env:CODEARTIFACT_AUTH_TOKEN = aws codeartifact get-authorization-token --domain my_domain --domain-owner 111122223333 --query authorizationToken --output text

  2. Para publicar gemas de Ruby en tu repositorio, usa el siguiente comando para buscar el punto final de tu CodeArtifact repositorio y almacenarlo en la variable de RUBYGEMS_HOST entorno. La CLI gem utiliza esta variable de entorno para determinar dónde se publican las gemas.

    nota

    Como alternativa, en lugar de usar la variable de entorno RUBYGEMS_HOST, puede facilitar el punto de conexión del repositorio con la opción --host al utilizar el comando gem push.

    • my_domainSustitúyalo por tu nombre CodeArtifact de dominio.

    • 111122223333Sustitúyelo por el ID de AWS cuenta del propietario del dominio. Si va a acceder a un repositorio de un dominio de su propiedad, no tiene que incluir --domain-owner. Para obtener más información, consulte Dominios entre cuentas.

    • my_repoSustitúyalo por el nombre de tu CodeArtifact repositorio.

    macOS and Linux
    export RUBYGEMS_HOST=`aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text | sed 's:/*$::'`
    Windows

    Los siguientes comandos recuperan el punto de conexión del repositorio, recortan el símbolo / final y, a continuación, lo almacenan en una variable de entorno.

    • Windows (mediante el intérprete de comandos predeterminado):

      for /f %i in ('aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text') do set RUBYGEMS_HOST=%i
                                
set RUBYGEMS_HOST=%RUBYGEMS_HOST:~0,-1%

    • Windows PowerShell:

      $env:RUBYGEMS_HOST = (aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text).TrimEnd("/")

    La siguiente URL es un punto de conexión de repositorio de ejemplo:

    https://my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/
    nota

    Si quiere utilizar un punto de conexión de pila doble, use el punto de conexión codeartifact.region.on.aws.

  3. Para publicar gemas de Ruby en tu repositorio, debes autenticarte CodeArtifact RubyGems editando tu ~/.gem/credentials archivo para incluir tu token de autenticación. Cree un directorio ~/.gem/ y un archivo ~/.gem/credentials si el directorio o el archivo no existen.

    macOS and Linux
    echo ":codeartifact_api_key: Bearer $CODEARTIFACT_AUTH_TOKEN" >> ~/.gem/credentials
    Windows

    • Windows (mediante el intérprete de comandos predeterminado):

      echo :codeartifact_api_key: Bearer %CODEARTIFACT_AUTH_TOKEN% >> %USERPROFILE%/.gem/credentials

    • Windows: PowerShell

      echo ":codeartifact_api_key: Bearer $env:CODEARTIFACT_AUTH_TOKEN" | Add-Content ~/.gem/credentials

  4. Para poder usar gem con la intención de instalar gemas de Ruby desde su repositorio, debe añadir la información del punto de conexión del repositorio y el token de autenticación al archivo .gemrc. Puede añadirlos al archivo global (~/.gemrc) o al archivo .gemrc de su proyecto. La CodeArtifact información que debe añadir .gemrc es una combinación del punto final del repositorio y el token de autenticación. Su formato es el siguiente:

    https://aws:${CODEARTIFACT_AUTH_TOKEN}@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/

    • Para el token de autenticación, puede usar la variable de entorno CODEARTIFACT_AUTH_TOKEN que se configuró en un paso anterior.

    • Para obtener el punto de conexión del repositorio, puede leer el valor de la variable de entorno RUBYGEMS_HOST que se configuró antes, o bien puede usar el comando get-repository-endpoint siguiente y sustituir los valores según sea necesario:

      aws codeartifact get-repository-endpoint --domain my_domain --domain-owner 111122223333 --repository my_repo --format ruby --query repositoryEndpoint --output text

    Una vez que tenga el punto de conexión, use un editor de texto para añadir aws:${CODEARTIFACT_AUTH_TOKEN}@ en la posición adecuada. Cuando tenga creados el punto de conexión del repositorio y la cadena del token de autenticación, agréguelos a la sección :sources: del archivo .gemrc con el comando echo de la siguiente manera:

    aviso

    CodeArtifact no admite la adición de repositorios como fuentes mediante el gem sources -add comando. Debe añadir el origen directamente al archivo.

    macOS and Linux
    echo ":sources:
    - https://aws:${CODEARTIFACT_AUTH_TOKEN}@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" > ~/.gemrc
    Windows

    • Windows (mediante el intérprete de comandos predeterminado):

      echo ":sources:
    - https://aws:%CODEARTIFACT_AUTH_TOKEN%@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" > "%USERPROFILE%\.gemrc"

    • Windows PowerShell:

      echo ":sources:
    - https://aws:$env:CODEARTIFACT_AUTH_TOKEN@my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/" | Add-Content ~/.gemrc

  5. Para usar Bundler, debe configurarlo con la URL del punto de conexión del repositorio y el token de autenticación ejecutando el comando bundle config siguiente:

    macOS and Linux
    bundle config $RUBYGEMS_HOST aws:$CODEARTIFACT_AUTH_TOKEN
    Windows

    • Windows (mediante el intérprete de comandos predeterminado):

      bundle config %RUBYGEMS_HOST% aws:%CODEARTIFACT_AUTH_TOKEN%

    • Windows PowerShell:

      bundle config $Env:RUBYGEMS_HOST aws:$Env:CODEARTIFACT_AUTH_TOKEN

Ahora que has configurado RubyGems (gem) y Bundler (bundle) con tu CodeArtifact repositorio, puedes usarlos para publicar y consumir gemas de Ruby desde y hacia él.

Instalar gemas de Ruby desde CodeArtifact

Utilice los siguientes procedimientos para instalar gemas de Ruby desde un CodeArtifact repositorio con las herramientas gem o bundle CLI.

Instalación de gemas de Ruby con gem

Puedes usar la CLI RubyGems (gem) para instalar rápidamente una versión específica de una gema Ruby desde tu CodeArtifact repositorio.

Para instalar gemas de Ruby desde un CodeArtifact repositorio con gem

  1. Si no lo ha hecho, siga los pasos que se indican Configure RubyGems (gem) y Bundler () bundle con CodeArtifact para configurar la gem CLI para que utilice el CodeArtifact repositorio con las credenciales adecuadas.

    nota

    El token de autorización generado es válido durante 12 horas. Deberá crear uno nuevo si han pasado 12 horas desde que se creó el token.

  2. Usa el siguiente comando para instalar Ruby gems desde CodeArtifact:

    gem install my_ruby_gem --version 1.0.0

Instalación de gemas de Ruby con bundle

Puede usar la CLI de Bundler (bundle) para instalar las gemas de Ruby que están configuradas en su archivo Gemfile.

Para instalar gemas de Ruby desde un CodeArtifact repositorio con bundle

  1. Si no lo ha hecho, siga los pasos que se indican Configure RubyGems (gem) y Bundler () bundle con CodeArtifact para configurar la bundle CLI para que utilice el CodeArtifact repositorio con las credenciales adecuadas.

    nota

    El token de autorización generado es válido durante 12 horas. Deberá crear uno nuevo si han pasado 12 horas desde que se creó el token.

  2. Agrega la URL CodeArtifact del punto final de tu repositorio a la Gemfile tuya source para instalar las gemas de Ruby configuradas desde tu CodeArtifact repositorio y sus fuentes de acceso.

    source "https://my_domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/ruby/my_repo/"
                
gem 'my_ruby_gem'

  3. Ejecute el siguiente comando para instalar las gemas de Ruby tal y como se especifica en el archivo Gemfile:

    bundle install

Publicar gemas de Ruby en CodeArtifact

Utilice el siguiente procedimiento para publicar gemas de Ruby en un CodeArtifact repositorio mediante la gem CLI.

  1. Si no lo ha hecho, siga los pasos que se indican Configure RubyGems (gem) y Bundler () bundle con CodeArtifact para configurar la gem CLI para que utilice el CodeArtifact repositorio con las credenciales adecuadas.

    nota

    El token de autorización generado es válido durante 12 horas. Deberá crear uno nuevo si han pasado 12 horas desde que se creó el token.

  2. Usa el siguiente comando para publicar las gemas de Ruby en un CodeArtifact repositorio. Tenga en cuenta que si no configuró la variable de RUBYGEMS_HOST entorno, debe proporcionar el punto final del CodeArtifact repositorio en la --host opción.

    gem push --key codeartifact_api_key my_ruby_gem-0.0.1.gem