Back to roles list

sa-box-jenkins

Build Status

Example of usage:

- {
    role: "sa-box-jenkins"
  }

Dive into continious integration with Jenkins.

Background

Nowadays continious integration is the important part of the agile software development life cycle. There is a number of tools on the market: Atlassian Bamboo, Jenkins, Jetbrains TeamCity. In my opinion Jenkins has the most optimal product community and set of really useful plugins that suits most of your software projects: you can build software, deploy software,
websites, portals to various places, including AWS, DigitalOcean, bare metal servers or to run unit tests. It can be integrated with communication tools of your choice, like Slack, HipChat or email.

If you haven't had a chance to try Jenkins earlier, feel free to use tutorial below to start.

Manual installation

In order to install Jenkins, we will need:

  • Unix system. I would recommend debian based, like ubuntu server LTS
  • Java runtime environment installed. I usually use Java 8
  • Get base Jenkins setup
  • Install necessary plugins
  • Put behind web server.

Install Java

Easist way to install Java, is using apt-get package manager

sudo apt-get install python-software-properties
sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update

Once you added ppa above, you can install java with the following command:

sudo apt-get install oracle-java8-installer

Get base Jenkins setup

You will need to execut series of the commands, namely: add jenkins signing key, register jenkins apt sources, update package lists, and install Jenkins package.

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

By default, it will install base Jenkins setup, which is insecure. You will need to go to the host were your Jenkins is installed, for example: http://jenkins-host:8080/. Navigate to Manage Jenkins (on the left) and choose "Configure Global Security" item on the page loaded. enable security

Now look below on the Matrix based security (select it, if it is not selected previously), and make sure Anonymous only has the Read right under the View group. Click save at the bottom of the page. After the page load, you'll see a login form, simply ignore that, go to the home page (like, for example, http://jenkins-host:8080/). You'll see this sign up form, the first signed up account will be the administrator.

Power of plugins.

Jenkins would not be so powerful without plugins. Usually I install next plugins by default:

Plugins are installed using Plugin manager on a Manage Jenkins Section. Plugins manager

Put behind web server

Usually I hide Jenkins behind nginx. Typical configuration looks like the one below

server {
  listen 443 ssl;
  server_name jenkins.vagrant.dev;

  ssl_certificate /etc/nginx/jenkins_selfsigned.crt;
  ssl_certificate_key /etc/nginx/jenkins_selfsigned.key;

  location / {
    proxy_pass http://127.0.0.1:8080;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_redirect off;

    proxy_connect_timeout 150;
    proxy_send_timeout 100;
    proxy_read_timeout 100;
  }
  ...
}

Automated installation

Do I install Jenkins manually each time? Of course not, I do it often for my customers. With ansible, and sa-box-jenkins role new Jenkins installation can be deployed while you drink the coffee.

Let's prepare basic bootstrap project, that can be used by you in the future. It includes following files:

  • bootstrap.sh - installs ansible alongside with dependences.
  • init.sh - initializes 3rd party dependencies
  • .projmodules - fully compatible with .gitmodules git syntax, specifies list of the dependencies that will be used by the playbook. In particular, it includes ansible- by default developer_recipes (repository with set of handy deployment recipes) and ansible role called sa-box-bootstrap responsible for box securing steps (assuming you plan to put Jenkins on a remote hosts).
[submodule "public/ansible_developer_recipes"]
    path = public/ansible_developer_recipes
    url = git@github.com:Voronenko/ansible-developer_recipes.git
[submodule "roles/sa-box-bootstrap"]
        path = roles/sa-box-bootstrap
        url = git@github.com:softasap/sa-box-bootstrap.git
[submodule "roles/sa-box-jenkins"]
        path = roles/sa-box-jenkins
        url = git@github.com:softasap/sa-box-jenkins.git
  • hosts - list here the initial box credentials, that were provided to you for the server. Note: jenkins-bootstrap assumes, you have the fresh box with the root access only. If your box already secured, adjust credentials appropriately

