A Getting Started Guide to Setting Up Jenkins
The goal of this getting started guide is to help teams get Jenkins continuous integration (CI) servers configured, and discover how to make a newly deployed CI infrastructure fully operational. Jenkins is a leading open source CI server. It is flexible, providing hundreds of plugins to support building, testing, and deployment, and is capable of automating any project. Jenkins CI infrastructure can be deployed to on-prem, in the cloud using configuration management tools, and third-party vendor. The purpose of this article, let's assume that our Jenkins CI servers are deployed in the cloud and focus on configuration of Jenkins’ web interface. I will walk through various processes and steps to set up a new Jenkins CI server for production.
Recommended best practices for CI architecture
Don't jump head first into configuration and creating a pipeline without planning, designing and establishing standards for your CI architecture. Taking the time to think about infrastructure first will enable a stable and restorable infrastructure. Let's review a few recommended best practices to consider in your future CI pipeline.
Backup CI Server (Fail Safe)
It may seem obvious. Recommend setting up a backup process for Jenkins configuration. Script a Jenkins job to use the thinBackup plugin or S3 plugin to send the Jenkins configuration to an Amazon S3 (cloud storage).
Here are recommendations to consider: set environment variables (i.e., hidden passwords, SSH keys, API keys, etc.); security—create generic reusable jobs, naming conventions (i.e., jobs and environment variables); keep jobs small—modulization, scalable infrastructure that allows for auto-scaling of Slave nodes.
Discovery of Plugins
Be conservative with plugin usage. In my experience, plugins change all the time and become fragile. For the discovery mode of finding the right plugins for your CI infrastructure, I recommend evaluating if you can script the same functionality yourself rather than being dependent on third-party plugins. Just minimize your plugin usage. Having an upgrade process is important. Don't test upgrades on the live production CI server. Set up a test environment to check all new plugins or new Jenkins versions using existing jobs before applying a change to your production server.
Configuration Management Tooling
The basics of setting up a Jenkins Master server
In this section of the guide, I will walk you through some steps to set up and manage Jenkins.
Discover, Install and Manage Plugins
Jenkins has hundreds of useful plugins. Plugins will eliminate the need to create custom scripting to solve common problems with minimal pain. Just remember plugins change often and become fragile. Minimize your plugin usage if possible.
- Navigate to Jenkins Web Interface > Login as Admin > Manage Jenkins > Manage Plugins > Available (Tab)
- Select checkbox for all the plugins you want to install
- Select "Download now and install after restart" at the bottom of the page.
- After Jenkins finishes restarting, the installed plugins will appear under Manage Plugins > Installed (Tab)
Here are a few Jenkins plugin recommendations:
- Git - allows you to integrate GitHub to clone repository
- GitHub Pull Request Builder - builds pull requests in GitHub and reports results
- Swarm - enables slaves to auto-discover nearby Jenkins master and join it automatically
- Sauce OnDemand - allows you to integrate Sauce Labs Selenium testing with Jenkins
- Pipeline - suite of plugins that lets you orchestrate automation, simple or complex
- Slack - allows posting of build notifications to a Slack channel
- Thinbackup - simply backs up the global and job-specific configurations
Configure System Settings
As an admin of Jenkins, the Configure System page is a critical configuration section. This page represents a variety of sections, each correlating to a different configuration area from generic Jenkins settings, defining global environment variables, and most installed plugins are configured on this page.
- Navigate to Jenkins Web Interface > Login as Admin > Manage Jenkins > Configure System
- Configure the root directory for workspace and build record.
- Set the Jenkins Master executors to 0, setting up separate cloud instances to be the workers; Jenkins Master will only be the orchestrator.
- Set environment variables (i.e. SLACK_TOKEN, SAUCE_API_KEY).
- Configure the installed plugins (i.e. GitHub, Sauce Labs, Slack, etc.); typically involves adding API keys or shared secrets.
Configure Global Settings
Straight out of the box Jenkins will allow anyone to run anything as a user of Jenkins along with admin permissions, which is bad. I suggest enabling Lightweight Directory Access Protocol (LDAP), wich allows you to use corporate service. Users can log into Jenkins with their usual company login credentials.
- Navigate to Jenkins Web Interface > Login as Admin > Manage Jenkins > Configure Global Security
- Select checkbox to enable security.
- Set TCP port for JNLP slave agents to 9000.
- Select LDAP from the Access Control (Security Realm) section and enter your LDAP server address:
- Select matrix-based security from the Access Control (Authorization) section
- Select the checkbox for Prevent Cross Site Request Forgery Exploits, and Enable Slave --> Master Access Control
Add Node (Slave)
There are multiple ways to add and configure a slave node farm. In all cases, a build, test, or deploy job are being run on a slave node. When it comes to creating multiple slave nodes, it is typically a straightforward process.
Advanced - we create a farm on Scalr with a Jenkins Master server and at least a handful of slave nodes for building and testing the application. We use the Swarm plugin to enable slave nodes to auto-discover a nearby Jenkins Master and join it automatically. You can also manually run a curl command and add slave nodes to the Jenkins Master. It’s clear as mud, right? In layman terms, a slave node is a machine configured to clone the source code, compile, execute tests, or any tools needed. Lastly, the build results are stored on the Jenkins Master, and artifacts should always end up in artifact storage (i.e. Artifactory) not on the Jenkins Master.
- Check that the new Node is ONLINE.
- Navigate to Jenkins Web Interface > Login as Admin > Manage Jenkins > Manage Nodes
Jenkins is a very flexible application which involves a great deal of control for admins. It is easy to see when accessing the Jenkins admin page that we have only scratched the surface, but have laid a solid foundation to continue learning how to setup and manage Jenkins.
Go Time! Ready to Create a CI Pipeline
Now that Jenkins is configured, you are ready to orchestrate or maintain a CI pipeline. I recommend checking out the Jenkins documentation Getting Started with Pipeline to create and deploy your first CI pipeline.
The main motivation behind this article is to help everyone identify the basic settings and recommended best practices for setting up Jenkins Master and Slave architecture, then have the incentive and convenience to participate in CI architecture, along with enforcing discipline by assigning blame if the build, deployment, or test fails.
Interested in learning more? Come visit Sauce Labs at Jenkins World 2016.
Greg Sypolt (@gregsypolt) is a Senior Engineer at Gannett – USA Today Network and co-founder of Quality Element. He is a passionate automation engineer seeking to optimize software development quality, while coaching team members on how to write great automation scripts and helping the testing community become better testers. Greg has spent most of his career working on software quality—concentrating on web browsers, APIs, and mobile. For the past 5+ years, he has focused on the creation and deployment of automated test strategies, frameworks, tools and platforms and continuous integration.
- Accessibility Testing
- Appium Resources
- Best Practices
- Continuous Delivery
- Continuous Integration
- Continuous Testing
- Cross Browser Testing
- Guest Blog Posts
- Load Testing
- Machine Learning
- Mobile Development & Testing
- News & Product Updates
- Open Sauce
- Open Source
- Performance Testing
- Product Updates
- Quality Assurance
- Quality Engineering
- Sauce Product Info
- Security Testing
- Selenium Resources
- Software Development & Testing
- The Story of Sauce