Add your Ruby gems to AWS CodeArtifact

Up to date 8 Could 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 commonplace developer instruments like gem and bundler.

Purposes typically use quite a few packages to hurry up improvement by offering reusable code for widespread duties like community entry, cryptography, or knowledge 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.

Nonetheless, 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 need to additionally confirm that the included code is secure and doesn’t introduce vulnerabilities, a tactic often known as a provide chain assault. To handle these challenges, organizations sometimes use non-public bundle servers. Builders can solely use packages vetted by safety and authorized groups made obtainable by non-public repositories.

CodeArtifact is a managed service that enables the secure distribution of packages to inner 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 present instruments reminiscent of gem and bundler. After storing packages in CodeArtifact, you may reference them in your Gemfile. Your construct system will then obtain authorized packages from the CodeArtifact repository in the course of the construct course of.

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 ways I put together my atmosphere, add the bundle to the repository, and use this particular bundle construct as a dependency for my mission. 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 exploit 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 gathering 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"

Be aware 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 identify 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 atmosphere variable values to hook up with my non-public bundle repository.

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

$ gem construct hola.gemspec 

Efficiently constructed RubyGem
  Title: 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 on the market.

Now that the bundle is on the market, I can use it in my initiatives as ordinary. This entails configuring the native ~/.gemrc file on my machine. I comply with the directions offered by the console, and I be certain I exchange ${CODEARTIFACT_AUTH_TOKEN} with its precise worth.

As soon as ~/.gemrc is accurately 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
Performed 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’ll routinely fetch gems from upstream once I request one.

To affiliate the repository with rubygems.org, I exploit the console, or I sort

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

{
    "repository": {
        "identify": "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’ll routinely fetch packages from upstream when not regionally obtainable.

$ 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
Performed putting in documentation for rake after 0 seconds
1 gem put in

I exploit the console to confirm the rake bundle is now obtainable 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 will depend on three metrics: the storage (measured in GB monthly), the variety of requests, and the info switch out to the web or to different AWS Areas. Information switch to AWS companies in the identical Area just isn’t charged, which means you may 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 knowledge switch. As ordinary, the pricing web page has the main points.

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

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

— seb