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
... | ... |
@@ -163,6 +163,25 @@ |
163 | 163 |
Base devstack job for integration gate. |
164 | 164 |
|
165 | 165 |
This base job can be used for single node and multinode devstack jobs. |
166 |
+ |
|
167 |
+ With a single node nodeset, this job sets up an "all-in-one" (aio) |
|
168 |
+ devstack with the six OpenStack services included in the devstack tree: |
|
169 |
+ keystone, glance, cinder, neutron, nova and swift. |
|
170 |
+ |
|
171 |
+ With a two node nodeset, this job sets up an aio + compute node. |
|
172 |
+ The controller can be customised using host-vars.controller, the |
|
173 |
+ sub-nodes can be customised using group-vars.subnode. |
|
174 |
+ |
|
175 |
+ Descendent jobs can enable / disable services, add devstack configuration |
|
176 |
+ options, enable devstack plugins, configure log files or directories to be |
|
177 |
+ transferred to the log server. |
|
178 |
+ |
|
179 |
+ The job assumes that there is only one controller node. The number of |
|
180 |
+ subnodes can be scaled up seamlessly by setting a custom nodeset in |
|
181 |
+ job.nodeset. |
|
182 |
+ |
|
183 |
+ The run playbook consists of a single role, so it can be easily rewritten |
|
184 |
+ and extended. |
|
166 | 185 |
nodeset: openstack-single-node |
167 | 186 |
required-projects: |
168 | 187 |
- openstack/cinder |
... | ... |
@@ -139,7 +139,8 @@ up to date to the latest devstack). |
139 | 139 |
Enable :doc:`devstack plugins <plugins>` to support additional |
140 | 140 |
services, features, and configuration not present in base devstack. |
141 | 141 |
|
142 |
-Use devstack in your CI with :doc:`Ansible roles <roles>` for Zuul V3. |
|
142 |
+Use devstack in your CI with :doc:`Ansible roles <zuul_roles>` and |
|
143 |
+:doc:`Jobs <zuul_jobs>` for Zuul V3. |
|
143 | 144 |
|
144 | 145 |
Get :doc:`the big picture <overview>` of what we are trying to do |
145 | 146 |
with devstack, and help us by :doc:`contributing to the project |