Clean up tox.ini and document zuul.yaml settings

I tried to remove --sitepacakges and the gate failed
so I added comment and in the .zuul.yaml so future people
will understand why.

I Updated the tox.ini environment description so if someone
does a tox -av it will list all command supportted and a
small description of what

While dcoumenting the zuul.yaml I noticed that I made
patrole-reader a job and I feel that we should also
have it as a gate.

I also saw that extension and multi-node non-voting jobs
where missing reader versions so I added them.

Change-Id: I7b8e4c06ece6b32cab4d7238d0bc250334a3adb3

.zuul.yaml

@@ -30,7 +30,10 @@
         neutron: true
         neutron-trunk: true
       tempest_test_regex: (?!.*\[.*\bslow\b.*\])(^patrole_tempest_plugin\.tests\.api)
+       # run the tempest all tox environment target with patrole regex
       tox_envlist: all
+      # allows job to use the tempest version installed with devstack instead of pypi
+      # according to the requirements.txt
       tox_extra_args: --sitepackages
 
 - job:
@@ -81,7 +84,6 @@
       devstack_localrc:
         RBAC_TEST_ROLES: member
 
-
 - job:
     name: patrole-reader
     parent: patrole-base
@@ -132,6 +134,14 @@
       devstack_localrc:
         RBAC_TEST_ROLES: member
 
+- job:
+    name: patrole-multinode-reader
+    parent: patrole-base-multinode
+    voting: false
+    vars:
+      devstack_localrc:
+        RBAC_TEST_ROLES: reader
+
 - job:
     name: patrole-py35-member
     parent: patrole-base
@@ -194,6 +204,14 @@
       devstack_localrc:
         RBAC_TEST_ROLES: member
 
+- job:
+    name: patrole-extension-reader
+    parent: patrole-extension-base
+    voting: false
+    vars:
+      devstack_localrc:
+        RBAC_TEST_ROLES: reader
+
 - project:
     templates:
       - openstack-cover-jobs
@@ -212,12 +230,15 @@
         - patrole-member-stein
         - patrole-multinode-admin
         - patrole-multinode-member
+        - patrole-multinode-reader
         - patrole-extension-admin
         - patrole-extension-member
+        - patrole-extension-reader
     gate:
       jobs:
         - patrole-admin
         - patrole-member
+        - patrole-reader
     periodic-stable:
       jobs:
         - patrole-member-ussuri

tox.ini

@@ -22,6 +22,7 @@ deps =
 commands =
     find . -type f -name "*.pyc" -delete
     stestr --test-path ./patrole_tempest_plugin/tests/unit run {posargs}
+description=Runs the {envname} environment
 
 [testenv:pep8]
 deps =
@@ -30,12 +31,15 @@ commands =
     flake8 {posargs}
     bandit -r patrole_tempest_plugin -x patrole_tempest_plugin/tests -n 5
     check-uuid --package patrole_tempest_plugin.tests.api
+description=Runs pep8 via flake 8 linting
 
 [testenv:uuidgen]
 commands = check-uuid --package patrole_tempest_plugin.tests.api --fix
+description=Runs tempest uuidgen to make sure all test case have idempotent_id and generate one if not
 
 [testenv:venv]
 commands = {posargs}
+description=Creates a virtual environment called venv with patrole installed
 
 [testenv:cover]
 commands = rm -rf *.pyc
@@ -51,6 +55,7 @@ setenv = VIRTUAL_ENV={envdir}
          NOSE_WHERE=patrole_tempest_plugin/tests/unit
 whitelist_externals = nosetests
                       rm
+description=Runs unit test code coverage report
 
 [testenv:docs]
 deps =
@@ -61,6 +66,7 @@ commands =
   rm -rf doc/build doc/source/framework/code
   sphinx-build -W -b html doc/source doc/build/html
 whitelist_externals = rm
+description=Generate patrole docs
 
 [testenv:pdf-docs]
 deps = {[testenv:docs]deps}
@@ -69,6 +75,7 @@ whitelist_externals =
 commands =
    sphinx-build -W -b latex doc/source doc/build/pdf
    make -C doc/build/pdf
+description=Generates patrole docs in PDF format
 
 [testenv:releasenotes]
 deps = {[testenv:docs]deps}
@@ -76,12 +83,15 @@ commands =
   rm -rf releasenotes/build
   sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 whitelist_externals = rm
+description=Generate release notes
 
 [testenv:debug]
 commands = oslo_debug_helper -t patrole_tempest_plugin/tests {posargs}
+description=Support running tests with pdb statements.
 
 [testenv:genconfig]
 commands = oslo-config-generator --config-file etc/config-generator.patrole.conf
+description=Generate a sample configuration file
 
 [flake8]
 # [H106] Don't put vim configuration in source files.