jjb/jenkins-job-builder
Code Issues Proposed changes

Merge "Allow update to provide plugin_info via yaml"

Browse Source
This commit is contained in:
Jenkins
2017-09-26 15:16:32 +00:00
committed by Gerrit Code Review
parent eff67d90f7 2974f1e636
commit 5be08a5be6
6 changed files with 97 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/execution.rst
View File

@@ -313,6 +313,22 @@ To delete jobs/views that only have 'foo' in their name::
jenkins-jobs delete --path ./myjobs \*foo\*
Providing Plugins Info
^^^^^^^^^^^^^^^^^^^^^^
With Jenkins LTS 1.651.1+ retrieving plugins info became a secure feature and
now requires Administrator rights to use [#f2]. This causes JJB to no longer be
able to work in situations where a user wants to publish jobs to Jenkins but is
not able to receive the Administrator permissions. In this case we can provide
a plugins_info.yaml file containing the plugin versions data needed by JJB to
parse the job templates.
To generate a plugins info, using an account with Administrator rights:
jenkins-jobs get-plugins-info -o plugins_info.yaml
To run JJB update using the plugins_info.yaml:
jenkins-jobs update -p plugins_info.yaml ./myjobs
.. _command-reference:
@@ -323,8 +339,11 @@ Command Reference
.. program-output:: jenkins-jobs update --help
.. program-output:: jenkins-jobs delete-all --help
.. program-output:: jenkins-jobs delete --help
.. program-output:: jenkins-jobs get-plugins-info --help
.. rubric:: Footnotes
.. [#f1] The cache default location is at ``~/.cache/jenkins_jobs``, which
can be overridden by setting the ``XDG_CACHE_HOME`` environment
variable.
.. [#f2] Jenkins Security Advisory affecting plugins info retrieval
https://wiki.jenkins-ci.org/display/SECURITY/Jenkins+Security+Advisory+2016-05-11

12
doc/source/quick-start.rst
View File

@@ -80,6 +80,18 @@ To delete a job::
The above command deletes the job `simple` from the Jenkins master.
.. _use-case-5:
Use Case 5: Providing plugins info
----------------------------------
To generate a plugins info, using an account with Administrator rights:
jenkins-jobs get-plugins-info -o plugins_info.yaml
To run JJB update using the plugins_info.yaml:
jenkins-jobs update -p plugins_info.yaml ./myjobs
Please refer to the jenkins-jobs :ref:`command-reference` and the