openstack
/
tripleo-docs
Code Issues Proposed changes

Clean up admonition problems

Browse Source 
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
changes/69/426969/3
Ben Nemec 6 years ago
parent df8c934f41
commit e8f4e9a59d
6 changed files with 36 additions and 27 deletions
Show Stats Download Patch File Download Diff File

5
_custom/custom.css
Unescape View File

@ -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;

9
_templates/layout.html
Unescape View File

@ -24,6 +24,7 @@
<ul>
<li><input type="checkbox" id="stable" checked=""><label for="stable" title="Step that should only be run when choosing to use components from their stable branches rather than using packages/source based on current master.">Install from stable branch</label></li>
<li><input type="checkbox" id="newton" checked=""><label for="newton" title="Step that should only be run when installing from the Newton stable branch.">Install from Newton branch</label></li>
<li><input type="checkbox" id="ocata" checked=""><label for="ocata" title="Step that should only be run when installing from the Ocata stable branch.">Install from Ocata branch</label></li>
</ul>
<span class="title">RHEL Registration Types</span>
@ -36,8 +37,12 @@
<ul>
<li><input type="checkbox" id="baremetal" checked="checked"><label for="baremetal" title="Step that should only be run when deploying to baremetal.">Baremetal</label></li>
<li><input type="checkbox" id="virtual" checked="checked"><label for="virtual" title="Step that should only be run when deploying to virtual machines.">Virtual</label></li>
<li><input type="checkbox" id="ssl" checked="checked"><label for="ssl" title="Step that should only be run when deploying with SSL OpenStack endpoints.">SSL</label></li>
<li><input type="checkbox" id="selfsigned" checked="checked"><label for="selfsigned" title="Step that should only be run when deploying with SSL and a self-signed certificate.">Self-Signed SSL</label></li>
</ul>
<span class="title">Features</span>
<ul>
<li><input type="checkbox" id="validations" checked="checked"><label for="validations" title="Step that should only be run when deploying with validations.">Validations</label></li>
<li><input type="checkbox" id="optional" checked="checked"><label for="optional" title="Step that is optional. A deployment can be done without these steps, but they may provide useful additional functionality.">Optional</label></li>
</ul>
<span class="title">Additional Overcloud Roles</span>

17
doc/source/index.rst
Unescape View File

@ -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.

3
doc/source/install/advanced_deployment/ssl.rst
Unescape View File

@ -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

26
doc/source/install/basic_deployment/basic_deployment_cli.rst
Unescape View File

@ -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

3
doc/source/install/installation/installing.rst
Unescape View File

@ -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

Write Preview
Loading…
Cancel
Save