Browse code
Use list tables
Reformat overlong table into a list-table to make it easier to edit.
The change contains no wording changes besides giving titles to the
list-tables.
Fix formatting for setup-devstack-source-dirs so that the variable does
not get displayed with a grey bar at
https://docs.openstack.org/devstack/latest/zuul_roles.html#role-setup-devstack-source-dirs
Change-Id: I7378d46c507b1d86f1d5319655a55f2a8c5a8f60
Andreas Jaeger authored on 2019/08/14 02:27:06Showing 2 changed files
| ... | ... |
@@ -180,123 +180,147 @@ the same or a similar behaviour in Zuul v3 jobs. For localrc settings, |
| 180 | 180 |
devstack-gate defined a default value. In ansible jobs the default is either the |
| 181 | 181 |
value defined in the parent job, or the default from DevStack, if any. |
| 182 | 182 |
|
| 183 |
-============================================== ============= ================== |
|
| 184 |
-DevStack gate flag Repo New implementation |
|
| 185 |
-============================================== ============= ================== |
|
| 186 |
-OVERRIDE_ZUUL_BRANCH zuul override-checkout: |
|
| 187 |
- [branch] |
|
| 188 |
- in the job definition. |
|
| 189 |
-DEVSTACK_GATE_NET_OVERLAY zuul-jobs A bridge called |
|
| 190 |
- br-infra is set up for |
|
| 191 |
- all jobs that inherit |
|
| 192 |
- from multinode with |
|
| 193 |
- a dedicated `bridge role <https://zuul-ci.org/docs/zuul-jobs/general-roles.html#role-multi-node-bridge>`_. |
|
| 194 |
-DEVSTACK_GATE_FEATURE_MATRIX devstack-gate ``test_matrix_features`` |
|
| 195 |
- variable of the |
|
| 196 |
- test-matrix role in |
|
| 197 |
- devstack-gate. This |
|
| 198 |
- is a temporary |
|
| 199 |
- solution, feature |
|
| 200 |
- matrix will go away. |
|
| 201 |
- In the future services |
|
| 202 |
- will be defined in |
|
| 203 |
- jobs only. |
|
| 204 |
-DEVSTACK_CINDER_VOLUME_CLEAR devstack *CINDER_VOLUME_CLEAR: true/false* |
|
| 205 |
- in devstack_localrc |
|
| 206 |
- in the job vars. |
|
| 207 |
-DEVSTACK_GATE_NEUTRON devstack True by default. To |
|
| 208 |
- disable, disable all |
|
| 209 |
- neutron services in |
|
| 210 |
- devstack_services in |
|
| 211 |
- the job definition. |
|
| 212 |
-DEVSTACK_GATE_CONFIGDRIVE devstack *FORCE_CONFIG_DRIVE: true/false* |
|
| 213 |
- in devstack_localrc |
|
| 214 |
- in the job vars. |
|
| 215 |
-DEVSTACK_GATE_INSTALL_TESTONLY devstack *INSTALL_TESTONLY_PACKAGES: true/false* |
|
| 216 |
- in devstack_localrc |
|
| 217 |
- in the job vars. |
|
| 218 |
-DEVSTACK_GATE_VIRT_DRIVER devstack *VIRT_DRIVER: [virt driver]* |
|
| 219 |
- in devstack_localrc |
|
| 220 |
- in the job vars. |
|
| 221 |
-DEVSTACK_GATE_LIBVIRT_TYPE devstack *LIBVIRT_TYPE: [libvirt type]* |
|
| 222 |
- in devstack_localrc |
|
| 223 |
- in the job vars. |
|
| 224 |
-DEVSTACK_GATE_TEMPEST devstack Defined by the job |
|
| 225 |
- tempest that is used. The |
|
| 226 |
- ``devstack`` job only |
|
| 227 |
- runs devstack. |
|
| 228 |
- The ``devstack-tempest`` |
|
| 229 |
- one triggers a Tempest |
|
| 230 |
- run as well. |
|
| 231 |
-DEVSTACK_GATE_TEMPEST_FULL tempest *tox_envlist: full* |
|
| 232 |
- in the job vars. |
|
| 233 |
-DEVSTACK_GATE_TEMPEST_ALL tempest *tox_envlist: all* |
|
| 234 |
- in the job vars. |
|
| 235 |
-DEVSTACK_GATE_TEMPEST_ALL_PLUGINS tempest *tox_envlist: all-plugin* |
|
| 236 |
- in the job vars. |
|
| 237 |
-DEVSTACK_GATE_TEMPEST_SCENARIOS tempest *tox_envlist: scenario* |
|
| 238 |
- in the job vars. |
|
| 239 |
-TEMPEST_CONCURRENCY tempest *tempest_concurrency: [value]* |
|
| 240 |
- in the job vars. This |
|
| 241 |
- is available only on |
|
| 242 |
- jobs that inherit from |
|
| 243 |
- ``devstack-tempest`` |
|
| 244 |
- down. |
|
| 245 |
-DEVSTACK_GATE_TEMPEST_NOTESTS tempest *tox_envlist: venv-tempest* |
|
| 246 |
- in the job vars. This |
|
| 247 |
- will create Tempest |
|
| 248 |
- virtual environment |
|
| 249 |
- but run no tests. |
|
| 250 |
-DEVSTACK_GATE_SMOKE_SERIAL tempest *tox_envlist: smoke-serial* |
|
| 251 |
- in the job vars. |
|
| 252 |
-DEVSTACK_GATE_TEMPEST_DISABLE_TENANT_ISOLATION tempest *tox_envlist: full-serial* |
|
| 253 |
- in the job vars. |
|
| 254 |
- *TEMPEST_ALLOW_TENANT_ISOLATION: false* |
|
| 255 |
- in devstack_localrc in |
|
| 256 |
- the job vars. |
|
| 257 |
-============================================== ============= ================== |
|
| 183 |
+.. list-table:: **DevStack Gate Flags** |
|
| 184 |
+ :widths: 20 10 60 |
|
| 185 |
+ :header-rows: 1 |
|
| 186 |
+ |
|
| 187 |
+ * - DevStack gate flag |
|
| 188 |
+ - Repo |
|
| 189 |
+ - New implementation |
|
| 190 |
+ * - OVERRIDE_ZUUL_BRANCH |
|
| 191 |
+ - zuul |
|
| 192 |
+ - override-checkout: [branch] in the job definition. |
|
| 193 |
+ * - DEVSTACK_GATE_NET_OVERLAY |
|
| 194 |
+ - zuul-jobs |
|
| 195 |
+ - A bridge called br-infra is set up for all jobs that inherit |
|
| 196 |
+ from multinode with a dedicated `bridge role |
|
| 197 |
+ <https://zuul-ci.org/docs/zuul-jobs/general-roles.html#role-multi-node-bridge>`_. |
|
| 198 |
+ * - DEVSTACK_GATE_FEATURE_MATRIX |
|
| 199 |
+ - devstack-gate |
|
| 200 |
+ - ``test_matrix_features`` variable of the test-matrix role in |
|
| 201 |
+ devstack-gate. This is a temporary solution, feature matrix |
|
| 202 |
+ will go away. In the future services will be defined in jobs |
|
| 203 |
+ only. |
|
| 204 |
+ * - DEVSTACK_CINDER_VOLUME_CLEAR |
|
| 205 |
+ - devstack |
|
| 206 |
+ - *CINDER_VOLUME_CLEAR: true/false* in devstack_localrc in the |
|
| 207 |
+ job vars. |
|
| 208 |
+ * - DEVSTACK_GATE_NEUTRON |
|
| 209 |
+ - devstack |
|
| 210 |
+ - True by default. To disable, disable all neutron services in |
|
| 211 |
+ devstack_services in the job definition. |
|
| 212 |
+ * - DEVSTACK_GATE_CONFIGDRIVE |
|
| 213 |
+ - devstack |
|
| 214 |
+ - *FORCE_CONFIG_DRIVE: true/false* in devstack_localrc in the job |
|
| 215 |
+ vars. |
|
| 216 |
+ * - DEVSTACK_GATE_INSTALL_TESTONLY |
|
| 217 |
+ - devstack |
|
| 218 |
+ - *INSTALL_TESTONLY_PACKAGES: true/false* in devstack_localrc in |
|
| 219 |
+ the job vars. |
|
| 220 |
+ * - DEVSTACK_GATE_VIRT_DRIVER |
|
| 221 |
+ - devstack |
|
| 222 |
+ - *VIRT_DRIVER: [virt driver]* in devstack_localrc in the job |
|
| 223 |
+ vars. |
|
| 224 |
+ * - DEVSTACK_GATE_LIBVIRT_TYPE |
|
| 225 |
+ - devstack |
|
| 226 |
+ - *LIBVIRT_TYPE: [libvirt type]* in devstack_localrc in the job |
|
| 227 |
+ vars. |
|
| 228 |
+ * - DEVSTACK_GATE_TEMPEST |
|
| 229 |
+ - devstack and tempest |
|
| 230 |
+ - Defined by the job that is used. The ``devstack`` job only runs |
|
| 231 |
+ devstack. The ``devstack-tempest`` one triggers a Tempest run |
|
| 232 |
+ as well. |
|
| 233 |
+ * - DEVSTACK_GATE_TEMPEST_FULL |
|
| 234 |
+ - tempest |
|
| 235 |
+ - *tox_envlist: full* in the job vars. |
|
| 236 |
+ * - DEVSTACK_GATE_TEMPEST_ALL |
|
| 237 |
+ - tempest |
|
| 238 |
+ - *tox_envlist: all* in the job vars. |
|
| 239 |
+ * - DEVSTACK_GATE_TEMPEST_ALL_PLUGINS |
|
| 240 |
+ - tempest |
|
| 241 |
+ - *tox_envlist: all-plugin* in the job vars. |
|
| 242 |
+ * - DEVSTACK_GATE_TEMPEST_SCENARIOS |
|
| 243 |
+ - tempest |
|
| 244 |
+ - *tox_envlist: scenario* in the job vars. |
|
| 245 |
+ * - TEMPEST_CONCURRENCY |
|
| 246 |
+ - tempest |
|
| 247 |
+ - *tempest_concurrency: [value]* in the job vars. This is |
|
| 248 |
+ available only on jobs that inherit from ``devstack-tempest`` |
|
| 249 |
+ down. |
|
| 250 |
+ * - DEVSTACK_GATE_TEMPEST_NOTESTS |
|
| 251 |
+ - tempest |
|
| 252 |
+ - *tox_envlist: venv-tempest* in the job vars. This will create |
|
| 253 |
+ Tempest virtual environment but run no tests. |
|
| 254 |
+ * - DEVSTACK_GATE_SMOKE_SERIAL |
|
| 255 |
+ - tempest |
|
| 256 |
+ - *tox_envlist: smoke-serial* in the job vars. |
|
| 257 |
+ * - DEVSTACK_GATE_TEMPEST_DISABLE_TENANT_ISOLATION |
|
| 258 |
+ - tempest |
|
| 259 |
+ - *tox_envlist: full-serial* in the job vars. |
|
| 260 |
+ *TEMPEST_ALLOW_TENANT_ISOLATION: false* in devstack_localrc in |
|
| 261 |
+ the job vars. |
|
| 262 |
+ |
|
| 258 | 263 |
|
| 259 | 264 |
The following flags have not been migrated yet or are legacy and won't be |
| 260 | 265 |
migrated at all. |
| 261 | 266 |
|
| 262 |
-===================================== ====== ========================== |
|
| 263 |
-DevStack gate flag Status Details |
|
| 264 |
-===================================== ====== ========================== |
|
| 265 |
-DEVSTACK_GATE_TOPOLOGY WIP The topology depends on the base |
|
| 266 |
- job that is used and more |
|
| 267 |
- specifically on the nodeset |
|
| 268 |
- attached to it. The new job |
|
| 269 |
- format allows project to define |
|
| 270 |
- the variables to be passed to |
|
| 271 |
- every node/node-group that exists |
|
| 272 |
- in the topology. Named topologies |
|
| 273 |
- that include the nodeset and the |
|
| 274 |
- matching variables can be defined |
|
| 275 |
- in the form of base jobs. |
|
| 276 |
-DEVSTACK_GATE_GRENADE TBD Grenade Zuul V3 jobs will be |
|
| 277 |
- hosted in the grenade repo. |
|
| 278 |
-GRENADE_BASE_BRANCH TBD Grenade Zuul V3 jobs will be |
|
| 279 |
- hosted in the grenade repo. |
|
| 280 |
-DEVSTACK_GATE_NEUTRON_DVR TBD Depends on multinode support. |
|
| 281 |
-DEVSTACK_GATE_EXERCISES TBD Can be done on request. |
|
| 282 |
-DEVSTACK_GATE_IRONIC TBD This will probably be implemented |
|
| 283 |
- on ironic side. |
|
| 284 |
-DEVSTACK_GATE_IRONIC_DRIVER TBD This will probably be implemented |
|
| 285 |
- on ironic side. |
|
| 286 |
-DEVSTACK_GATE_IRONIC_BUILD_RAMDISK TBD This will probably be implemented |
|
| 287 |
- on ironic side. |
|
| 288 |
-DEVSTACK_GATE_POSTGRES Legacy This flag exists in d-g but the |
|
| 289 |
- only thing that it does is |
|
| 290 |
- capture postgres logs. This is |
|
| 291 |
- already supported by the roles in |
|
| 292 |
- post, so the flag is useless in |
|
| 293 |
- the new jobs. postgres itself can |
|
| 294 |
- be enabled via the |
|
| 295 |
- devstack_service job variable. |
|
| 296 |
-DEVSTACK_GATE_ZEROMQ Legacy This has no effect in d-g. |
|
| 297 |
-DEVSTACK_GATE_MQ_DRIVER Legacy This has no effect in d-g. |
|
| 298 |
-DEVSTACK_GATE_TEMPEST_STRESS_ARGS Legacy Stress is not in Tempest anymore. |
|
| 299 |
-DEVSTACK_GATE_TEMPEST_HEAT_SLOW Legacy This is not used anywhere. |
|
| 300 |
-DEVSTACK_GATE_CELLS Legacy This has no effect in d-g. |
|
| 301 |
-DEVSTACK_GATE_NOVA_API_METADATA_SPLIT Legacy This has no effect in d-g. |
|
| 302 |
-===================================== ====== ========================== |
|
| 267 |
+.. list-table:: **Not Migrated DevStack Gate Flags** |
|
| 268 |
+ :widths: 20 10 60 |
|
| 269 |
+ :header-rows: 1 |
|
| 270 |
+ |
|
| 271 |
+ * - DevStack gate flag |
|
| 272 |
+ - Status |
|
| 273 |
+ - Details |
|
| 274 |
+ * - DEVSTACK_GATE_TOPOLOGY |
|
| 275 |
+ - WIP |
|
| 276 |
+ - The topology depends on the base job that is used and more |
|
| 277 |
+ specifically on the nodeset attached to it. The new job format |
|
| 278 |
+ allows project to define the variables to be passed to every |
|
| 279 |
+ node/node-group that exists in the topology. Named topologies |
|
| 280 |
+ that include the nodeset and the matching variables can be |
|
| 281 |
+ defined in the form of base jobs. |
|
| 282 |
+ * - DEVSTACK_GATE_GRENADE |
|
| 283 |
+ - TBD |
|
| 284 |
+ - Grenade Zuul V3 jobs will be hosted in the grenade repo. |
|
| 285 |
+ * - GRENADE_BASE_BRANCH |
|
| 286 |
+ - TBD |
|
| 287 |
+ - Grenade Zuul V3 jobs will be hosted in the grenade repo. |
|
| 288 |
+ * - DEVSTACK_GATE_NEUTRON_DVR |
|
| 289 |
+ - TBD |
|
| 290 |
+ - Depends on multinode support. |
|
| 291 |
+ * - DEVSTACK_GATE_EXERCISES |
|
| 292 |
+ - TBD |
|
| 293 |
+ - Can be done on request. |
|
| 294 |
+ * - DEVSTACK_GATE_IRONIC |
|
| 295 |
+ - TBD |
|
| 296 |
+ - This will probably be implemented on ironic side. |
|
| 297 |
+ * - DEVSTACK_GATE_IRONIC_DRIVER |
|
| 298 |
+ - TBD |
|
| 299 |
+ - This will probably be implemented on ironic side. |
|
| 300 |
+ * - DEVSTACK_GATE_IRONIC_BUILD_RAMDISK |
|
| 301 |
+ - TBD |
|
| 302 |
+ - This will probably be implemented on ironic side. |
|
| 303 |
+ * - DEVSTACK_GATE_POSTGRES |
|
| 304 |
+ - Legacy |
|
| 305 |
+ - This flag exists in d-g but the only thing that it does is |
|
| 306 |
+ capture postgres logs. This is already supported by the roles |
|
| 307 |
+ in post, so the flag is useless in the new jobs. postgres |
|
| 308 |
+ itself can be enabled via the devstack_service job variable. |
|
| 309 |
+ * - DEVSTACK_GATE_ZEROMQ |
|
| 310 |
+ - Legacy |
|
| 311 |
+ - This has no effect in d-g. |
|
| 312 |
+ * - DEVSTACK_GATE_MQ_DRIVER |
|
| 313 |
+ - Legacy |
|
| 314 |
+ - This has no effect in d-g. |
|
| 315 |
+ * - DEVSTACK_GATE_TEMPEST_STRESS_ARGS |
|
| 316 |
+ - Legacy |
|
| 317 |
+ - Stress is not in Tempest anymore. |
|
| 318 |
+ * - DEVSTACK_GATE_TEMPEST_HEAT_SLOW |
|
| 319 |
+ - Legacy |
|
| 320 |
+ - This is not used anywhere. |
|
| 321 |
+ * - DEVSTACK_GATE_CELLS |
|
| 322 |
+ - Legacy |
|
| 323 |
+ - This has no effect in d-g. |
|
| 324 |
+ * - DEVSTACK_GATE_NOVA_API_METADATA_SPLIT |
|
| 325 |
+ - Legacy |
|
| 326 |
+ - This has no effect in d-g. |
| ... | ... |
@@ -10,7 +10,7 @@ into it. |
| 10 | 10 |
|
| 11 | 11 |
The devstack base directory. |
| 12 | 12 |
|
| 13 |
- .. zuul:rolevar:: devstack_sources_branch |
|
| 14 |
- :default: None |
|
| 13 |
+.. zuul:rolevar:: devstack_sources_branch |
|
| 14 |
+ :default: None |
|
| 15 | 15 |
|
| 16 |
- The target branch to be setup (where available). |
|
| 16 |
+ The target branch to be setup (where available). |