From 067e36582b8d1589c831524e921f396b270d4f44 Mon Sep 17 00:00:00 2001 From: Andrea Frittoli Date: Fri, 23 Feb 2018 16:04:46 +0000 Subject: [PATCH] Document jobs Add inline documentation to jobs and render it in the jobs doc page. Adjust the roles page to match jobs for title and filename. Change-Id: I47a2b4b379c8517b0dea59a75943f3f871c29046 --- .zuul.yaml | 19 +++++++++++++++++++ doc/source/index.rst | 3 ++- doc/source/roles.rst | 4 ---- doc/source/zuul_jobs.rst | 4 ++++ doc/source/zuul_roles.rst | 4 ++++ 5 files changed, 29 insertions(+), 5 deletions(-) delete mode 100644 doc/source/roles.rst create mode 100644 doc/source/zuul_jobs.rst create mode 100644 doc/source/zuul_roles.rst diff --git a/.zuul.yaml b/.zuul.yaml index 2ef23c89ff..693cd774b1 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -163,6 +163,25 @@ Base devstack job for integration gate. This base job can be used for single node and multinode devstack jobs. + + With a single node nodeset, this job sets up an "all-in-one" (aio) + devstack with the six OpenStack services included in the devstack tree: + keystone, glance, cinder, neutron, nova and swift. + + With a two node nodeset, this job sets up an aio + compute node. + The controller can be customised using host-vars.controller, the + sub-nodes can be customised using group-vars.subnode. + + Descendent jobs can enable / disable services, add devstack configuration + options, enable devstack plugins, configure log files or directories to be + transferred to the log server. + + The job assumes that there is only one controller node. The number of + subnodes can be scaled up seamlessly by setting a custom nodeset in + job.nodeset. + + The run playbook consists of a single role, so it can be easily rewritten + and extended. nodeset: openstack-single-node required-projects: - openstack/cinder diff --git a/doc/source/index.rst b/doc/source/index.rst index 9254c23cae..4c53203d97 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -139,7 +139,8 @@ up to date to the latest devstack). Enable :doc:`devstack plugins ` to support additional services, features, and configuration not present in base devstack. -Use devstack in your CI with :doc:`Ansible roles ` for Zuul V3. +Use devstack in your CI with :doc:`Ansible roles ` and +:doc:`Jobs ` for Zuul V3. Get :doc:`the big picture ` of what we are trying to do with devstack, and help us by :doc:`contributing to the project diff --git a/doc/source/roles.rst b/doc/source/roles.rst deleted file mode 100644 index 5baa1e4e82..0000000000 --- a/doc/source/roles.rst +++ /dev/null @@ -1,4 +0,0 @@ -Roles -===== - -.. zuul:autoroles:: diff --git a/doc/source/zuul_jobs.rst b/doc/source/zuul_jobs.rst new file mode 100644 index 0000000000..cf203a8973 --- /dev/null +++ b/doc/source/zuul_jobs.rst @@ -0,0 +1,4 @@ +Zuul CI Jobs +============ + +.. zuul:autojobs:: diff --git a/doc/source/zuul_roles.rst b/doc/source/zuul_roles.rst new file mode 100644 index 0000000000..4939281057 --- /dev/null +++ b/doc/source/zuul_roles.rst @@ -0,0 +1,4 @@ +Zuul CI Roles +============= + +.. zuul:autoroles::