From 723eef92420d6d7a7ce9628457b50182931ec510 Mon Sep 17 00:00:00 2001
From: Ryan Beisner <ryan.beisner@canonical.com>
Date: Sat, 10 Mar 2018 19:49:24 +0100
Subject: [PATCH] Update release notes template ot match current format

Change-Id: I180411eed913a3c6f26495765806d98bc7fb02d9
---
 doc/source/release_notes_template.rst | 106 ++++++++++++++++++++------
 1 file changed, 83 insertions(+), 23 deletions(-)

diff --git a/doc/source/release_notes_template.rst b/doc/source/release_notes_template.rst
index 201382e4..f3bde975 100644
--- a/doc/source/release_notes_template.rst
+++ b/doc/source/release_notes_template.rst
@@ -1,4 +1,4 @@
-.. _release_notes_<VERSION>
+.. _release_notes_<CHARM_RELEASE>
 
 ===========================
 <release version goes here>
@@ -7,7 +7,7 @@
 Summary
 =======
 
-The <VERSION> OpenStack Charm release includes updates for the following charms:
+The <CHARM_RELEASE> OpenStack Charm release includes updates for the following charms:
 
 TODO: ensure these lists are accurate and up-to-date
 
@@ -38,14 +38,11 @@ Supported Charms
 * manila
 * manila-generic
 * neutron-api
-* neutron-api-odl
 * neutron-openvswitch
 * neutron-gateway
 * nova-cloud-controller
 * nova-compute
-* odl-controller
 * openstack-dashboard
-* openvswitch-odl
 * percona-cluster
 * rabbitmq-server
 * swift-proxy
@@ -53,19 +50,36 @@ Supported Charms
 
 Pre-Release Charms
 ~~~~~~~~~~~~~~~~~~
-* 
 
 Deprecated Charms
-~~~~~~~~~~~~~~~~~~
-* ceph
+~~~~~~~~~~~~~~~~~
 
 New Charm Features
 ==================
 
-Feature Title
-~~~~~~~~~~~~~
+OpenStack <O7K_RELEASE> Support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The charms provide full support for OpenStack <O7K_RELEASE>. For further details and documentation on Openstack <O7K_RELEASE> please check out https://releases.openstack.org/<O7K_RELEASE>.
+
+Use the ‘openstack-origin’ charm configuration option to declare the intended OpenStack version, for example:
+
+.. code:: bash
+
+    cat > config.yaml << EOF
+    nova-cloud-controller:
+      openstack-origin: cloud:xenial-<O7K_RELEASE>
+    EOF
+
+    juju deploy --config config.yaml nova-cloud-controller
+
+Also see the published example bundles.
+
+Feature Title 1
+~~~~~~~~~~~~~~~
+
+Feature Title 2
+~~~~~~~~~~~~~~~
 
-Feature description.
 
 Upgrading charms
 ================
@@ -73,40 +87,86 @@ Upgrading charms
 Please ensure that the keystone charm is upgraded first.
 
 To upgrade an existing deployment to the latest charm version simply use the
-'upgrade-charm' command:
+'upgrade-charm' command, for example:
 
 .. code:: bash
 
     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 do not cause OpenStack versions to upgrade, however OpenStack upgrades do require the latest Charm version as pre-requisite.
+
+Upgrading OpenStack
+===================
+When upgrading ceilometer to <O7K_RELEASE>, an identity-credentials relation needs to be added between ceilometer and keystone. If this relation is not added, the ceilometer charm will indicate it is in a blocked state via workload status.
+
+To upgrade an existing Pike based deployment on Ubuntu 16.04 to the <O7K_RELEASE>
+release, re-configure the charm with a new openstack-origin
+configuration:
+
+.. code:: bash
+
+    juju config nova-cloud-controller openstack-origin=cloud:xenial-<O7K_RELEASE>
+
+Please ensure that ceph services are upgraded before services that consume ceph
+resources, such as cinder, glance and nova-compute:
+
+.. code:: bash
+
+    juju config ceph-mon source=cloud:xenial-<O7K_RELEASE>
+    juju config ceph-osd source=cloud:xenial-<O7K_RELEASE>
+
+.. note::
+
+   Upgrading an OpenStack cloud is still not without risk; upgrades should
+   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.
+
+
 New Bundle Features
 ===================
 
-Bundle Feature Title
-~~~~~~~~~~~~~~~~~~~~
+<O7K_RELEASE> Support in Example Bundles
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+<O7K_RELEASE> versions of the example bundles are published in the charm store under cs:openstack-base, cs:openstack-telemetry. The stand-alone ceph bundle is also updated at cs:ceph-base. These bundles have been validated on x86_64, arm64, s390x and ppc64el architectures with Juju 2.3.3 and MAAS 2.3.0.
+
+https://jujucharms.com/openstack-base
+
+https://jujucharms.com/openstack-telemetry
+
+https://jujucharms.com/ceph-base
+
 
-Bundle feature description goes here.
 
 Deprecation Notices
 ===================
 
-Deprecation details go here.
+Notice 1
+~~~~~~~~
+
+Notice 2
+~~~~~~~~
+
 
 Known Issues
 ============
 
-Issue title
-~~~~~~~~~~~
+Issue 1
+~~~~~~~
+
+Issue 2
+~~~~~~~
 
-Issue description goes here.
 
 Bugs Fixed
 ==========
 
-For the full list of bugs resolved for the <VERSION> release please refer to
-https://launchpad.net/openstack-charms/+milestone/<VERSION>
+This release includes NNNN bugs fixes. For the full list of bugs resolved for the <CHARM_RELEASE> charms release please refer to https://launchpad.net/openstack-charms/+milestone/????.
 
 Next Release Info
 =================
-Name, Date etc
-
+The next OpenStack Charms release is currently scheduled for ????, and is subject to change.  Please see https://docs.openstack.org/charm-guide/latest for current information.