Browse code

Fix configuration doc block formatting

Many of the code blocks in the configuration documentation had extra
leading spaces. This resulted in the blocks being both code block
formatted as well as blockquoted in the output.

This patch removes leading spaces and some minor cleanup to get the
formatted output correct.

Change-Id: Ic4dfb49c547d51e16b673bc88d7b2b1a907e3258
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

Sean McGinnis authored on 2019/06/20 01:49:40
Showing 1 changed files
... ...
@@ -224,25 +224,22 @@ check out. These may be overridden in ``local.conf`` to pull source
224 224
 from a different repo for testing, such as a Gerrit branch
225 225
 proposal. ``GIT_BASE`` points to the primary repository server.
226 226
 
227
-    ::
227
+::
228 228
 
229
-        NOVA_REPO=$GIT_BASE/openstack/nova.git
230
-        NOVA_BRANCH=master
229
+    NOVA_REPO=$GIT_BASE/openstack/nova.git
230
+    NOVA_BRANCH=master
231 231
 
232 232
 To pull a branch directly from Gerrit, get the repo and branch from
233
-the Gerrit review page:
234
-
235
-    ::
236
-
237
-        git fetch https://review.openstack.org/p/openstack/nova refs/changes/50/5050/1 && git checkout FETCH_HEAD
233
+the Gerrit review page::
238 234
 
239
-    The repo is the stanza following ``fetch`` and the branch is the
240
-    stanza following that:
235
+    git fetch https://review.openstack.org/p/openstack/nova \
236
+        refs/changes/50/5050/1 && git checkout FETCH_HEAD
241 237
 
242
-    ::
238
+The repo is the stanza following ``fetch`` and the branch is the
239
+stanza following that::
243 240
 
244
-        NOVA_REPO=https://review.openstack.org/p/openstack/nova
245
-        NOVA_BRANCH=refs/changes/50/5050/1
241
+    NOVA_REPO=https://review.openstack.org/p/openstack/nova
242
+    NOVA_BRANCH=refs/changes/50/5050/1
246 243
 
247 244
 
248 245
 Installation Directory
... ...
@@ -255,9 +252,9 @@ By setting it early in the ``localrc`` section you can reference it in
255 255
 later variables.  It can be useful to set it even though it is not
256 256
 changed from the default value.
257 257
 
258
-    ::
258
+::
259 259
 
260
-        DEST=/opt/stack
260
+    DEST=/opt/stack
261 261
 
262 262
 Logging
263 263
 -------
... ...
@@ -271,21 +268,21 @@ runs. It can be sent to a file in addition to the console by setting
271 271
 timestamp will be appended to the given filename for each run of
272 272
 ``stack.sh``.
273 273
 
274
-    ::
274
+::
275 275
 
276
-        LOGFILE=$DEST/logs/stack.sh.log
276
+    LOGFILE=$DEST/logs/stack.sh.log
277 277
 
278 278
 Old log files are cleaned automatically if ``LOGDAYS`` is set to the
279 279
 number of days of old log files to keep.
280 280
 
281
-    ::
281
+::
282 282
 
283
-        LOGDAYS=1
283
+    LOGDAYS=1
284 284
 
285 285
 Some coloring is used during the DevStack runs to make it easier to
286 286
 see what is going on. This can be disabled with::
287 287
 
288
-        LOG_COLOR=False
288
+    LOG_COLOR=False
289 289
 
290 290
 When using the logfile, by default logs are sent to the console and
291 291
 the file.  You can set ``VERBOSE`` to ``false`` if you only wish the
... ...
@@ -317,12 +314,12 @@ Example Logging Configuration
317 317
 For example, non-interactive installs probably wish to save output to
318 318
 a file, keep service logs and disable color in the stored files.
319 319
 
320
-   ::
320
+::
321 321
 
322
-       [[local|localrc]]
323
-       DEST=/opt/stack/
324
-       LOGFILE=$LOGDIR/stack.sh.log
325
-       LOG_COLOR=False
322
+   [[local|localrc]]
323
+   DEST=/opt/stack/
324
+   LOGFILE=$LOGDIR/stack.sh.log
325
+   LOG_COLOR=False
326 326
 
327 327
 Database Backend
328 328
 ----------------
... ...
@@ -330,12 +327,10 @@ Database Backend
330 330
 Multiple database backends are available. The available databases are defined
331 331
 in the lib/databases directory.
332 332
 ``mysql`` is the default database, choose a different one by putting the
333
-following in the ``localrc`` section:
334
-
335
-   ::
333
+following in the ``localrc`` section::
336 334
 
