From b5cd47cce2a34bcdc9e19fe55aa4eec45a2e911c Mon Sep 17 00:00:00 2001
From: Peter Matulis <peter.matulis@canonical.com>
Date: Fri, 21 May 2021 16:12:41 -0400
Subject: [PATCH] Disable auto retry hooks for upgrades

A lesson from ServerStack upgrades.

Fix a broken link for unattended upgrades paragraph.
Then decided to create a new section for this topic,
dropping the linking and just provide a command.

Provide the above as specific pre-upgrade and post-
upgrade steps by linking from the detailed
upgrade-series-openstack page.

Drive-by: Provide a link for workload maintenance
tasks from the detailed page to the general page.

Change-Id: I69dce6387d1446e91221346ffa0cb89a7d05b414
---
 deploy-guide/source/upgrade-overview.rst      | 17 ++++++++++++++++
 .../source/upgrade-series-openstack.rst       |  7 ++++++-
 deploy-guide/source/upgrade-series.rst        | 20 ++++++++++++++++---
 3 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/deploy-guide/source/upgrade-overview.rst b/deploy-guide/source/upgrade-overview.rst
index cde6196..9444570 100644
--- a/deploy-guide/source/upgrade-overview.rst
+++ b/deploy-guide/source/upgrade-overview.rst
@@ -165,6 +165,23 @@ Upgrade path:
 
 Final result: OpenStack Victoria on Ubuntu 20.04 LTS
 
+Disable automatic hook retries
+------------------------------
+
+For all upgrade types it is recommended to disable automatic hook retries
+within the model containing the cloud. This will prevent the charms from
+attempting to resolve any encountered problems, thus providing an early
+opportunity for the operator to respond accordingly.
+
+Assuming the cloud model is the current working model turn off hook retries in
+this way:
+
+.. code-block:: none
+
+   juju model-config automatically-retry-hooks=false
+
+This change should normally be reverted once the upgrade is completed.
+
 Next steps
 ----------
 
diff --git a/deploy-guide/source/upgrade-series-openstack.rst b/deploy-guide/source/upgrade-series-openstack.rst
index 945d3de..391202e 100644
--- a/deploy-guide/source/upgrade-series-openstack.rst
+++ b/deploy-guide/source/upgrade-series-openstack.rst
@@ -116,7 +116,10 @@ The steps are as follows:
 
 #. Perform a series upgrade on the principal leader machine.
 
-   #. Perform any pre-upgrade workload maintenance tasks.
+   #. Disable :ref:`Unattended upgrades <unattended_upgrades>`.
+
+   #. Perform any pre-upgrade :ref:`workload maintenance tasks
+      <workload_maintenance>`.
 
    #. Invoke the :command:`prepare` sub-command.
 
@@ -124,6 +127,8 @@ The steps are as follows:
 
    #. Perform any post-upgrade workload maintenance tasks.
 
+   #. Re-enable Unattended upgrades.
+
    #. Reboot.
 
 #. Set the value of the (application-dependent) ``openstack-origin`` or the
diff --git a/deploy-guide/source/upgrade-series.rst b/deploy-guide/source/upgrade-series.rst
index 5d16993..f278ca5 100644
--- a/deploy-guide/source/upgrade-series.rst
+++ b/deploy-guide/source/upgrade-series.rst
@@ -118,8 +118,21 @@ making any changes.
 * The Juju model comprising the cloud should be error-free (e.g. there should
   be no charm hook errors).
 
-* `Automatic package updates`_ should be disabled on the nodes to avoid
-  potential conflicts with the manual (or scripted) APT steps.
+.. _unattended_upgrades:
+
+Unattended upgrades
+-------------------
+
+Automatic package updates should be disabled on a node that is about to undergo
+a series upgrade. This is to avoid potential conflicts with the manual (or
+scripted) APT steps. One way to achieve this is with:
+
+.. code-block:: none
+
+   sudo dpkg-reconfigure -plow unattended-upgrades
+
+Once the upgrade is complete it is advised to re-enable unattended upgrades for
+security reasons.
 
 .. _workload_specific_preparations:
 
@@ -138,6 +151,8 @@ implemented series upgrade yet or simply may not work with the target series.
 Pay particular attention to SDN (software defined networking) and storage
 charms as these play a crucial role in cloud operations.
 
+.. _workload_maintenance:
+
 Workload maintenance
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -321,7 +336,6 @@ appendix :doc:`Series upgrade OpenStack <upgrade-series-openstack>`.
 .. _OpenStack upgrade: upgrade-openstack.html
 .. _Known OpenStack upgrade issues: upgrade-issues.html
 .. _series upgrade: https://juju.is/docs/upgrading-series
-.. _automatic package updates: https://help.ubuntu.com/lts/serverguide/automatic-updates.html.en
 .. _Ubuntu OpenStack release cycle: https://ubuntu.com/about/release-cycle#ubuntu-openstack-release-cycle
 .. _Application leadership: https://juju.is/docs/implementing-leadership
 .. _ubuntu: https://jaas.ai/ubuntu