summaryrefslogtreecommitdiff
path: root/doc/source/user/upgrade-datastore.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/user/upgrade-datastore.rst')
-rw-r--r--doc/source/user/upgrade-datastore.rst73
1 files changed, 39 insertions, 34 deletions
diff --git a/doc/source/user/upgrade-datastore.rst b/doc/source/user/upgrade-datastore.rst
index dd494e2d..8b16eea2 100644
--- a/doc/source/user/upgrade-datastore.rst
+++ b/doc/source/user/upgrade-datastore.rst
@@ -2,13 +2,13 @@
Upgrade datastore
=================
-You can upgrade your datastore version. When you perform an upgrade,
-the system automatically manages data and configuration files of your
-database.
+You can upgrade the datastore version of the database instance. When you
+perform an upgrade, the system automatically manages data and
+configuration files of your database.
To perform datastore upgrade, you need:
-- A supported OS image with the target datastore version.
+- A guest image with the target datastore version.
- A Trove database instance to be upgrade.
@@ -17,7 +17,7 @@ for a single instance database.
.. note::
- **Before** you begin make sure that:
+ **Before** upgrading, make sure that:
- Your target datastore is binary compatible with the current
datastore. Each database provider has its own compatibilty
@@ -35,17 +35,16 @@ Upgrading datastore
#. **Check instance status**
- Use :command:`openstack database instance list` to check whether the
- status of your instance is ACTIVE.
+ Make sure the instance status is HEALTHY before upgrading.
.. code-block:: console
- $openstack database instance list
- +--------------------------------------+------------+-----------+-------------------+--------+-----------+------+-----------+
- | ID | Name | Datastore | Datastore Version | Status | Flavor ID | Size | Region |
- +--------------------------------------+------------+-----------+-------------------+--------+-----------+------+-----------+
- | 55411e95-1670-497f-8d92-0179f3b4fdd4 | redis_test | redis | 3.2.6 | ACTIVE | 6 | 5 | RegionOne |
- +--------------------------------------+------------+-----------+-------------------+--------+-----------+------+-----------+
+ $ openstack database instance list
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ | ID | Name | Datastore | Datastore Version | Status | Addresses | Flavor ID | Size | Region |
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ | 55411e95-1670-497f-8d92-0179f3b4fdd4 | redis_test | redis | 3.2.6 | HEALTHY | 10.1.0.25 | 6 | 1 | RegionOne |
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
#. **Check if target version is available**
@@ -54,36 +53,42 @@ Upgrading datastore
.. code-block:: console
- $openstack datastore version list redis
- +--------------------------------------+-------+
- | ID | Name |
- +--------------------------------------+-------+
- | 483debec-b7c3-4167-ab1d-1765795ed7eb | 3.2.6 |
- | 507f666e-193c-4194-9d9d-da8342dcb4f1 | 3.2.7 |
- +--------------------------------------+-------+
+ $ openstack datastore version list redis
+ +--------------------------------------+-------+
+ | ID | Name |
+ +--------------------------------------+-------+
+ | 483debec-b7c3-4167-ab1d-1765795ed7eb | 3.2.6 |
+ | 507f666e-193c-4194-9d9d-da8342dcb4f1 | 3.2.7 |
+ +--------------------------------------+-------+
#. **Run upgrade**
- Use :command:`openstack database instance` command to upgrade your
- datastore for the selected instance.
+ Use :command:`openstack database instance upgrade` command to upgrade the
+ datastore of the instance.
.. code-block:: console
- $openstack database instance 55411e95-1670-497f-8d92-0179f3b4fdd4 3.2.7
+ $ openstack database instance 55411e95-1670-497f-8d92-0179f3b4fdd4 3.2.7
-#. **Wait until status changes from UPGRADE to ACTIVE**
+#. **Wait until status changes from UPGRADE to HEALTHY**
- You can use :command:`openstack database instance list` to check the
+ Use :command:`openstack database instance list` to check the
current status.
.. code-block:: console
- $openstack database instance list
- +--------------------------------------+------------+-----------+-------------------+---------+-----------+------+-----------+
- | ID | Name | Datastore | Datastore Version | Status | Flavor ID | Size | Region |
- +--------------------------------------+------------+-----------+-------------------+---------+-----------+------+-----------+
- | 55411e95-1670-497f-8d92-0179f3b4fdd4 | redis_test | redis | 3.2.7 | UPGRADE | 6 | 5 | RegionOne |
- +--------------------------------------+------------+-----------+-------------------+---------+-----------+------+-----------+
+ $ openstack database instance list
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ | ID | Name | Datastore | Datastore Version | Status | Addresses | Flavor ID | Size | Region |
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ | 55411e95-1670-497f-8d92-0179f3b4fdd4 | redis_test | redis | 3.2.7 | UPGRADE | 10.1.0.25 | 6 | 5 | RegionOne |
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ $ openstack database instance list
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ | ID | Name | Datastore | Datastore Version | Status | Addresses | Flavor ID | Size | Region |
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
+ | 55411e95-1670-497f-8d92-0179f3b4fdd4 | redis_test | redis | 3.2.7 | HEALTHY | 10.1.0.25 | 6 | 5 | RegionOne |
+ +--------------------------------------+------------+-----------+-------------------+---------+-----------+-----------+------+-----------+
Other datastores
~~~~~~~~~~~~~~~~
@@ -91,6 +96,6 @@ Other datastores
Upgrade for other datastores works in the same way. Currently Trove
supports upgrades for the following datastores:
-- MySQL,
-- MariaDB,
-- Redis.
+- MySQL
+- MariaDB
+- Redis