From e884faab61e6f062153dd207f63b768d74f2d779 Mon Sep 17 00:00:00 2001
From: Mark Goddard <mark@stackhpc.com>
Date: Thu, 6 Jun 2019 19:22:47 +0100
Subject: [PATCH] Docs: improve package update admin docs
Add information on updating package repos and rebooting after a kernel
update.
Change-Id: If6b637a0fac58ac7564c051e15b86a483b040a34
---
doc/source/administration/overcloud.rst | 31 +++++++++++++++++++++++--
doc/source/administration/seed.rst | 26 +++++++++++++++++++--
2 files changed, 53 insertions(+), 4 deletions(-)
diff --git a/doc/source/administration/overcloud.rst b/doc/source/administration/overcloud.rst
index 8757b8d68..a6a0eee81 100644
--- a/doc/source/administration/overcloud.rst
+++ b/doc/source/administration/overcloud.rst
@@ -5,8 +5,21 @@ Overcloud Administration
Updating Packages
=================
-It is possible to update packages on the overcloud hosts. To update one or more
-packages::
+It is possible to update packages on the overcloud hosts.
+
+Package Repositories
+--------------------
+
+If using custom package repositories, it may be necessary to update these prior
+to running a package update. To do this, update the configuration in
+``${KAYOBE_CONFIG_PATH}/yum.yml`` and run the following command::
+
+ (kayobe) $ kayobe overcloud host configure --tags yum --kolla-tags none
+
+Package Update
+--------------
+
+To update one or more packages::
(kayobe) $ kayobe overcloud host package update --packages <package1>,<package2>
@@ -21,6 +34,20 @@ To only install updates that have been marked security related::
Note that these commands do not affect packages installed in containers, only
those installed on the host.
+Kernel Updates
+--------------
+
+If the kernel has been updated, you will probably want to reboot the hosts to
+boot into the new kernel. This can be done using a command such as the
+following::
+
+ (kayobe) $ kayobe overcloud host command run --command "shutdown -r" --become
+
+It is normally best to apply this to control plane hosts in batches to avoid
+clustered services from losing quorum. This can be achieved using the
+``--limit`` argument, and ensuring services are fully up after rebooting before
+proceeding with the next batch.
+
Running Commands
================
diff --git a/doc/source/administration/seed.rst b/doc/source/administration/seed.rst
index 41ad8e8ee..2ea6d878f 100644
--- a/doc/source/administration/seed.rst
+++ b/doc/source/administration/seed.rst
@@ -16,8 +16,21 @@ To deprovision the seed VM::
Updating Packages
=================
-It is possible to update packages on the seed host. To update one or more
-packages::
+It is possible to update packages on the seed host.
+
+Package Repositories
+--------------------
+
+If using custom package repositories, it may be necessary to update these prior
+to running a package update. To do this, update the configuration in
+``${KAYOBE_CONFIG_PATH}/yum.yml`` and run the following command::
+
+ (kayobe) $ kayobe seed host configure --tags yum --kolla-tags none
+
+Package Update
+--------------
+
+To update one or more packages::
(kayobe) $ kayobe seed host package update --packages <package1>,<package2>
@@ -32,6 +45,15 @@ To only install updates that have been marked security related::
Note that these commands do not affect packages installed in containers, only
those installed on the host.
+Kernel Updates
+--------------
+
+If the kernel has been updated, you will probably want to reboot the seed host
+to boot into the new kernel. This can be done using a command such as the
+following::
+
+ (kayobe) $ kayobe seed host command run --command "shutdown -r" --become
+
Examining the Bifrost Container
===============================