From 5305eae4e2c9b5c893c3da8a03eecce1dab8392a Mon Sep 17 00:00:00 2001 From: Jose Luis Franco Arza Date: Mon, 6 Nov 2017 11:59:40 +0100 Subject: [PATCH] Upgrades developer documentation layout. A new section is being added with the intention of spreading the knowledge about upgrades/updates process within the TripleO community. Change-Id: Ib3f3f8f411383e72b125d1e9f2608a6f76f06494 --- doc/source/install/developer/developer.rst | 1 + .../developer/upgrades/ci_upgrades.rst | 24 +++++++++++++++++++ .../developer/upgrades/collab_upgrades.rst | 16 +++++++++++++ .../developer/upgrades/fast_fw_upgrade.rst | 12 ++++++++++ .../developer/upgrades/major_upgrade.rst | 20 ++++++++++++++++ .../developer/upgrades/minor_update.rst | 16 +++++++++++++ .../install/developer/upgrades/upgrades.rst | 17 +++++++++++++ 7 files changed, 106 insertions(+) create mode 100644 doc/source/install/developer/upgrades/ci_upgrades.rst create mode 100644 doc/source/install/developer/upgrades/collab_upgrades.rst create mode 100644 doc/source/install/developer/upgrades/fast_fw_upgrade.rst create mode 100644 doc/source/install/developer/upgrades/major_upgrade.rst create mode 100644 doc/source/install/developer/upgrades/minor_update.rst create mode 100644 doc/source/install/developer/upgrades/upgrades.rst diff --git a/doc/source/install/developer/developer.rst b/doc/source/install/developer/developer.rst index 49c92752..ee9a3743 100644 --- a/doc/source/install/developer/developer.rst +++ b/doc/source/install/developer/developer.rst @@ -8,4 +8,5 @@ Documentation of developer-specific options in |project|. tripleo.sh tht_walkthrough/tht_walkthrough + upgrades/upgrades release diff --git a/doc/source/install/developer/upgrades/ci_upgrades.rst b/doc/source/install/developer/upgrades/ci_upgrades.rst new file mode 100644 index 00000000..2531b7e8 --- /dev/null +++ b/doc/source/install/developer/upgrades/ci_upgrades.rst @@ -0,0 +1,24 @@ +.. TODO: This is a template which is being + completed. The subsections stated + here might differ from the ones in the + final version. + +Major upgrades/Minor upgrades CI coverage +----------------------------------------- + +Upgrades CI jobs +~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +How to add a new upgrade/update job in the CI +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +Debugging CI jobs +~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +Replicating CI jobs +~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + diff --git a/doc/source/install/developer/upgrades/collab_upgrades.rst b/doc/source/install/developer/upgrades/collab_upgrades.rst new file mode 100644 index 00000000..efc7ea08 --- /dev/null +++ b/doc/source/install/developer/upgrades/collab_upgrades.rst @@ -0,0 +1,16 @@ +.. TODO: This is a template which is being + completed. The subsections stated + here might differ from the ones in the + final version. + +How to collaborate to the upgrades/updates workflow +--------------------------------------------------- + +Relevant repositories +~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +Guide: Implementing keystone upgrade steps +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + diff --git a/doc/source/install/developer/upgrades/fast_fw_upgrade.rst b/doc/source/install/developer/upgrades/fast_fw_upgrade.rst new file mode 100644 index 00000000..d1a55b67 --- /dev/null +++ b/doc/source/install/developer/upgrades/fast_fw_upgrade.rst @@ -0,0 +1,12 @@ +.. TODO: This is a template which is being + completed. The subsections stated + here might differ from the ones in the + final version. + +Fast forward upgrade (N -> N+3) in TripleO +---------------------------------------------------- + +Tutorial: Fast forward upgrade from Newton to Queens +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + diff --git a/doc/source/install/developer/upgrades/major_upgrade.rst b/doc/source/install/developer/upgrades/major_upgrade.rst new file mode 100644 index 00000000..71136636 --- /dev/null +++ b/doc/source/install/developer/upgrades/major_upgrade.rst @@ -0,0 +1,20 @@ +.. TODO: This is a template which is being + completed. The subsections stated + here might differ from the ones in the + final version. + +Upgrade to a major release in TripleO +------------------------------------- + +Major upgrade workfow +~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +Tutorial: Upgrade from Pike to Queens +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +Tutorial: Upgrade from Ocata to Pike +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + diff --git a/doc/source/install/developer/upgrades/minor_update.rst b/doc/source/install/developer/upgrades/minor_update.rst new file mode 100644 index 00000000..20446d45 --- /dev/null +++ b/doc/source/install/developer/upgrades/minor_update.rst @@ -0,0 +1,16 @@ +.. TODO: This is a template which is being + completed. The subsections stated + here might differ from the ones in the + final version. + +Update to a minor release in TripleO +------------------------------------- + +Minor update workfow +~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + +Tutorial: Minor update +~~~~~~~~~~~~~~~~~~~~~~ +# WORK IN PROGRESS + diff --git a/doc/source/install/developer/upgrades/upgrades.rst b/doc/source/install/developer/upgrades/upgrades.rst new file mode 100644 index 00000000..d4ba54a3 --- /dev/null +++ b/doc/source/install/developer/upgrades/upgrades.rst @@ -0,0 +1,17 @@ +Major Upgrade/Minor update developer documentation +================================================== + +This section is intended to give a better understanding of the upgrade/update +process in TripleO. As well as a walkthrough for developers on the way upgrade +workflow enables OpenStack services upgrade. + +# WORK IN PROGRESS: Intended for Queens release + +.. toctree:: + :maxdepth: 2 + + major_upgrade + minor_update + fast_fw_upgrade + ci_upgrades + collab_upgrades