From e8f4e9a59d7819bfa8ddadd7db7c7998c7e5eecd Mon Sep 17 00:00:00 2001 From: Ben Nemec Date: Mon, 30 Jan 2017 23:26:39 +0000 Subject: [PATCH] Clean up admonition problems There have been a couple of admonitions added recently that were not completely wired into the admonition system, which makes them essentially glorified note sections instead of dynamic admonitions. This patch finishes the configuration of the admonitions. It also does some re-organizing of the existing admonitions. The SSL admonitions are dropped in favor of a generic "Optional" admonition that can be used for these one-off optional features. Change-Id: I9fd5c3a7f50e4916e45ad16a6e9aaaffd83affe8 --- _custom/custom.css | 5 ++-- _templates/layout.html | 9 +++++-- doc/source/index.rst | 17 +++++------- .../install/advanced_deployment/ssl.rst | 3 ++- .../basic_deployment/basic_deployment_cli.rst | 26 +++++++++++-------- .../install/installation/installing.rst | 3 ++- 6 files changed, 36 insertions(+), 27 deletions(-) diff --git a/_custom/custom.css b/_custom/custom.css index 7bab9e3c..00b0701d 100644 --- a/_custom/custom.css +++ b/_custom/custom.css @@ -69,11 +69,12 @@ .virtual {background: #efe;} .ceph {background: #eff;} .source {background: #bbb;} -.ssl {background: #ffe;} -.selfsigned {background: #ffd;} .ltom {background: #dee;} .mton {background: #ded;} .ntoo {background: #edd;} +.validations {background: #fdd;} +.optional {background: #ffe;} + /* admonition selector */ #admonition_selector { color: white; diff --git a/_templates/layout.html b/_templates/layout.html index 64c366ca..4bcff040 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -24,6 +24,7 @@ RHEL Registration Types @@ -36,8 +37,12 @@ + + Features + Additional Overcloud Roles diff --git a/doc/source/index.rst b/doc/source/index.rst index 8a63836e..25cc4223 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -89,19 +89,16 @@ Linux (RHEL). These steps are marked as follows: Step that should only be run when installing from the Ocata stable branch. -.. admonition:: SSL - :class: ssl - - Step that should only be run when deploying with SSL OpenStack endpoints - -.. admonition:: Self-Signed SSL - :class: selfsigned - - Step that should only be run when deploying with SSL and a self-signed certificate. - .. admonition:: Validations + :class: validations Steps that will run the pre and post-deployment validations +.. admonition:: Optional Feature + :class: optional + + Step that is optional. A deployment can be done without these steps, but they + may provide useful additional functionality. + Any such steps should *not* be run if the target environment does not match the section marking. diff --git a/doc/source/install/advanced_deployment/ssl.rst b/doc/source/install/advanced_deployment/ssl.rst index 15c32d0f..2c1b1cec 100644 --- a/doc/source/install/advanced_deployment/ssl.rst +++ b/doc/source/install/advanced_deployment/ssl.rst @@ -132,8 +132,9 @@ network. Certificate Details ~~~~~~~~~~~~~~~~~~~ +.. This admonition is intentionally left class-less because it is only used + on the SSL page. .. admonition:: Self-Signed SSL - :class: selfsigned It is not recommended that the self-signed certificate is trusted; So for this purpose, having a self-signed CA certificate is a better choice. In diff --git a/doc/source/install/basic_deployment/basic_deployment_cli.rst b/doc/source/install/basic_deployment/basic_deployment_cli.rst index 574f99da..5f5c09a5 100644 --- a/doc/source/install/basic_deployment/basic_deployment_cli.rst +++ b/doc/source/install/basic_deployment/basic_deployment_cli.rst @@ -301,6 +301,7 @@ Introspect Nodes .. admonition:: Validations + :class: validations Once the undercloud is installed, you can run the ``pre-introspection`` validations:: @@ -388,6 +389,7 @@ Deploy the Overcloud -------------------- .. admonition:: Validations + :class: validations Before you start the deployment, you may want to run the ``pre-deployment`` validations:: @@ -403,13 +405,14 @@ configured for the virtual environment. To customize this, see the output of:: openstack help overcloud deploy .. admonition:: Swap + :class: optional - Swap files or partitions can be installed as part of an Overcloud deployment. - For adding swap files there is no restriction besides having - 4GB available on / (by default). When using a swap partition, - the partition must exist and be tagged as `swap1` (by default). - To deploy a swap file or partition in each Overcloud node use one - of the following arguments when deploying:: + Swap files or partitions can be installed as part of an Overcloud deployment. + For adding swap files there is no restriction besides having + 4GB available on / (by default). When using a swap partition, + the partition must exist and be tagged as `swap1` (by default). + To deploy a swap file or partition in each Overcloud node use one + of the following arguments when deploying:: -e /usr/share/openstack-tripleo-heat-templates/environments/enable-swap-partition.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/enable-swap.yaml @@ -460,7 +463,7 @@ configured for the virtual environment. To customize this, see the output of:: rhel-7-server-openstack-6.0-rpms .. admonition:: SSL - :class: ssl + :class: optional To deploy an overcloud with SSL, see :doc:`../advanced_deployment/ssl`. @@ -499,13 +502,14 @@ Post-Deployment --------------- .. admonition:: Validations + :class: validations - After the deployment finished, you can run the ``post-deployment`` - validations:: + After the deployment finished, you can run the ``post-deployment`` + validations:: - openstack workflow execution create tripleo.validations.v1.run_groups '{"group_names": ["post-deployment"]}' + openstack workflow execution create tripleo.validations.v1.run_groups '{"group_names": ["post-deployment"]}' - Then verify the results as described in :ref:`running_validation_group`. + Then verify the results as described in :ref:`running_validation_group`. Access the Overcloud diff --git a/doc/source/install/installation/installing.rst b/doc/source/install/installation/installing.rst index 129fde67..7aab0b29 100644 --- a/doc/source/install/installation/installing.rst +++ b/doc/source/install/installation/installing.rst @@ -96,11 +96,12 @@ Installing the Undercloud :doc:`../developer/in_progress_review` for details. .. admonition:: SSL - :class: ssl + :class: optional To deploy an undercloud with SSL, see :doc:`../advanced_deployment/ssl`. .. admonition:: Validations + :class: validations :doc:`../validations/validations` will be installed and configured during undercloud installation. You can set