openstack
/
charm-guide
Code Issues Proposed changes

Add stable charm statement and reformat width 

Also update main sections with individual charm support status
and add stable charm expectation statements for clarity.

Change-Id: Ic156c71194443054a7d5e912db3fee07f7c6e1b9
This commit is contained in:
Ryan Beisner 2019-04-17 14:07:24 -05:00
parent 3858caa27f
commit 3db05d6169
No known key found for this signature in database
GPG Key ID: 952BACDC1C1A05FB
3 changed files with 84 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
doc/source/1904.rst
View File

@ -7,7 +7,14 @@
Summary
=======
The 19.04 OpenStack Charm release includes updates for the following charms. Additional charm support status information is published in the main `charm guide <openstack-charms.html>`__ which ultimately supersedes release note contents.
The 19.04 OpenStack Charm release includes updates for the following charms.
Additional charm support status information is published in the main
`charm guide <openstack-charms.html>`__ which ultimately supersedes release
note contents.
Always use the latest stable charm revision before proceeding with topological
changes, application migrations, workload upgrades, series upgrades, or bug
reports.
Supported Charms
~~~~~~~~~~~~~~~~
@ -50,6 +57,7 @@ Supported Charms
Preview Charms
~~~~~~~~~~~~~~
* barbican-softhsm
* ceph-fs
* cinder-backup
* keystone-saml-mellon
@ -58,6 +66,7 @@ Preview Charms
* masakari
* masakari-monitors
* pacemaker-remote
* tempest
Removed Charms
~~~~~~~~~~~~~~
@ -77,6 +86,11 @@ The following charms have been removed as part of this charm release:
New Charm Features
==================
With each new feature, there is a corresponding example bundle in the form of
a test bundle, and/or a `charm deployment guide <https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/>`_
section which details the use of the feature. For example test bundles, see the
src/tests/bundles/ directory within the relevant charm repository.
PCI passthrough for GPU and other devices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -167,8 +181,6 @@ of the charm deployment guide for more details.
however, this may not be the desired behaviour. `Bug 1823331 <https://bugs.launchpad.net/charm-hacluster/+bug/1823331>`_
tracks exposing the stonith behaviour as a configuration option.
Keystone Federation With SAML Mellon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -202,11 +214,13 @@ Please refer to
`README <https://jujucharms.com/u/openstack-charmers/keystone-saml-mellon/>`_
of the charm for more details.
Upgrading charms
================
Always use the latest stable charm revision before proceeding with topological
changes, charm application migrations, workload upgrades, series upgrades, or
bug reports.
Please ensure that the keystone charm is upgraded first.
To upgrade an existing deployment to the latest charm version simply use the
@ -216,15 +230,19 @@ To upgrade an existing deployment to the latest charm version simply use the
juju upgrade-charm keystone
Charm upgrades and OpenStack upgrades are two distinctly different things. Charm upgrades ensure that the deployment is using the latest charm revision, containing the latest charm fixes and charm features available for a given deployment.
Charm upgrades and OpenStack upgrades are two distinctly different things.
Charm upgrades ensure that the deployment is using the latest charm
revision, containing the latest charm fixes and charm features available
for a given deployment.
Charm upgrades do not cause OpenStack versions to upgrade, however OpenStack upgrades do require the latest Charm version as pre-requisite.
Charm upgrades do not cause OpenStack versions to upgrade, however OpenStack
upgrades do require the latest Charm version as pre-requisite.
Upgrading OpenStack
===================
Before upgrading OpenStack, all OpenStack Charms should be running the latest stable
charm revision.
Before upgrading OpenStack, all OpenStack Charms should be running the latest
stable charm revision.
To upgrade an existing Queens based deployment on Ubuntu 18.04 to the Stein
release, re-configure the charm with a new openstack-origin
@ -248,7 +266,8 @@ resources, such as cinder, glance and nova-compute:
be tested in pre-production testing environments prior to production deployment
upgrades.
See https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-upgrade-openstack.html for more details.
See https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-upgrade-openstack.html
for more details.
.. note::
@ -266,11 +285,16 @@ Removed Features
nova-cloud-controller: single-nova-consoleauth
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'single-nova-consoleauth' feature has been removed from the nova-cloud-controller charm; this legacy feature has been superceeded by the use of nova-consoleauth daemons on all nova-cloud-controller units, sharing authentication tokens using memcached.
The 'single-nova-consoleauth' feature has been removed from the
nova-cloud-controller charm; this legacy feature has been superceeded by the
use of nova-consoleauth daemons on all nova-cloud-controller units, sharing
authentication tokens using memcached.
Cluster resources associated with this feature will be cleaned up up during charm upgrade.
Cluster resources associated with this feature will be cleaned up up during
charm upgrade.
If the charm is running in an HA deployment, a relation to memcached must be added to the nova-cloud-controller application:
If the charm is running in an HA deployment, a relation to memcached must
be added to the nova-cloud-controller application:
.. code:: bash
@ -295,11 +319,18 @@ Adding nova-cloud-controller memcached relation
This leads to `bug 1823740`_ where memcached units have the wrong IP addresses
for the nova-cloud-controller units in the iptables rules used to restrict access.
The symptom is the command "openstack availability zone" list timing out and SYN_SENT connections on the nova-cloud-controller unit to the memcached unit. Launching new instances will also fail.
The symptom is the command "openstack availability zone" list timing out and
SYN_SENT connections on the nova-cloud-controller unit to the memcached unit.
Launching new instances will also fail.
Because Juju does not currently allow network space binding post-deployment (`bug 1796653`_) memcached must be (re-)deployed with the correct network space bindings to support access from the nova-cloud-controller units.
Because Juju does not currently allow network space binding post-deployment
(`bug 1796653`_) memcached must be (re-)deployed with the correct network
space bindings to support access from the nova-cloud-controller units.
There are two approaches. The safest of which is to deploy a new set of memcached units either with their cache relationship bound to nova-cloud-controllers default space or their default space set to the same as nova-cloud-controllers.
There are two approaches. The safest of which is to deploy a new set of
memcached units either with their cache relationship bound to
nova-cloud-controllers default space or their default space set to the same as
nova-cloud-controllers.
.. code:: bash
@ -311,7 +342,8 @@ or
juju deploy -n 2 cs:memcached --to lxd:1,lxd:2 --bind "<NCC's DEFAULT SPACE>" ncc-memcached
The alternative is to remove the existing memcached application entirely and redeploy it using the same approach.
The alternative is to remove the existing memcached application entirely and
redeploy it using the same approach.
.. _bug 1823740: https://bugs.launchpad.net/charm-nova-cloud-controller/+bug/1823740
.. _bug 1796653: https://bugs.launchpad.net/juju/+bug/1796653
@ -319,11 +351,17 @@ The alternative is to remove the existing memcached application entirely and red
Cinder auto-resume after openstack upgrade action
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There was a conflict between the way the cinder charm handled series-upgrade and action managed openstack upgrades as described in (`bug 1824545`_).
There was a conflict between the way the cinder charm handled series-upgrade
and action managed openstack upgrades as described in (`bug 1824545`_).
When an cinder unit was paused and an action managed openstack upgrade was performed certain necessary steps were accidentally skipped. The solution is to run an automatic resume immediately after openstack upgrade, which the charm now does.
When a cinder unit was paused and an action managed openstack upgrade was
performed certain necessary steps were accidentally skipped. The solution is
to run an automatic resume immediately after openstack upgrade, which the
charm now does.
This note is to point out this behavior is different than the other charms. We may change the other charms to match this behavior at some point in the future.
This note is to point out this behavior is different than the other charms.
We may change the other charms to match this behavior at some point in the
future.
After the following actions:
@ -333,14 +371,16 @@ After the following actions:
juju run-action --wait cinder/0 pause
juju run-action --wait cinder/0 openstack-upgrade
The cinder charm will be upgraded and resumed. It is no longer necessary to run the resume action post openstack upgrade.
The cinder charm will be upgraded and resumed. It is no longer necessary to run
the resume action post openstack upgrade.
.. _bug 1824545: https://bugs.launchpad.net/charm-cinder/+bug/1824545
Bugs Fixed
==========
This release includes 247 bug fixes. For the full list of bugs resolved for the 19.04 charms release please refer to https://launchpad.net/openstack-charms/+milestone/19.04.
This release includes 247 bug fixes. For the full list of bugs resolved for the
19.04 charms release please refer to https://launchpad.net/openstack-charms/+milestone/19.04.
Next Release Info
=================

