Store Ruby gems in Artifact Registry

This quickstart shows you how to set up a private Artifact Registry Ruby repository and then upload a package, also called a gem, to that repository.

Before you begin

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  4. Enable the Artifact Registry API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. Make sure that you have the following role or roles on the project: Artifact Registry Administrator

    Check for the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.

    3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

    4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

    Grant the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.
    3. Click Grant access.

    4. In the New principals field, enter your user identifier. This is typically the email address for a Google Account.

    5. In the Select a role list, select a role.
    6. To grant additional roles, click Add another role and add each additional role.
    7. Click Save.

  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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  8. Enable the Artifact Registry API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  9. Make sure that you have the following role or roles on the project: Artifact Registry Administrator

    Check for the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.

    3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

    4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

    Grant the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.
    3. Click Grant access.

    4. In the New principals field, enter your user identifier. This is typically the email address for a Google Account.

    5. In the Select a role list, select a role.
    6. To grant additional roles, click Add another role and add each additional role.
    7. Click Save.

Launch Cloud Shell

In this quickstart, you will use Cloud Shell, which is a shell environment for managing resources hosted on Google Cloud.

Cloud Shell comes preinstalled with the Google Cloud CLI and Ruby. The gcloud CLI provides the primary command-line interface for Google Cloud.

Launch Cloud Shell:

  1. Go to Google Cloud console.

    Google Cloud console

  2. On the Google Cloud console toolbar, click Activate Cloud Shell.

A Cloud Shell session opens inside a frame lower on the console. You use this shell to run gcloud commands.

Configure authentication

Ruby supports two methods for authenticating requests to your Artifact Registry repository:

  • RubyGems CLI: Supports push and pull requests. This CLI is available with Ruby by default. When you authenticate with RubyGems, you must authenticate each time you make a push or pull request to your repository.

  • Bundler CLI: Supports pull requests. Bundler stores packages and upstreams in a gemfile, which allows users to standardize setups across multiple machines without needing to authenticate each individual pull request. However, you must still reauthenticate your credentials to Bundler occasionally.

    To install the Bundler CLI, enter gem install bundler.

Authenticate with the RubyGems CLI

The RubyGems CLI uses OAuth tokens to authenticate a request. To pass OAuth tokens to calls to your Artifact Registry repositories, you must first generate the token and then pass it with the address of your repository when you make a request. For example, the following command shows how to authenticate a push request:

export GEM_TOKEN="oauth2accesstoken:$(gcloud auth print-access-token)"
gem push GEM_NAME --source https://$GEM_TOKEN@LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY

Where:

  • GEM_NAME is the name of the gem for which the request is made.
  • LOCATION is the regional or multi-regional location for the repository.
  • PROJECT is the project ID. If this flag is omitted, the current or default project is used.
  • REPOSITORY is the ID of the repository. If you configured a default Artifact Registry repository, it is used when this flag is omitted from the command.

Authenticate with Bundler

The Ruby Bundler manages application dependencies across one or more gems. To set up Bundler, do the following:

  1. Add the address of your repository as a source in your gemfile:

    # Gemfile
# <...>
source "https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY"

  2. Authenticate to your repository by using bundle config:

    export GEM_TOKEN="oauth2accesstoken:$(gcloud auth print-access-token)"
export HOST="https://LOCATION-ruby.pkg.dev/PROJECT/REPOSITORY"
bundle config $HOST $GEM_TOKEN

Where:

  • LOCATION is the regional or multi-regional location for the repository.
  • PROJECT is the project ID. If this flag is omitted, the current or default project is used.
  • REPOSITORY is the ID of the repository. If you configured a default Artifact Registry repository, it is used when this flag is omitted from the command.

You will need to reauthenticate to your remote repository occasionally. In this event, run the same authentication command from Step 2.

For more information about configuring Bundler, see Gemfiles in the bundler.io documentation.

For more information about authentication methods, see Configure authentication to Artifact Registry for Ruby gem repositories.

Create a repository

Create the repository for your gem.

  1. Run the following command to create a new Ruby gem repository in the current project named quickstart-ruby-repo in the location us-west1.

    gcloud artifacts repositories create quickstart-ruby-repo \
    --repository-format=ruby \
    --location=us-west1 \
    --description="Ruby gem repository"

  2. Run the following command to verify that your repository was created:

    gcloud artifacts repositories list

  3. To simplify gcloud commands, set the default repository to quickstart-ruby-repo and the default location to us-west1. After the values are set, you don't need to specify them in gcloud commands that require a repository or a location.

    To set the repository, run the following command:

    gcloud config set artifacts/repository quickstart-ruby-repo

    To set the location, run the following command:

    gcloud config set artifacts/location us-west1

    For more information about these commands, see the gcloud config set documentation.

Download a gem

When you build a Ruby project, distribution files are saved in a lib subdirectory in your Ruby project. To simplify this quickstart, you will create a directory and then download a gem to that directory.

To create the directory, run the following command:

mkdir ruby-quickstart
mkdir ruby-quickstart/lib
cd ruby-quickstart/lib

Next, download your gem. You can either use your own gem or download a sample gem from the Popular Gems page on rubygems.org. To download a gem from rubygems.org, run the following command:

gem fetch GEM_NAME

You now have a gem titled GEM_NAME in your ruby_quickstart/lib directory. In the next section, you will use the RubyGems CLI to push your gem to your repository.

Push the gem to the repository

To push the gem to your repository, run the following command:

gem push GEM_NAME --host https://us-west1-ruby.pkg.dev/PROJECT/quickstart-ruby-repo

Where:

  • GEM_NAME is the name of the gem to push to your repository.
  • PROJECT is the project ID. If this flag is omitted, then the current or default project is used.

View the gem in the repository

To verify that your gem was added, list the packages in the ruby-quickstart repository.

Run the following command:

gcloud artifacts packages list --repository=ruby-quickstart

To view versions for a gem, run the following command:

gcloud artifacts versions list --package=GEM_NAME

Install the gem

To install the gem you just pushed to your Artifact Registry repository, run the following command:

export GEM_TOKEN="oauth2accesstoken:$(gcloud auth print-access-token)"
gem install GEM_NAME --source https://$GEM_TOKEN@us-west1-ruby.pkg.dev/PROJECT/quickstart-ruby-repo

Where:

  • GEM_NAME is the name of the gem to install in your repository.
  • PROJECT is the project ID. If this flag is omitted, then the current or default project is used.

Troubleshooting

See Troubleshooting for Ruby gems for more information.

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

Before you remove the repository, ensure that any gems you want to keep are available in another location.

  1. To delete the quickstart-ruby-repo repository, run the following command:

    gcloud artifacts repositories delete quickstart-ruby-repo

  2. If you want to remove the default repository and location settings that you configured for the active gcloud configuration, run the following commands:

    gcloud config unset artifacts/repository
gcloud config unset artifacts/location

What's next