Signed-off-by: Russell Bryant <[email protected]>
---
ovn/automake.mk | 3 +-
ovn/docs/upgrades.rst | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 91 insertions(+), 1 deletion(-)
create mode 100644 ovn/docs/upgrades.rst
diff --git a/ovn/automake.mk b/ovn/automake.mk
index 3bcc1d5..6905061 100644
--- a/ovn/automake.mk
+++ b/ovn/automake.mk
@@ -73,7 +73,8 @@ DISTCLEANFILES += ovn/ovn-architecture.7
EXTRA_DIST += \
ovn/TODO.rst \
ovn/CONTAINERS.OpenStack.rst \
- ovn/OVN-GW-HA.rst
+ ovn/OVN-GW-HA.rst \
+ ovn/docs/upgrades.rst
# Version checking for ovn-nb.ovsschema.
ALL_LOCAL += ovn/ovn-nb.ovsschema.stamp
diff --git a/ovn/docs/upgrades.rst b/ovn/docs/upgrades.rst
new file mode 100644
index 0000000..b5f8bb0
--- /dev/null
+++ b/ovn/docs/upgrades.rst
@@ -0,0 +1,89 @@
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+ Convention for heading levels in Open vSwitch documentation:
+
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+
+ Avoid deeper levels because they do not render well.
+
+============
+OVN Upgrades
+============
+
+Since OVN is a distributed system, special consideration must be given to
+the process used to upgrade OVN across a deployment. This document discusses
+the recommended upgrade process.
+
+Release Notes
+-------------
+
+You should always check the OVS and OVN release notes (NEWS file) for any
+release specific notes on upgrades.
+
+OVS
+---
+
+OVN depends on and is included with OVS. It's expected that OVS and OVN are
+upgraded together, partly for convenience. OVN is included in OVS releases
+so it's easiest to upgrade them together. OVN may also make use of new
+features of OVS only available in that release.
+
+Upgrade OVN Databases and ovn-northd
+------------------------------------
+
+The OVN databases and ovn-northd should be upgraded first. The OVN database
+schemas are versioned and are only changed in a backwards compatible way.
+This lets you upgrade the database while still allowing older clients of the
+database to continue operating as you do a rolling upgrade through the
+environment.
+
+Upgrading the OVN packages installs everything needed for an upgrade. The only
+step required after upgrading the packages is to restart ovn-northd, which
+automatically restarts the databases and upgrades the database schema, as well.
+
+You may perform this restart using the ovn-ctl script::
+
+ $ sudo /usr/share/openvswitch/scripts/ovn-ctl restart_northd
+
+or if you're using a Linux distribution with systemd::
+
+ $ sudo systemctl restart ovn-northd
+
+Upgrade ovn-controller
+----------------------
+
+Next you should upgrade ovn-controller on each host its running on.
+First, you upgrade the OVS and OVN packages. Then, restart the
+ovn-controller service. You can restart with ovn-ctl::
+
+ $ sudo /usr/share/openvswitch/scripts/ovn-ctl restart_controller
+
+or with systemd::
+
+ $ sudo systemd restart ovn-controller
+
+Upgrading OVN Integration
+-------------------------
+
+Lastly, you may also want to upgrade integration with OVN that you may be
+using. For example, this could be the OpenStack Neutron driver or
+ovn-kubernetes.
+
+OVN's northbound database schema is a backwards compatible interface, so
+you should be able to safely complete an OVN upgrade before upgrading
+any integration in use.
--
2.9.3
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
