Browse code

Merge "Document jobs"

Zuul authored on 2018/03/11 19:57:03
Showing 5 changed files
... ...
@@ -195,6 +195,25 @@
195 195
       Base devstack job for integration gate.
196 196
 
197 197
       This base job can be used for single node and multinode devstack jobs.
198
+
199
+      With a single node nodeset, this job sets up an "all-in-one" (aio)
200
+      devstack with the six OpenStack services included in the devstack tree:
201
+      keystone, glance, cinder, neutron, nova and swift.
202
+
203
+      With a two node nodeset, this job sets up an aio + compute node.
204
+      The controller can be customised using host-vars.controller, the
205
+      sub-nodes can be customised using group-vars.subnode.
206
+
207
+      Descendent jobs can enable / disable services, add devstack configuration
208
+      options, enable devstack plugins, configure log files or directories to be
209
+      transferred to the log server.
210
+
211
+      The job assumes that there is only one controller node. The number of
212
+      subnodes can be scaled up seamlessly by setting a custom nodeset in
213
+      job.nodeset.
214
+
215
+      The run playbook consists of a single role, so it can be easily rewritten
216
+      and extended.
198 217
     nodeset: openstack-single-node
199 218
     required-projects:
200 219
       - 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
146 147
deleted file mode 100644
... ...
@@ -1,4 +0,0 @@
1
-Roles
2
-=====
3
-
4
-.. zuul:autoroles::
5 1
new file mode 100644
... ...
@@ -0,0 +1,4 @@
0
+Zuul CI Jobs
1
+============
2
+
3
+.. zuul:autojobs::
0 4
new file mode 100644
... ...
@@ -0,0 +1,4 @@
0
+Zuul CI Roles
1
+=============
2
+
3
+.. zuul:autoroles::