From db77ca7f130353d265db8ef773a8cd1541c9d108 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Andr=C3=A9?= Date: Thu, 8 Jun 2017 19:06:45 +0200 Subject: [PATCH] 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 --- README.rst | 14 ++++++++++++++ doc/source/_exts/generate_validations_doc.py | 3 ++- doc/source/index.rst | 2 ++ 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 432622792..09e4a153a 100644 --- a/README.rst +++ b/README.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 ------------------- diff --git a/doc/source/_exts/generate_validations_doc.py b/doc/source/_exts/generate_validations_doc.py index 6ff3d3594..d390d48f9 100644 --- a/doc/source/_exts/generate_validations_doc.py +++ b/doc/source/_exts/generate_validations_doc.py @@ -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: diff --git a/doc/source/index.rst b/doc/source/index.rst index a65da8e82..8a39605da 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ==================