337
-      disable_service mysql
338
-      enable_service postgresql
335
+  disable_service mysql
336
+  enable_service postgresql
339 337
 
340 338
 ``mysql`` is the default database.
341 339
 
... ...
@@ -347,11 +342,9 @@ backends may be available via external plugins.  Enabling or disabling
347 347
 RabbitMQ is handled via the usual service functions and
348 348
 ``ENABLED_SERVICES``.
349 349
 
350
-Example disabling RabbitMQ in ``local.conf``:
350
+Example disabling RabbitMQ in ``local.conf``::
351 351
 
352
-::
353
-
354
-    disable_service rabbit
352
+  disable_service rabbit
355 353
 
356 354
 
357 355
 Apache Frontend
... ...
@@ -370,34 +363,23 @@ override toggle available that can be set in your ``local.conf``.
370 370
 
371 371
 Keystone is run under Apache with ``mod_wsgi`` by default.
372 372
 
373
-Example (Keystone)
374
-
375
-::
373
+Example (Keystone)::
376 374
 
377 375
     KEYSTONE_USE_MOD_WSGI="True"
378 376
 
379
-Example (Nova):
380
-
381
-::
377
+Example (Nova)::
382 378
 
383 379
     NOVA_USE_MOD_WSGI="True"
384 380
 
385
-Example (Swift):
386
-
387
-::
381
+Example (Swift)::
388 382
 
389 383
     SWIFT_USE_MOD_WSGI="True"
390 384
 
391
-Example (Heat):
392
-
393
-::
385
+Example (Heat)::
394 386
 
395 387
     HEAT_USE_MOD_WSGI="True"
396 388
 
397
-
398
-Example (Cinder):
399
-
400
-::
389
+Example (Cinder)::
401 390
 
402 391
     CINDER_USE_MOD_WSGI="True"
403 392
 
... ...
@@ -413,9 +395,9 @@ system you can have devstack install it from upstream, or from local
413 413
 git trees by specifying it in ``LIBS_FROM_GIT``.  Multiple libraries
414 414
 can be specified as a comma separated list.
415 415
 
416
-   ::
416
+::
417 417
 
418
-      LIBS_FROM_GIT=python-keystoneclient,oslo.config
418
+  LIBS_FROM_GIT=python-keystoneclient,oslo.config
419 419
 
420 420
 Setting the variable to ``ALL`` will activate the download for all
421 421
 libraries.
... ...
@@ -431,9 +413,9 @@ Each entry in the ``PROJECT_VENV`` array contains the directory name
431 431
 of a venv to be used for the project.  The array index is the project
432 432
 name.  Multiple projects can use the same venv if desired.
433 433
 
434
-  ::
434
+::
435 435
 
436
-    PROJECT_VENV["glance"]=${GLANCE_DIR}.venv
436
+  PROJECT_VENV["glance"]=${GLANCE_DIR}.venv
437 437
 
438 438
 ``ADDITIONAL_VENV_PACKAGES`` is a comma-separated list of additional
439 439
 packages to be installed into each venv.  Often projects will not have
... ...
@@ -442,9 +424,9 @@ are 'optional' requirements, i.e. only needed for certain
442 442
 configurations.  By default, the enabled databases will have their
443 443
 Python bindings added when they are enabled.
444 444
 
445
-  ::
445
+::
446 446
 
447
-     ADDITIONAL_VENV_PACKAGES="python-foo, python-bar"
447
+  ADDITIONAL_VENV_PACKAGES="python-foo, python-bar"
448 448
 
449 449
 Use python3
450 450
 ------------
... ...
@@ -453,9 +435,9 @@ By default ``stack.sh`` uses python2 (the exact version set by the
453 453
 ``PYTHON2_VERSION``). This can be overriden so devstack will run
454 454
 python3 (the exact version set by ``PYTHON3_VERSION``).
455 455
 
456
-  ::
456
+::
457 457
 
458
-     USE_PYTHON3=True
458
+  USE_PYTHON3=True
459 459
 
460 460
 A clean install every time
461 461
 --------------------------
... ...
@@ -465,9 +447,9 @@ exist in ``$DEST``. ``stack.sh`` will freshen each repo on each run if
465 465
 ``RECLONE`` is set to ``yes``. This avoids having to manually remove
466 466
 repos in order to get the current branch from ``$GIT_BASE``.
467 467
 
468
-    ::
468
+::
469 469
 
470
-        RECLONE=yes
470
+  RECLONE=yes
471 471
 
472 472
 Upgrade packages installed by pip
473 473
 ---------------------------------
