summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLingxian Kong <anlin.kong@gmail.com>2020-08-07 09:08:48 +1200
committerLingxian Kong <anlin.kong@gmail.com>2020-08-07 09:08:48 +1200
commit6b1c31e2ed513785d72b5bf73bd928453b7f5a61 (patch)
treea24cc4c553c93817541fa7c983b3b05d8dd6eb04 /doc
parentcf3e9a6e7459e8434172e03b0b046bcbe4b277d5 (diff)
downloadtrove-6b1c31e2ed513785d72b5bf73bd928453b7f5a61.tar.gz
Add instruction for upgrading trove guest agent
Change-Id: I574f93d2023d35b2ede0e6e532a06ea1bdddad5f
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/index.rst1
-rw-r--r--doc/source/admin/upgrade-trove-guest-agent.rst20
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
index 2a25f73d..82a2b746 100644
--- a/doc/source/admin/index.rst
+++ b/doc/source/admin/index.rst
@@ -9,4 +9,5 @@
datastore
building_guest_images
secure_oslo_messaging
+ upgrade-trove-guest-agent
troubleshooting
diff --git a/doc/source/admin/upgrade-trove-guest-agent.rst b/doc/source/admin/upgrade-trove-guest-agent.rst
new file mode 100644
index 00000000..edce4e6e
--- /dev/null
+++ b/doc/source/admin/upgrade-trove-guest-agent.rst
@@ -0,0 +1,20 @@
+=========================
+Trove guest agent upgrade
+=========================
+
+Normally, during Trove service upgrade, a new guest image needs to be rebuilt and used to rebuild the guest instance when the interfaces between Trove controller and guest agent change. Otherwise, the newer version Trove controller can't talk to the older version guest agent.
+
+Prior to Victoria release, the process to upgrade guest agent is:
+
+#. The cloud administrator builds a new guest image based on the target Trove code version.
+#. The cloud user creates backup for their instance.
+#. The cloud administrator upgrades Trove controller service.
+#. The cloud administrator updates the existing datastore version using the new image.
+#. The cloud user creates a new instance using the backup created above.
+#. The cloud user deletes the old instance.
+
+From Victoria release, the upgrade process is much simpler:
+
+#. The cloud administrator builds a new guest image based on the target Trove code version.
+#. The cloud administrator updates the existing datastore version using the new image.
+#. The cloud administrator triggers rebuild for the existing instances using the new image. \ No newline at end of file