Reference the new pre-update/pre-upgrade groups

The new 'pre-update' and 'pre-upgrade' groups contain validations that
check everything is in order before attempting an undercloud or
overcloud minor update of major upgrade. This commit makes the new
groups visible in the documentation.

Change-Id: Ie4526a868a0266b4630bd06d21f90013e2aa4c19
Partially-Implements: blueprint pre-upgrade-validations
changes/50/472350/3
Martin André 5 years ago
parent f3b1e39f94
commit db77ca7f13
  1. 14
      README.rst
  2. 3
      doc/source/_exts/generate_validations_doc.py
  3. 2
      doc/source/index.rst

@ -70,6 +70,20 @@ Validations that are run after the overcloud deployment finished.
.. include:: validations-post-deployment.rst
Pre Update
~~~~~~~~~~
Validations that are run right before a minor update of the undercloud or overcloud.
.. include:: validations-pre-update.rst
Pre Upgrade
~~~~~~~~~~~
Validations that are run right before a major upgrade of the undercloud or overcloud.
.. include:: validations-pre-upgrade.rst
Writing Validations
-------------------

@ -97,7 +97,8 @@ def build_detail(group, validations):
def setup(app):
# Seed it with the known groups:
groups = set(('prep', 'pre-introspection',
'pre-deployment', 'post-deployment'))
'pre-deployment', 'post-deployment',
'pre-update', 'pre-upgrade'))
validations = []
for validation_path in sorted(glob('validations/*.yaml')):
with open(validation_path) as f:

@ -25,6 +25,8 @@ Existing validations:
validations-pre-introspection-details
validations-pre-deployment-details
validations-post-deployment-details
validations-pre-update-details
validations-pre-upgrade-details
Indices and tables
==================

Loading…
Cancel
Save