UPDATE Sep 2016, ansible2 - now you need to split into to different inventory files, because different users are used:

hostsbootstrap:

[jenkins-bootstrap]
jenkins_bootstrap ansible_ssh_host=192.168.0.17 ansible_ssh_user=yourrootuser ansible_ssh_pass=yourpassword

hosts:

[jenkins]
jenkins ansible_ssh_host=192.168.0.17 ansible_ssh_user=jenkins
  • jenkins_vars.yml - set here specific environment overrides, like your preferred deploy user name and keys.
  • jenkins_bootstrap.yml - First step - box securing. Creates jenkins user, and secures the box using sa-box-bootstrap role. See more details about the sa-box-bootstrap role In order, to override params for sa-box-bootstrap - pass the parameters like in example below.
- hosts: all

  vars_files:
    - ./jenkins_vars.yml
  roles:
     - {
         role: "sa-box-bootstrap",
         root_dir: "{{playbook_dir}}/public/ansible_developer_recipes",
         deploy_user: "{{jenkins_user}}",
         deploy_user_authorized_keys: "{{jenkins_authorized_keys}}"
       }</pre>
- *jenkins.yml* provisioning script that configures jenkins with set of plugins and users.
- *jenkins_vars.yml* configuration options for jenkins deployment.
- *setup_jenkins.sh* shell script that invokes deployment in two steps: initial box bootstraping & jenkins setup

#!/bin/sh

ansible-playbook jenkins_bootstrap.yml --limit jenkins_bootstrap ansible-playbook jenkins.yml --limit jenkins



## Configuration options for automated installation
You need to override:
- jenkins_authorized_keys (this is list of the keys, that allow you to login to Jenkins box under jenkins)
- jenkins_domain - your agency domain
- jenkins_host - name of the jenkins host (Site will be binded to jenkins_host.jenkins_domain)
- jenkins_admin_password: SECURE PASSWORD

YOu can override:
  • java_version - your Java choice (6,7,8 supported)

jenkins_user: jenkins jenkins_authorized_keys:

  • "{{playbook_dir}}/components/files/ssh/vyacheslav.pub"

jenkins_domain: "vagrant.dev" jenkins_host: "jenkins"

jenkins_admin_password: Flvby

java_version: 8


-jenkins_users list of users with passwords to create.  Deploy is required users. Admin is precreated.
Admin is used to manage instance, deploy is used to access the artifacts via deployment scripts.
If you won't override passwords, default one will be used (per role), which is not the best, for public deployments.

jenkins_admin_password: Flvby jenkins_users:

  • { name: "deploy", password: "DeDeDeDeploy", email: "no-reply@localhost" }

- jenkins_plugins Your choice of plugins to install. By default:

jenkins_plugins:


## Code in action

Code can be downloaded from repository [https://github.com/Voronenko/devops-jenkins-box-template](https://github.com/Voronenko/devops-jenkins-box-template)
In order to use it - fork it, adjust parameters to your needs, and use.

Running is as simple as

./setup_jenkins.sh


Welcome to the world of continious integration & deployment.



Usage with ansible galaxy workflow
----------------------------------

If you installed the sa-box-jenkins role using the command

`
   ansible-galaxy install softasap.sa-box-jenkins
`

the role will be available in the folder library/softasap.sa-box-jenkins
Please adjust the path accordingly.

```YAML

     - {
         role: "softasap.sa-box-jenkins"
       }

History of changes

1.2.0

UPD may 2017: Experimental support for CENTOS-7, and potentially other compatible distributions.

1.1.0

UPD sept 2016: now installs Jenkins 2 by default. See box-example role folder to get example of standalone deployment script for your organization.

Copyright and license

Code licensed under the [BSD 3 clause] (https://opensource.org/licenses/BSD-3-Clause) or the [MIT License] (http://opensource.org/licenses/MIT).

Subscribe for roles updates at [FB] (https://www.facebook.com/SoftAsap/)

Join gitter discussion channel at Gitter