Skip to content

Installing Jenkins

Jump to bottom
Ben Heasly edited this page Jan 23, 2017 · 27 revisions

One good use for MatlabJobSupport will be to run automated tests and validations on a remote Jenkins server. This page is about how to install Jenkins and integrate with GitHub and Matlab.

See Creating Jenkins Tests for more about setting up tests for specific projects.

Work in progress. Coming soon...

EC2 Instance

We need a server to run Jenkins. In order for Jenkins to run MatlabJobSupport jobs, the server also needs to have Matlab and Docker installed.

In the Brainard Lab AWS account, we have machine image all set up for this. It's the AMI called RTB Jobs 9.

For these instructions, I will refer to an instance that I just now set up and I hope to leave running. Here are its stats:

  • AMI RTB Jobs 9
  • instance type m4.large
  • IAM role ecsInstanceRole
  • 50GB "GP2" SSD root volume
  • Name = Jenkins
  • security sroups all-ssh and web
  • SSH key pair named render-toolbox
  • elastic IP address 50.112.42.141

I can SSH to this instance with:

ssh -i render-tooblox.pem ubuntu@50.112.42.141

Jenkins Setup

To set up Jenkins on this instance, I am following the Jenkins wiki. I used the sections "Installation" and "Using Linux iptables for port 80 -> 8080", just as written.

Installation

wget -q -O - https://pkg.jenkins.io/debian/jenkins-ci.org.key | sudo apt-key add -
sudo sh -c 'echo deb http://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list'
sudo apt-get update
sudo apt-get install jenkins

Using Linux iptables for port 80 -> 8080

#Requests from outside
sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-ports 8080
#Requests from localhost
sudo iptables -t nat -I OUTPUT -p tcp -d 127.0.0.1 --dport 80 -j REDIRECT --to-ports 8080

Browser Test

Then I was able to access Jenkins at its elastic IP address. Here.

Initial Password

Jenkins starts with a special initial password. I was able to discover this from the SSH terminal using either of these commands:

# either
sudo cat /var/lib/jenkins/secrets/initialAdminPassword

# or
cat /var/log/jenkins/jenkins.log

Jenkins Startup

After entering the initial password, I followed the Jenkins startup wizard. I chose the default set of plugins and created an admin user with a strong password.

Docker Group

For MatlabJobSupport, we want Jenkins to be able to invoke Docker commands. So we need to put the jenkins user into the docker group. This requires a restart of Jenkins and Docker (but not the whole system).

sudo gpasswd -a jenkins docker
sudo service docker restart
sudo service jenkins restart

Jenkins Plugins

Finally, I installed some more Jenkins plugins that will come in handy.

  • choose Manage Jenkins -> Manage Plugins -> Available
  • check Embeddable Build Status Plugin
  • check TAP Plugin
  • choose Install without Restart

GitHub Integration

Now that Jenkins is set up, I am connecting it to GitHub. I'm taking advice from a blog called The Right Code, and the Jenkins GitHub plugin

Create SSH Key Pair for jenkins User

We need an SSH key pair for the jenkins user so that Jenkins can authenticate with GitHub.

sudo passwd jenkins
# enter a password
su jenkins
# enter that password
ssh-keygen -t rsa -b 4096 -C "render.toolbox@gmail.com"
# enter that password
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa
# enter that password
exit

Put the SSH public key on GitHub

Now that we have the key pair, we can register the public key with GitHub.

I am using our "render.toolbox" GitHub account. But there is nothing special about that account. The same should work with any account that has access to our GitHub organizations.

su jenkins
# enter that password
cat ~/.ssh/id_rsa.pub
# copy it
exit
# GitHub log in as render.toolbox@gmail.com
# paste in new ssh key

Now log in to GitHub as "render.toolbox@gmail.com"

  • choose Settings -> SSH and GPG Keys
  • choose New SSH key
  • Title "Jenkins"
  • paste in the key from above
  • choose Add SSH key

GitHub Access Token for Jenkins

From GitHub, create a Person Access Token for Jenkins to use. This will allow Jenkins to get notified about GitHub commits and and to set build statuses that we can see at GitHub.

Log in to GitHub as "render.toolbox@gmail.com"

  • choose Settings -> Personal access tokens
  • choose Generate new token
  • Token description "Jenkins"
  • Select scopes:
    • repo
    • admin:org
    • admin:repo_hook
    • admin:org_hook
    • notifications
  • choose Generate token
  • copy the new token to the clipboard

Now put the token into Jenkins

  • choose Manage Jenkins -> Configure System -> GitHub -> Add GitHub Server
  • choose Credentials -> Add -> Jenkins
  • choose Kind -> Secret Text
  • Secret, paste in the token copied above
  • ID "GitHub"
  • choose Add
  • in Credentials drop-down, select "GitHub"
  • choose Test Connection
  • choose Save

Test It Out

Need to set up a job to be triggered by GitHub In Jenkins Select a job Choose "GitHub project", add URL In Source Code Management, choose "git", add URL, branches to build "/" Choose "Build when a change is pushed to GitHub" Add post-build action "set GitHub commit status", use Status Result: "one of default messages and statuses" Make a test change at github Status shows in commit log Status shows in PR discussion

Matlab Integration

TAP plugin

http://blogs.mathworks.com/developer/2016/09/29/tap-with-yaml/ http://blogs.mathworks.com/developer/2016/10/24/passing-diagnostics/ http://blogs.mathworks.com/developer/2016/10/31/diagnostic-records/ http://blogs.mathworks.com/developer/2016/11/17/test-report/

http://blogs.mathworks.com/developer/2015/01/20/the-other-kind-of-continuous-integration/?s_tid=srchtitle

Status Badges

For example, in README. Or anywhere. Embeddabel Build Status plugin.

Install "Embeddable Build Status" plugin Choose a job -> Embeddable Build Status -> copy "protected" url Paste url into eg GitHub README Install "Role-based Authorization Strategy" plugin Manage Jenkins -> Configure Global Security Choose "Role-Based Strategy" Manage Jenkins -> Manage and Assign Roles -> Manage Roles Global roles, create "anonymous", check "ViewStatus" Manage Jenkins -> Manage and Assign Roles -> Assign Roles Global roles, for "Anonymous", check "anonymous" Check GitHub README

Clone this wiki locally