... ...
@@ -478,9 +460,9 @@ requirement. If ``PIP_UPGRADE`` is set to ``True`` then existing
478 478
 required Python packages will be upgraded to the most recent version
479 479
 that matches requirements.
480 480
 
481
-    ::
481
+::
482 482
 
483
-        PIP_UPGRADE=True
483
+  PIP_UPGRADE=True
484 484
 
485 485
 Guest Images
486 486
 ------------
... ...
@@ -494,11 +476,11 @@ their testing-requirements in ``stack.sh``.  Setting
494 494
 these default images; in that case, you will want to populate
495 495
 ``IMAGE_URLS`` with sufficient images to satisfy testing-requirements.
496 496
 
497
-    ::
497
+::
498 498
 
499
-        DOWNLOAD_DEFAULT_IMAGES=False
500
-        IMAGE_URLS="http://foo.bar.com/image.qcow,"
501
-        IMAGE_URLS+="http://foo.bar.com/image2.qcow"
499
+  DOWNLOAD_DEFAULT_IMAGES=False
500
+  IMAGE_URLS="http://foo.bar.com/image.qcow,"
501
+  IMAGE_URLS+="http://foo.bar.com/image2.qcow"
502 502
 
503 503
 
504 504
 Instance Type
... ...
@@ -517,9 +499,9 @@ KVM on Power with QEMU 2.4 requires 512 MB to load the firmware -
517 517
 running instances on ppc64/ppc64le can choose one of the default
518 518
 created flavors as follows:
519 519
 
520
-    ::
520
+::
521 521
 
522
-        DEFAULT_INSTANCE_TYPE=m1.tiny
522
+  DEFAULT_INSTANCE_TYPE=m1.tiny
523 523
 
524 524
 
525 525
 IP Version
... ...
@@ -530,19 +512,19 @@ IPv4, IPv6, or dual-stack self-service project data-network by with
530 530
 either ``IP_VERSION=4``, ``IP_VERSION=6``, or ``IP_VERSION=4+6``
531 531
 respectively.
532 532
 
533
-    ::
533
+::
534 534
 
535
-        IP_VERSION=4+6
535
+  IP_VERSION=4+6
536 536
 
537 537
 The following optional variables can be used to alter the default IPv6
538 538
 behavior:
539 539
 
540
-    ::
540
+::
541 541
 
542
-        IPV6_RA_MODE=slaac
543
-        IPV6_ADDRESS_MODE=slaac
544
-        IPV6_ADDRS_SAFE_TO_USE=fd$IPV6_GLOBAL_ID::/56
545
-        IPV6_PRIVATE_NETWORK_GATEWAY=fd$IPV6_GLOBAL_ID::1
542
+  IPV6_RA_MODE=slaac
543
+  IPV6_ADDRESS_MODE=slaac
544
+  IPV6_ADDRS_SAFE_TO_USE=fd$IPV6_GLOBAL_ID::/56
545
+  IPV6_PRIVATE_NETWORK_GATEWAY=fd$IPV6_GLOBAL_ID::1
546 546
 
547 547
 *Note*: ``IPV6_ADDRS_SAFE_TO_USE`` and ``IPV6_PRIVATE_NETWORK_GATEWAY``
548 548
 can be configured with any valid IPv6 prefix. The default values make
... ...
@@ -565,11 +547,9 @@ address.
565 565
 
566 566
 The default value for this setting is ``4``.  Dual-mode support, for
567 567
 example ``4+6`` is not currently supported.  ``HOST_IPV6`` can
568
-optionally be used to alter the default IPv6 address
569
-
570
-    ::
568
+optionally be used to alter the default IPv6 address::
571 569
 
572
-        HOST_IPV6=${some_local_ipv6_address}
570
+  HOST_IPV6=${some_local_ipv6_address}
573 571
 
574 572
 Multi-node setup
575 573
 ~~~~~~~~~~~~~~~~
... ...
@@ -671,11 +651,11 @@ set by ``VOLUME_GROUP_NAME``, the logical volume name prefix is set with
671 671
 ``VOLUME_NAME_PREFIX`` and the size of the volume backing file is set
672 672
 with ``VOLUME_BACKING_FILE_SIZE``.
673 673
 
674
-    ::
674
+::
675 675
 
676
-        VOLUME_GROUP_NAME="stack-volumes"
677
-        VOLUME_NAME_PREFIX="volume-"
678
-        VOLUME_BACKING_FILE_SIZE=24G
676
+  VOLUME_GROUP_NAME="stack-volumes"
677
+  VOLUME_NAME_PREFIX="volume-"
678
+  VOLUME_BACKING_FILE_SIZE=24G
679 679
 
680 680
 
681 681
 Keystone