Merge "Review and refactor upgrade pages"
This commit is contained in:
Zuul
Gerrit Code Review
commit
9bce009dc9
@ -20,43 +20,9 @@ Please read the :doc:`overview` page before continuing.
|
||||
|
||||
It may be worthwhile to read the upstream OpenStack `Upgrades`_ guide.
|
||||
|
||||
Software sources
|
||||
----------------
|
||||
|
||||
A key part of an OpenStack upgrade is the stipulation of a unit's software
|
||||
sources. For an upgrade, the latter will naturally reflect a more recent
|
||||
combination of Ubuntu release (series) and OpenStack release. This combination
|
||||
is based on the `Ubuntu Cloud Archive`_ and translates to a "cloud archive
|
||||
OpenStack release". It takes on the following syntax:
|
||||
|
||||
``<ubuntu series>-<openstack-release>``
|
||||
|
||||
The value is passed to a charm's ``openstack-origin`` configuration option. For
|
||||
example, to select the 'focal-victoria' release:
|
||||
|
||||
``openstack-origin=cloud:focal-victoria``
|
||||
|
||||
In this way the charm is informed on where to find updates for the packages
|
||||
that it is responsible for.
|
||||
|
||||
Notes concerning the value of ``openstack-origin``:
|
||||
|
||||
* The default is 'distro'. This denotes an Ubuntu release's default archive
|
||||
(e.g. in the case of the focal series it corresponds to OpenStack Ussuri).
|
||||
The value of 'distro' is therefore invalid in the context of an OpenStack
|
||||
upgrade.
|
||||
|
||||
* It should normally be the same across all charms.
|
||||
|
||||
* Its series component must be that of the series currently in use (i.e. a
|
||||
series upgrade and an OpenStack upgrade are two completely separate
|
||||
procedures).
|
||||
|
||||
.. note::
|
||||
|
||||
A few charms use option ``source`` instead of ``openstack-origin`` (both
|
||||
options support identical values). The ``source`` option is used by charms
|
||||
that don't deploy an actual OpenStack service.
|
||||
You should also be familiar with how software sources (versioning) are
|
||||
specified for cloud services. See the :doc:`../../concepts/software-sources`
|
||||
page.
|
||||
|
||||
Upgradable services
|
||||
-------------------
|
||||
@ -350,11 +316,14 @@ Update the charm channel
|
||||
|
||||
.. warning::
|
||||
|
||||
This step is only performed for charms that follow a channel (see
|
||||
:ref:`Charm types <charm_types>`).
|
||||
This step is only performed for channel charms - see the
|
||||
:doc:`../../concepts/charm-types` page.
|
||||
|
||||
A charm's channel needs to be updated according to the target OpenStack
|
||||
release. This is done as per the following syntax:
|
||||
A charm's channel needs to be updated according to the target OpenStack release
|
||||
and the Ubuntu series currently in use. The :doc:`../../project/charm-delivery`
|
||||
page provides guidance on what values to use.
|
||||
|
||||
The change is made as per the following syntax:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
||||
@ -72,46 +72,16 @@ the administrator for the task of upgrading Charmed OpenStack.
|
||||
focal). This is normally due to upstream limitations (e.g Percona XtraDB
|
||||
Cluster no longer supported on Focal).
|
||||
|
||||
* There are two general types of charms: one that does use channels
|
||||
and one that does not (legacy). This differentiation has consequences for the
|
||||
three types of upgrades. See the :doc:`../../concepts/charm-types` page for
|
||||
an explanation.
|
||||
|
||||
.. note::
|
||||
|
||||
A charm's limitations concerning OpenStack versions and application features
|
||||
are stated in its README file.
|
||||
|
||||
.. _charm_types:
|
||||
|
||||
Charm types
|
||||
~~~~~~~~~~~
|
||||
|
||||
There are two general types of OpenStack charms: one that does use channels and
|
||||
one that does not (legacy).
|
||||
|
||||
.. note::
|
||||
|
||||
For an overview of how charms are distributed to the end-user see the
|
||||
:doc:`../../project/charm-delivery` page.
|
||||
|
||||
Channels
|
||||
^^^^^^^^
|
||||
|
||||
With the channels type, a channel is dedicated to a single OpenStack release
|
||||
(release N-1 will be technically supported to assist with upgrades). This means
|
||||
that a charm that works for a recent series-openstack combination will
|
||||
generally not work on an older combination. Furthermore, there is a need to
|
||||
switch to a different channel in order to upgrade to a new OpenStack version
|
||||
- but not to a new series.
|
||||
|
||||
Legacy
|
||||
^^^^^^
|
||||
|
||||
For the legacy charms, unless stated otherwise, each new revision of a charm
|
||||
includes all the functionality of the previous revision. This means that a
|
||||
charm that works for a recent series-openstack combination will also work on an
|
||||
older combination.
|
||||
|
||||
The development of legacy charms has stopped at the 21.10 release of OpenStack
|
||||
Charms (and at the 21.06 release of Trilio Charms). The last supported
|
||||
series-openstack combination is ``focal-xena``.
|
||||
|
||||
Software release cycles
|
||||
-----------------------
|
||||
|
||||
|
||||
32
doc/source/concepts/charm-types.rst
Normal file
32
doc/source/concepts/charm-types.rst
Normal file
@ -0,0 +1,32 @@
|
||||
===========
|
||||
Charm types
|
||||
===========
|
||||
|
||||
There are two general types of OpenStack charms: one that does use channels and
|
||||
one that does not (legacy).
|
||||
|
||||
Channels
|
||||
--------
|
||||
|
||||
With the channels type, a channel is dedicated to a single OpenStack release
|
||||
(release N-1 will be technically supported to assist with upgrades). This means
|
||||
that a charm that works for a recent series-openstack combination will
|
||||
generally not work on an older combination. Furthermore, there is a need to
|
||||
switch to a different channel in order to upgrade to a new OpenStack version
|
||||
- but not to a new series.
|
||||
|
||||
The :doc:`../project/charm-delivery` page explains how channel charms are
|
||||
distributed to the end user.
|
||||
|
||||
Legacy
|
||||
------
|
||||
|
||||
For the legacy charms, unless stated otherwise, each new revision of a charm
|
||||
includes all the functionality of the previous revision. This means that a
|
||||
charm that works for a recent series-openstack combination will also work on an
|
||||
older combination.
|
||||
|
||||
The development of legacy charms has stopped at the 21.10 release of OpenStack
|
||||
Charms (and at the 21.06 release of Trilio Charms). The last supported
|
||||
series-openstack combination is ``focal-xena``.
|
||||
|
||||
@ -5,4 +5,6 @@ Concepts
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
charm-types
|
||||
software-sources
|
||||
charm-anatomy
|
||||
|
||||
44
doc/source/concepts/software-sources.rst
Normal file
44
doc/source/concepts/software-sources.rst
Normal file
@ -0,0 +1,44 @@
|
||||
================
|
||||
Software sources
|
||||
================
|
||||
|
||||
A key part of an OpenStack deploy or upgrade is the stipulation of an
|
||||
application's software sources. This will affect the software used for cloud
|
||||
services.
|
||||
|
||||
During an upgrade, the software source will naturally reflect a more recent
|
||||
combination of Ubuntu release (series) and OpenStack release. This combination
|
||||
is based on the `Ubuntu Cloud Archive`_ and translates to a "cloud archive
|
||||
OpenStack release". It takes on the following syntax:
|
||||
|
||||
``<ubuntu series>-<openstack-release>``
|
||||
|
||||
The value is passed to a charm's ``openstack-origin`` configuration option. For
|
||||
example, to select the 'focal-victoria' release:
|
||||
|
||||
``openstack-origin=cloud:focal-victoria``
|
||||
|
||||
In this way the charm can update the apt package sources for the machines that
|
||||
correspond to a given application.
|
||||
|
||||
Notes concerning the value of ``openstack-origin``:
|
||||
|
||||
* The default is 'distro'. This denotes an Ubuntu release's default archive
|
||||
(e.g. in the case of the focal series it corresponds to OpenStack Ussuri).
|
||||
The value of 'distro' is therefore invalid in the context of an OpenStack
|
||||
upgrade.
|
||||
|
||||
* It should normally be the same across all charms.
|
||||
|
||||
* Its series component must be that of the series currently in use (i.e. a
|
||||
series upgrade and an OpenStack upgrade are two completely separate
|
||||
procedures).
|
||||
|
||||
.. note::
|
||||
|
||||
A few charms use option ``source`` instead of ``openstack-origin`` (both
|
||||
options support identical values). The ``source`` option is used by charms
|
||||
that don't deploy an actual OpenStack service (e.g. ceph-osd).
|
||||
|
||||
.. LINKS
|
||||
.. _Ubuntu Cloud Archive: https://wiki.ubuntu.com/OpenStack/CloudArchive
|
||||
@ -8,6 +8,10 @@ Overview
|
||||
Juju charms are delivered via the online `Charmhub`_. This page provides charm
|
||||
delivery information in the context of the OpenStack Charms project.
|
||||
|
||||
There are two general types of OpenStack charms: one that does use channels and
|
||||
one that does not (legacy) - see the :doc:`../concepts/charm-types` for
|
||||
details. This page will focus on channel charms.
|
||||
|
||||
Channels
|
||||
--------
|
||||
|
||||
|
||||
@ -6,8 +6,8 @@ This page lists the charms that make up the OpenStack Charms project. The
|
||||
version of OpenStack Charms when a charm first appeared is provided (see
|
||||
:doc:`release-schedule` for details of release times).
|
||||
|
||||
Read :ref:`charm_types` in the upgrade documentation to understand charm
|
||||
support in terms of Ubuntu series and OpenStack release.
|
||||
Read the :doc:`../concepts/charm-types` page to understand charm support in
|
||||
terms of Ubuntu series and OpenStack release.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user