openstack
/
charm-guide
Code Issues Proposed changes

Merge "Add payload upgrade commands for channels"

This commit is contained in:
Zuul 2023-04-13 10:49:15 +00:00 committed by Gerrit Code Review
parent 871df7f062 d106a7ed0f
commit 984867f0a8
3 changed files with 40 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -351,18 +351,26 @@ individually, **always upgrade the application leader first**.
juju run -a <application-name> is-leader
Legacy charms vs channel charms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Depending on whether a given charm uses channels or not (see the
:doc:`../../concepts/charm-types` page), there are slight differences in the
upgrade procedures:
:doc:`../../concepts/charm-types` page), there are differences in the upgrade
procedures.
* With non-channel charms, you will need to set the software sources of the
charm. Guidance is provided in the :doc:`../../concepts/software-sources`
page.
.. note::
* With channel charms, you will need to change the charm's channel. See the
:ref:`changing_the_channel` section of the Charm delivery page for background
information. **Notably, a channel change will typically cause the underlying
cloud service to restart**.
Please read the rest of this document, and any linked resources, before
making any changes to your cloud.
The upgrade will involve changing the software sources when either type of
charm is in use. Background information on sources is provided in the
:doc:`../../concepts/software-sources` concepts page.
With channel charms, you must also change the charm's channel. See the
:ref:`changing_the_channel` section of the Charm delivery page for background
information. Notably, a channel change will typically cause the underlying
cloud service to restart.
All-in-one
~~~~~~~~~~
@ -390,7 +398,19 @@ Xena to Yoga:
.. code-block:: none
juju config cinder openstack-origin=cloud:focal-xena
juju refresh --channel yoga/stable cinder
juju config cinder openstack-origin=cloud:focal-yoga
.. note::
Exceptionally, if upgrading from Ussuri to Victoria the commands will be:
.. code-block:: none
juju config cinder openstack-origin=distro
juju refresh --channel yoga/stable cinder
juju config cinder openstack-origin=cloud:focal-victoria
**If charm channels are not in use:**
@ -423,6 +443,7 @@ For example, to upgrade a three-unit glance application from Xena to Yoga where
.. code-block:: none
juju refresh --channel yoga/stable glance
juju config glance openstack-origin=cloud:focal-yoga
**If charm channels are not in use:**
@ -469,6 +490,7 @@ Yoga where ``nova-compute/0`` is the leader:
.. code-block:: none
juju refresh --channel yoga/stable nova-compute
juju config nova-compute openstack-origin=cloud:focal-yoga
**If charm channels are not in use:**
@ -518,6 +540,7 @@ where ``keystone/2`` is the leader:
.. code-block:: none
juju refresh --channel yoga/stable keystone
juju config keystone openstack-origin=cloud:focal-yoga
**If charm channels are not in use:**

4
doc/source/project/charm-delivery.rst
View File

@ -363,8 +363,8 @@ new channel must be chosen according to the target future OpenStack release.
.. warning::
Changing a charm's channel will trigger a charm upgrade, which will
typically cause the underlying cloud service to restart.
Changing a charm's channel is intended to trigger a charm upgrade, which
will typically cause the underlying cloud service to restart.
Study the :doc:`../admin/upgrades/openstack` process prior to changing charm
channels.

12
doc/source/project/procedures/charmhub-migration.rst
View File

@ -2,11 +2,15 @@
All charms: migration to channels
=================================
Charmed OpenStack deployments must eventually migrate from legacy non-channel
charms to charms that use a channel.
All maintenance for stable charms occurs on the various explicitly-named
channels (i.e. not based on the ``latest`` track). These are the channels that
the charms must be migrated to.
.. important::
In order to receive charm updates (e.g. bug fixes) it is highly recommended
to migrate from legacy non-channel charms to charms that use a channel.
See :doc:`../charm-delivery` for an overview of how OpenStack charms are
distributed.
@ -19,10 +23,6 @@ not requested at deploy time, the ``latest/stable`` channel in the Charmhub is
sourced, which points to the 21.10 stable release of OpenStack Charms (or the
21.06 stable release of Trilio Charms).
All maintenance for stable charms occurs on the various explicitly-named
channels (i.e. not based on the ``latest`` track). These are the channels that
the charms must be migrated to.
.. warning::
The OpenStack Charms project strongly advises against the use of the