jenkins-agent-ruby

Jenkins agent image for building Ruby applications

Jenkins Agent that enables building of Ruby source code and optimized for deployment to a Jenkins instance running in the OpenShift Container Platform.

Primary Components

• Ruby 2.6.2 runtime, including:
  • Bundler
  • RubyGems
• Nodejs 12

Instantiate Template

A template is available providing the necessary OpenShift components to build and make the agent image available to be referenced by Jenkins.

Execute the following command to instantiate the template:

oc process -f ../../.openshift/templates/jenkins-agent-generic-template.yml \
    -p NAME=jenkins-agent-ruby \
    -p SOURCE_CONTEXT_DIR=jenkins-agents/jenkins-agent-ruby \
    | oc create -f -

A new image build will be started automatically. For all params see the list in the ../../.openshift/templates/jenkins-agent-generic-template.yml or run oc process --parameters -f ../../.openshift/templates/jenkins-agent-generic-template.yml.

Use within Jenkins

The template contains an ImageStream that has been configured with the appropriate labels that will be picked up by newly deployed Jenkins instances.

For existing Jenkins servers, the agent can be added by using the following steps.

1. Login to Jenkins
2. Click on Manage Jenkins and then Configure System
3. Under the Cloud section, locate the Kubernetes Plugin. Click the Add Pod Template dropdown and select **
4. Enter the following details
   1. Name: jenkins-agent-ruby
   2. Labels: jenkins-agent-ruby
   3. Docker image
      1. Using the oc command line, run oc get is jenkins-agent-ruby --template='{{ .status.dockerImageRepository }}'. A value similar to docker-registry.default.svc:5000/jenkins/jenkins-agent-ruby should be used
   4. Jenkins agent root directory: /tmp
5. Click Save to apply the changes

Use within Jenkins Pipeline Script

The following provides an example of how to make use of the image within a Jenkins pipeline script to execute a simple install of dependencies:

node('jenkins-agent-ruby') {

  stage('Build Code') {

    sh """
      echo "source 'https://rubygems.org'
      gem 'nokogiri'" > Gemfile
      bundle install
      gem env
    """
  }
}