![Antoine Musso](/assets/img/avatar_default.png)
Running Sphinx 1.2b1 running in strict mode (-W), yields three different errors: * .. Running:: is an unknown command, uses '.. rubric::' instead * double stars '**' needs either to be escaped with backslashes or quoted literrally with double backquotes * nested lists needs newlines before and after for some reason. Change-Id: I8680aef7306c619c817c637882715f5a7d08c5d9
2.7 KiB
Installation
To install Jenkins Job Builder, run:
sudo python setup.py install
The OpenStack project uses puppet to manage its infrastructure systems, including Jenkins. If you use Puppet, you can use the OpenStack Jenkins module to install Jenkins Job Builder.
Configuration File
After installation, you will need to create a configuration file. By
default, jenkins-jobs looks in
/etc/jenkins_jobs/jenkins_jobs.ini
but you may specify an
alternate location when running jenkins-jobs. The file should have the
following format:
[jenkins]
user=USERNAME
password=PASSWORD
url=JENKINS_URL
- user
-
This should be the name of a user previously defined in Jenkins. Appropriate user permissions must be set under the Jenkins security matrix: under the
Global
group of permissions, checkRead
, then under theJob
group of permissions, checkCreate
,Delete
,Configure
and finallyRead
. - password
-
The API token for the user specified. You can get this through the Jenkins management interface under
People
-> username ->Configure
and then click theShow API Token
button. - url
-
The base URL for your Jenkins installation.
Running
After it's installed and configured, you can invoke Jenkins Job
Builder by running jenkins-jobs
. You won't be able to do
anything useful just yet without a configuration which is discussed in
the next section.
Usage
jenkins-jobs --help
Testing
Once you have a configuration defined, you can test it with:
jenkins-jobs test /path/to/config -o /path/to/output
That will write XML files to the output directory for all of the jobs defined in the configuration directory. When you're satisfied, you can run:
jenkins-jobs update /path/to/config
Which will upload the configurations to Jenkins if needed. Jenkins Job Builder maintains, for each host, a cache1 of previously configured jobs, so that you can run that command as often as you like, and it will only update the configuration in Jenkins if the defined configuration has changed since the last time it was run. Note: if you modify a job directly in Jenkins, jenkins-jobs will not know about it and will not update it.
To update a specific list of jobs, simply pass them as additional arguments after the configuration path. To update Foo1 and Foo2 run:
jenkins-jobs update /path/to/config Foo1 Foo2
Footnotes
The cache default location is at
~/.cache/jenkins_jobs
, which can be overriden by setting theXDG_CACHE_HOME
environment variable.↩︎