17
doc/source/openstack-charms.rst
View File

@ -3,6 +3,13 @@
Charms
======
Each stable release of OpenStack Charms is backwards-compatible to cover all
currently-supported combinations of Ubuntu + OpenStack. The latest stable
charm revision should be used before proceeding with topological changes,
charm application migrations, workload upgrades, series upgrades, or
bug reports.
OpenStack Charms
~~~~~~~~~~~~~~~~
@ -29,6 +36,7 @@ These charms have stable releases with ongoing maintenance and testing.
* `nova-cloud-controller <https://git.openstack.org/cgit/openstack/charm-nova-cloud-controller/>`_
* `nova-compute <https://git.openstack.org/cgit/openstack/charm-nova-compute/>`_
* `octavia <https://git.openstack.org/cgit/openstack/charm-octavia/>`_
* `octavia-dashboard <https://git.openstack.org/cgit/openstack/charm-octavia-dashboard/>`_
* `openstack-dashboard <https://git.openstack.org/cgit/openstack/charm-openstack-dashboard/>`_
* `swift-proxy <https://git.openstack.org/cgit/openstack/charm-swift-proxy/>`_
* `swift-storage <https://git.openstack.org/cgit/openstack/charm-swift-storage/>`_
@ -61,8 +69,12 @@ make a stable release for production use.
* `barbican-softhsm <https://git.openstack.org/cgit/openstack/charm-barbican-softhsm/>`_
* `ceph-fs <https://git.openstack.org/cgit/openstack/charm-ceph-fs/>`_
* `cinder-backup <https://git.openstack.org/cgit/openstack/charm-cinder-backup/>`_
* `keystone-saml-mellon <https://github.com/openstack-charmers/charm-keystone-saml-mellon/>`_
* `manila <https://git.openstack.org/cgit/openstack/charm-manila/>`_
* `manila-generic <https://git.openstack.org/cgit/openstack/charm-manila-generic/>`_
* `masakari <https://git.openstack.org/cgit/openstack/charm-masakari/>`_
* `masakari-monitors <https://git.openstack.org/cgit/openstack/charm-masakari-monitors/>`_
* `pacemaker-remote <https://git.openstack.org/cgit/openstack/charm-pacemaker-remote/>`_
* `tempest <https://git.openstack.org/cgit/openstack/charm-tempest/>`_
Maintenance-Mode Charms
@ -80,6 +92,11 @@ Deprecated Charms
These charms have reached EOL and are deprecated.
* `ceph <https://git.openstack.org/cgit/openstack/charm-ceph/>`_ - Use ceph-osd + ceph-mon instead.
* `glusterfs <https://git.openstack.org/cgit/openstack/charm-glusterfs/>`_
* `manila-glusterfs <https://git.openstack.org/cgit/openstack/charm-manila-glusterfs/>`_
* `murano <https://git.openstack.org/cgit/openstack/charm-murano/>`_
* `neutron-api-odl <https://git.openstack.org/cgit/openstack/charm-neutron-api-odl/>`_
* `nova-compute-proxy <https://git.openstack.org/cgit/openstack/charm-nova-compute-proxy/>`_
* `openvswitch-odl <https://git.openstack.org/cgit/openstack/charm-openvswitch-odl/>`_
* `odl-controller <https://git.openstack.org/cgit/openstack/charm-odl-controller/>`_
* `trove <https://git.openstack.org/cgit/openstack/charm-trove/>`_

5
doc/source/release-policy.rst
View File

@ -10,6 +10,11 @@ on the charms in terms of development and testing.
The OpenStack Charms team produces a release every 3 months, with every other release
aligned to the main OpenStack release.
Each stable release of OpenStack Charms is backwards-compatible to cover all currently-supported
combinations of Ubuntu + OpenStack. It follows that the latest stable charm revision should
be used before proceeding with topological changes, charm application migrations, workload
upgrades, series upgrades, or bug reports.
To be included as part of a release, the (sub)team supporting a charm must meet the
following release requirements: