Continuous integration/Jenkins job builder

Jenkins Job builder (abbreviated JJB) is a python script to maintain and simplify configuration of Jenkins jobs. Jenkins internally stores configuration of jobs in an XML format. JJB instead maintains jobs as simple descriptions in YAML format, which are then expanded to XML and uploaded to Jenkins through its HTTP API.

Upstream documentation is available at: https://docs.openstack.org/infra/jenkins-job-builder/.

Note: which jobs are triggered for which events is handled by Zuul via zuul/layout.yaml.

How it works

All jobs for Wikimedia Jenkins are managed by JJB. To create or change jobs, edit the YAML files in the integration/config repository (submit a change, have it reviewed/merged by someone else).

Deployment must be done from the reviewer's local workstation. (Unlike mediawiki deployment, JJB does not run on the server.)

Install JJB

The recommended way is to use a virtualenv defined in integration/config.git, it ensures the proper version of JJB is used. You will need tox, a helper to setup python virtual environments. To install and run jjb:

$ git clone https://gerrit.wikimedia.org/r/integration/config.git
$ cd config
$ tox -e jenkins-jobs -- <arguments>

Configure JJB

JJB requires a basic authentication file with Jenkins credentials. Authentication is only needed if you intent to deploy changes to Jenkins. For local testing and validation, no authentication credentials are needed (just create a dummy file with empty user and password fields).

Our main installation at https://integration.wikimedia.org/ci/ only allows users in the ciadmin LDAP group to upload jobs.

To obtain an API token, log into Jenkins and open the "Configure" tab of your account (JENKINS_URL/user/USERNAME/configure; e.g. https://integration.wikimedia.org/ci/user/Krinkle/configure). Click the "Add API Token", give it a name (eg. "jjb"), and then copy the your new API token.

Create a jenkins_jobs.ini file within your integration/config.git checkout and ensure to make it readable only by your user chmod 0500 jenkins_jobs.ini:

[job_builder]
allow_duplicates=True

[jenkins]
user=USERNAME
password=API_TOKEN
url=https://integration.wikimedia.org/ci/
query_plugins_info=False

Troubleshooting

A few common problems that may occur when installing JJB.

pyconfig.h

If you get an error message that contains stuff like:

 ext/_yaml.c:8:22: fatal error: pyconfig.h: No such file or directory
  #include "pyconfig.h"
                      ^
 compilation terminated.

then you need to install python development dependencies. In Debian / Ubuntu that is:

sudo apt-get install python-dev

six.moves

$ jenkins-jobs --conf jenkins_jobs.ini test jjb/ -o output/
Traceback (most recent call last):
  File "/usr/local/bin/jenkins-jobs", line 6, in <module>
    from jenkins_jobs.cmd import main
  File "/Users/krinkle/Development/wikimedia/integration/jenkins-job-builder/jenkins_jobs/cmd.py", line 17, in <module>
    from six.moves import configparser, StringIO
ImportError: No module named six.moves

This happens with the Python 2.7 version that ships with Mac OS X 10.9 (Mavericks). macOS 10.12 and higher are not affected. On the older Mac OS X versions, you can use Homebrew to install a newer Python 2.7.x, and using its pip to build jenkins-job-buider fixes the six-moves issue.

Modifying jobs

See also Install JJB - You need to have it installed locally before you can test or validate config files.

• Modify jobs by editing the YAML files in the integration/config.git repository.
• Read the documentation to learn what features are available (JJB internally maps the YAML format to the XML format for the Jenkins API, properties might have slightly different names, or might work differently, or might not be supported).
• Use an editor with YAML syntax highlighting and ideally YAML linting as well. The YAML format relies on indentation for its structure (similar to Python); it's easy to make mistakes.
• Once done editing, run the following in your integration/config directory:

  $ tox -e jenkins-jobs -- --conf jenkins_jobs.ini test jjb/ -o output/
  

  or use the helper script in the repo

  $ ./jjb-test -o output/
  

  This verifies everything works as expected (aside from the YAML syntax, incorrect indentation can break things, or naming collisions with Python interfaces).
• Commit your modifications to a local topic branch (keep master clean), and send to Gerrit for review.

Output directory should now contains files like this:

$ ls -1 output/
mediawiki-phpunit
operations-puppet-validate
...

Deploy changes

See also Install JJB - For deploying changes, JJB must be installed, configured, and authenticated

Check out the relevant change for integration/config from Gerrit. Ensure the change is rebased onto latest master to avoid accidentally undoing other changes.

integration/config$ git review -d 139035

Now use the JJB "test" command to validate the YAML files and generate the XML files that represent the Jenkins jobs.

config$ rm -f output/* && tox -e jenkins-jobs -- --conf jenkins_jobs.ini test jjb/ -o output/

If that command results in error, there is either a YAML syntax error or invalid an JJB structure inside the YAML file. The config patch will need amending in that case. Do not deploy!

If there are no errors, review the XML file for your job:

config$ cat output/example-jenkins-job
<?xml ..
...

To know which jobs are affected, check the output of the jjb-diff job on Gerrit changes for integration/config.

Avoid merged changes in integration/config unless you have also deployed updated versions of the affected jobs to Jenkins. It is customary to update jobs locally when checking out the patch as reviewer, and then +2 afterwards to record the change (instead of the other way around).

If the job looks correct, upload the updated Jenkins job configurations to Jenkins.

The jenkins-jobs update command accepts multiple (variadic) arguments, each of which may use the fnmatch patterns.

# Deploy one job
$ tox -e jenkins-jobs -- --conf jenkins_jobs.ini update jjb/ 'example-jenkins-job'

 .. INFO:root:Updating jobs in jjb/ (['example-jenkins-job'])
 .. INFO:jenkins_jobs.builder:Reconfiguring example-jenkins-job

# Deploy multiple jobs at once with a pattern
$ tox -e jenkins-jobs -- --conf jenkins_jobs.ini update jjb/ '*-example'
 ..

# Deploy multiple jobs at once with multiple patterns
$ tox -e jenkins-jobs -- --conf jenkins_jobs.ini update jjb/ '*foo*' '*bar*'
 ..
# Alternativly you can use the helper script in the repo
$ ./jjb-update 'example-jenkins-job'
$ ./jjb-update '*example'
$ ./jjb-update '*foo*' '*bar*'

Debugging JJB

• You can enable debugging output by passing -l debug
• Jenkins job builder maintains a cache of jobs and will not resubmit a job if it considers it already up to date. You will want to delete the file ~/.jenkins_jobs_cache.yml to force the update.

Deleting a job

If you are deleting a job, the regular jjb update command will not work (since it only updates jobs it's aware of). To delete jobs, you can use the jjb-delete script in the integration/config repository.

Synchronizing all jobs

This might overwrite things you don't intend to. You usually do not want to do this.

Known issues:

• Updating all jobs does not allow one to control the order in which jobs are uploaded. Given our Jenkins instance is actively used, this will lead to problems where job A depends on job B, but job B is still absent or outdated.

Deploying changes to zuul config

Changes to zuul/layout.yaml are deployed using fabric, by running the following command:

$ ./fab deploy_zuul

See Continuous integration/Zuul#Update configuration for detailed instructions.

Deploying changes to dockerfiles

Changes to dockerfiles/* are deployed using fabric, by running the following command:

$ ./fab deploy_docker