document Jenkins user permissions
This document the required permissions of the Zuul Jenkins user.
Change-Id: Id977e3813f943b032c7628d8cdc663b3bdbb688d
Reviewed-on: https://review.openstack.org/16528
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
diff --git a/doc/source/launchers.rst b/doc/source/launchers.rst
index 70b1455..b27882f 100644
--- a/doc/source/launchers.rst
+++ b/doc/source/launchers.rst
@@ -29,9 +29,13 @@
https://jenkins.example.com/user/USERNAME/configure
And click **Show API Token** to retrieve the API token for that user.
-You will need this later when configuring Zuul. Make sure that this
-user has appropriate permission to build any jobs that you want Zuul
-to trigger.
+You will need this later when configuring Zuul. Appropriate user
+permissions must be set under the Jenkins security matrix: under the
+``Global`` group of permissions, check ``Read``, then under the ``Job``
+group of permissions, check ``Read`` and ``Build``. Finally, under
+``Run`` check ``Update``. If using a per project matrix, make sure the
+user permissions are properly set for any jobs that you want Zuul to
+trigger.
Make sure the notification plugin is installed. Visit the plugin
manager on your jenkins: