openstack/charm-guide
Code Issues Proposed changes

Improve series and OpenStack upgrades

Browse Source 
Add guidance around the order of series upgrades. This
effectively follows the established order for OpenStack
upgrades as per team consensus. However, machines hosting
mysql-router instances were inserted between the database
cluster and the RabbitMQ cluster.

Minor refactor of wording on the OpenStack upgrades page.

Small miscellaneous wording improvements.

Closes-Bug: #1976030
Change-Id: I1a670f97a3ba63907969318ee2f367c707ebd634
This commit is contained in:
Peter Matulis
2022-08-31 17:46:35 -04:00
parent 77a6f2d8f2
commit 6536a679a4
3 changed files with 46 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/upgrades/charms.rst
View File

@@ -41,7 +41,7 @@ table.
.. note::
At this time, only stable charms are listed in the upgrade order table.
Only stable charms are listed in the upgrade order table.
.. list-table:: Principal charms
:header-rows: 1

26
doc/source/admin/upgrades/openstack.rst
View File

@@ -27,11 +27,19 @@ page.
Upgradable services
-------------------
Services whose software is not included in the `Ubuntu Cloud Archive`_ do not
get upgraded during a charmed OpenStack upgrade. This software is upgraded by
the administrator (on the units) using other means (e.g. manually via package
utilities, the Landscape management tool, a snap, or as part of a series
upgrade). Common charms where this applies are:
Only services whose software is included in the `Ubuntu Cloud Archive`_ will
get upgraded during an OpenStack upgrade.
Services that are associated with subordinate charms are upgradable but only
indirectly. They get upgraded along with their parent principal application.
Subordinate charms do not support the ``openstack-origin`` (or ``source``)
configuration option that is, as will be shown, a pre-requisite for initiating
an OpenStack charm payload upgrade.
Non-UCA software is upgraded by the administrator (on the units) using other
means (e.g. manually via package utilities, the Landscape management tool, a
snap, or as part of a series upgrade). Common applications where this applies
are:
* memcached
* ntp
@@ -41,12 +49,6 @@ upgrade). Common charms where this applies are:
* rabbitmq-server
* vault
Services that are associated with subordinate charms are upgradable but only
indirectly. They get upgraded along with their parent principal application.
Subordinate charms do not support the ``openstack-origin`` (or ``source``)
configuration option that is, as will be shown, a pre-requisite for initiating
an OpenStack charm payload upgrade.
.. _openstack_upgrade_prepare:
Prepare for the upgrade
@@ -219,7 +221,7 @@ along with those of the service being targeted.
.. note::
At this time, only stable charms are listed in the upgrade order table.
Only stable charms are listed in the upgrade order table.
.. list-table::
:header-rows: 1

31
doc/source/admin/upgrades/series.rst
View File

@@ -51,6 +51,21 @@ Focal was possible starting on August 6, 2020.
an upgrade candidate is available or not. A cancelled upgrade is not fatal,
but it will leave erroneous messaging in :command:`juju status` output.
Upgradable services
-------------------
Only services whose software is not included in the `Ubuntu Cloud Archive`_
will potentially get upgraded during a series upgrade. This software is sourced
from the standard Ubuntu package archives associated with the new series.
Common applications where this applies are:
* memcached
* ntp
* percona-cluster
* mysql-innodb-cluster
* mysql-router
* rabbitmq-server
The Juju :command:`upgrade-series` command
------------------------------------------
@@ -231,6 +246,17 @@ effective response to this.
plays a negligible role. Applications deployed with the compute and storage
charms fall into this category.
Upgrade order
-------------
There is no special order in which to upgrade all machines. However, it is
recommended that the following components (from the list of `Upgradable
services`_) be upgraded first:
#. database cluster (`percona-cluster`_ or `mysql-innodb-cluster`_)
#. if applicable, all database InnoDB router instances (`mysql-router`_)
#. RabbitMQ cluster (`rabbitmq-server`_)
.. _generic_series_upgrade:
Generic series upgrade
@@ -348,8 +374,13 @@ When you are ready to perform a series upgrade across your cloud proceed to
the :doc:`series-openstack` page.
.. LINKS
.. _Ubuntu Cloud Archive: https://wiki.ubuntu.com/OpenStack/CloudArchive
.. _Ubuntu releases wiki page: https://wiki.ubuntu.com/Releases
.. _series upgrade: https://juju.is/docs/olm/upgrade-a-machines-series
.. _Ubuntu OpenStack release cycle: https://ubuntu.com/about/release-cycle#ubuntu-openstack-release-cycle
.. _Application leadership: https://juju.is/docs/olm/leaders
.. _ubuntu: https://charmhub.io/ubuntu
.. _percona-cluster: https://opendev.org/openstack/charm-percona-cluster/
.. _mysql-innodb-cluster: https://opendev.org/openstack/charm-mysql-innodb-cluster
.. _mysql-router: https://opendev.org/openstack/charm-mysql-router
.. _rabbitmq-server: https://opendev.org/openstack/charm-rabbitmq-server/