Add your Ruby gems to AWS CodeArtifact

Up to date 8 Might 2024: I up to date the command to gather RUBYGEMS_HOST to suppress the trailing /

Ruby builders can now use AWS CodeArtifact to securely retailer and retrieve their gems. CodeArtifact integrates with normal developer instruments like gem and bundler.

Functions usually use quite a few packages to hurry up improvement by offering reusable code for widespread duties like community entry, cryptography, or information manipulation. Builders additionally embed SDKs–such because the AWS SDKs–to entry distant companies. These packages could come from inside your group or from third events like open supply initiatives. Managing packages and dependencies is integral to software program improvement. Languages like Java, C#, JavaScript, Swift, and Python have instruments for downloading and resolving dependencies, and Ruby builders sometimes use gem and bundler.

Nevertheless, utilizing third-party packages presents authorized and safety challenges. Organizations should guarantee bundle licenses are suitable with their initiatives and don’t violate mental property. They have to additionally confirm that the included code is protected and doesn’t introduce vulnerabilities, a tactic often called a provide chain assault. To deal with these challenges, organizations sometimes use non-public bundle servers. Builders can solely use packages vetted by safety and authorized groups made accessible by non-public repositories.

CodeArtifact is a managed service that permits the protected distribution of packages to inside developer groups with out managing the underlying infrastructure. CodeArtifact now helps Ruby gems along with npm, PyPI, Maven, NuGet, SwiftPM, and generic codecs.

You’ll be able to publish and obtain Ruby gem dependencies out of your CodeArtifact repository within the AWS Cloud, working with current instruments resembling gem and bundler. After storing packages in CodeArtifact, you’ll be able to reference them in your Gemfile. Your construct system will then obtain accepted packages from the CodeArtifact repository throughout the construct course of.

The way to get began
Think about I’m engaged on a bundle to be shared with different improvement groups in my group.

On this demo, I present you the way I put together my surroundings, add the bundle to the repository, and use this particular bundle construct as a dependency for my venture. I deal with the steps particular to Ruby packages. You’ll be able to learn the tutorial written by my colleague Steven to get began with CodeArtifact.

I take advantage of an AWS account that has a bundle repository (MyGemsRepo) and area (stormacq-test) already configured.

To let the Ruby instruments acess my CodeArtifact repository, I begin by amassing an authentication token from CodeArtifact.

export CODEARTIFACT_AUTH_TOKEN=`aws codeartifact get-authorization-token 
                                     --domain stormacq-test              
                                     --domain-owner 012345678912         
                                     --query authorizationToken          
                                     --output textual content`

export GEM_HOST_API_KEY="Bearer $CODEARTIFACT_AUTH_TOKEN"

Observe that the authentication token expires after 12 hours. I need to repeat this command after 12 hours to acquire a recent token.

Then, I request the repository endpoint. I move the area title and area proprietor (the AWS account ID). Discover the --format ruby possibility.

export RUBYGEMS_HOST=`aws codeartifact get-repository-endpoint  
                           --domain stormacq-test               
                           --domain-owner 012345678912          
                           --format ruby                        
                           --repository MyGemsRepo              
                           --query repositoryEndpoint           
                           --output textual content | sed 's:/*$::'`

Now that I’ve the repository endpoint and an authentication token, gem will use these surroundings variable values to hook up with my non-public bundle repository.

I create a quite simple venture, construct it, and ship it to the bundle repository.

$ gem construct hola.gemspec 

Efficiently constructed RubyGem
  Identify: hola-codeartifact
  Model: 0.0.0
  File: hola-codeartifact-0.0.0.gem
  
$ gem push hola-codeartifact-0.0.0.gem 
Pushing gem to https://stormacq-test-486652066693.d.codeartifact.us-west-2.amazonaws.com/ruby/MyGemsRepo...

I confirm within the console that the bundle is obtainable.

Now that the bundle is obtainable, I can use it in my initiatives as ordinary. This includes configuring the native ~/.gemrc file on my machine. I observe the directions offered by the console, and I ensure that I change ${CODEARTIFACT_AUTH_TOKEN} with its precise worth.

As soon as ~/.gemrc is appropriately configured, I can set up gems as ordinary. They are going to be downloaded from my non-public gem repository.

$ gem set up hola-codeartifact

Fetching hola-codeartifact-0.0.0.gem
Efficiently put in hola-codeartifact-0.0.0
Parsing documentation for hola-codeartifact-0.0.0
Putting in ri documentation for hola-codeartifact-0.0.0
Finished putting in documentation for hola-codeartifact after 0 seconds
1 gem put in

Set up from upstream
I may also affiliate my repository with an upstream supply. It would routinely fetch gems from upstream after I request one.

To affiliate the repository with rubygems.org, I take advantage of the console, or I sort

aws codeartifact  associate-external-connection 
                   --domain stormacq-test       
                   --repository MyGemsRepo      
                   --external-connection public:ruby-gems-org

{
    "repository": {
        "title": "MyGemsRepo",
        "administratorAccount": "012345678912",
        "domainName": "stormacq-test",
        "domainOwner": "012345678912",
        "arn": "arn:aws:codeartifact:us-west-2:012345678912:repository/stormacq-test/MyGemsRepo",
        "upstreams": [],
        "externalConnections": [
            {
                "externalConnectionName": "public:ruby-gems-org",
                "packageFormat": "ruby",
                "status": "AVAILABLE"
            }
        ],
        "createdTime": "2024-04-12T12:58:44.101000+02:00"
    }
}

As soon as related, I can pull any gems by CodeArtifact. It would routinely fetch packages from upstream when not domestically accessible.

$ gem set up rake 

Fetching rake-13.2.1.gem
Efficiently put in rake-13.2.1
Parsing documentation for rake-13.2.1
Putting in ri documentation for rake-13.2.1
Finished putting in documentation for rake after 0 seconds
1 gem put in

I take advantage of the console to confirm the rake bundle is now accessible in my repo.

Issues to know
There are some issues to bear in mind earlier than importing your first Ruby packages.

Pricing and availability
CodeArtifact prices for Ruby packages are the identical as for the opposite bundle codecs already supported. CodeArtifact billing depends upon three metrics: the storage (measured in GB per 30 days), the variety of requests, and the information switch out to the web or to different AWS Areas. Information switch to AWS companies in the identical Area will not be charged, which means you’ll be able to run your steady integration and supply (CI/CD) jobs on Amazon Elastic Compute Cloud (Amazon EC2) or AWS CodeBuild, for instance, with out incurring a cost for the CodeArtifact information switch. As ordinary, the pricing web page has the small print.

CodeArtifact for Ruby packages is obtainable in all 13 Areas the place CodeArtifact is obtainable.

Now, go construct your Ruby functions and add your non-public packages to CodeArtifact!

— seb