openstack/openstack-ansible
Code Issues Proposed changes

[doc] Update upgrade guide to mention SLURP

Browse Source 
Despite Yoga is an unofficial SLURP release, we're preparing all tooling
and test upgrades from Y to 2023.1. With that we're mentioning
in docs, that upgrade from Y is possible. We also update release names
that are used in docs.

Change-Id: I41eb336016920624bbf0fa7641301c64cce1070a
This commit is contained in:
Dmitriy Rabotyagov 2023-05-18 13:28:09 +02:00 committed by Dmitriy Rabotyagov
parent ebf9f3ae1b
commit 5b9ea29ff4
3 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
deploy-guide/source/conf.py
View File

@ -32,8 +32,8 @@ import openstackdocstheme
# Variables to override
target_name = 'openstack-ansible'
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
previous_series_name = 'yoga'
current_series_name = 'zed'
previous_series_name = 'zed'
current_series_name = '2023.1'
# General information about the project.
author = 'OpenStack-Ansible Contributors'

19
doc/source/admin/upgrades/major-upgrades.rst
View File

@ -3,12 +3,15 @@ Major upgrades
==============
This guide provides information about the upgrade process from
|previous_release_formal_name| to |current_release_formal_name|
for OpenStack-Ansible.
|previous_release_formal_name| |previous_slurp_name| to
|current_release_formal_name| for OpenStack-Ansible.
.. note::
You can only upgrade between sequential releases.
You can upgrade between sequential releases or between releases
marked as `SLURP`_.
.. _SLURP: https://releases.openstack.org/
Introduction
============
@ -31,15 +34,15 @@ Upgrading by using a script
===========================
The |current_release_formal_name| release series of OpenStack-Ansible contains
the code for migrating from |previous_release_formal_name| to
|current_release_formal_name|.
the code for migrating from |previous_release_formal_name|
|previous_slurp_name| to |current_release_formal_name|.
Running the upgrade script
~~~~~~~~~~~~~~~~~~~~~~~~~~
To upgrade from |previous_release_formal_name| to |current_release_formal_name|
by using the upgrade script, perform the following steps in the
``openstack-ansible`` directory:
To upgrade from |previous_release_formal_name| |previous_slurp_name| to
|current_release_formal_name| by using the upgrade script, perform the
following steps in the ``openstack-ansible`` directory:
#. Change directory to the repository clone root directory:

12
doc/source/conf.py
View File

@ -33,8 +33,9 @@ import yaml
# Variables to override
target_name = 'openstack-ansible'
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
previous_series_name = 'yoga'
current_series_name = 'zed'
previous_series_name = 'zed'
previous_slurp_name = 'yoga'
current_series_name = '2023.1'
# General information about the project.
author = 'OpenStack-Ansible Contributors'
@ -71,6 +72,11 @@ deploy_guide_prefix = ("https://docs.openstack.org/"
dev_docs_prefix = ("https://docs.openstack.org/openstack-ansible/"
"{}/%s".format(current_series))
if previous_slurp_name:
slurp_epilog = f"replace:: or {previous_slurp_name.capitalize()}"
else:
slurp_epilog = "unicode:: U+200B"
# Substitutions loader
rst_epilog = """
.. |current_release_git_branch_name| replace:: {current_release_git_branch_name}
@ -80,12 +86,14 @@ rst_epilog = """
.. |current_release_formal_name| replace:: {current_release_formal_name}
.. |latest_tag| replace:: {latest_tag}
.. |upgrade_warning| replace:: {upgrade_warning}
.. |previous_slurp_name| {slurp_epilog}
""".format( # noqa: E501
current_release_git_branch_name=branch,
current_release_gnocchi_git_branch_name=gnocchi_branch,
previous_series_name=previous_series_name,
previous_release_formal_name=previous_series_name.capitalize(),
current_release_formal_name=current_series_name.capitalize(),
slurp_epilog=slurp_epilog,
latest_tag=latest_tag,
upgrade_warning=upgrade_warning,
)