summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLingxian Kong <anlin.kong@gmail.com>2020-11-21 23:58:41 +1300
committerLingxian Kong <anlin.kong@gmail.com>2020-11-22 09:55:47 +1300
commitc9e27cab760bd16dc73b6813297210793b8f11a2 (patch)
treeae9743e1a9e4774b4f9488f49f6221b7d67fac46 /doc
parent589e4ec45a3d24eeb40d16b0bfca573152b099f8 (diff)
downloadtrove-c9e27cab760bd16dc73b6813297210793b8f11a2.tar.gz
[Doc] Support datastore version number
Story: 2008358 Task: 41264 Change-Id: I45ba63454f5b9c29d95c67e49b44f8233dda18fb
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/datastore.rst14
-rw-r--r--doc/source/admin/run_trove_in_production.rst3
2 files changed, 11 insertions, 6 deletions
diff --git a/doc/source/admin/datastore.rst b/doc/source/admin/datastore.rst
index 98f0922e..ddac4b8d 100644
--- a/doc/source/admin/datastore.rst
+++ b/doc/source/admin/datastore.rst
@@ -16,9 +16,9 @@ database, Trove could support 5.7.29, 5.7.30 or 5.8, etc.
.. note::
- Starting from Victoria, the datastore version name must be the same with the
- image tag of the specific database. To support MySQL 5.7.29, a new datastore
- version named 5.7.29 based on `mysql docker image
+ Starting from Victoria, the datastore version number must be the same with
+ the image tag of the specific database. To support MySQL 5.7.29, a new
+ datastore version with version number 5.7.29 based on `mysql docker image
<https://hub.docker.com/_/mysql?tab=tags&name=5.7.29>`_ needs to be created.
A datastore version is always associated with a Glance image, either by image
@@ -32,7 +32,8 @@ Create datastore version
~~~~~~~~~~~~~~~~~~~~~~~~
When creating a datastore version, Trove will create the datastore first if it
-doesn't exist.
+doesn't exist. Different datastore versions can have the same name but
+different version numbers, or same version number but different names.
When using image tags, make sure the image with the tags exists before creating
the datastore version.
@@ -52,6 +53,8 @@ To create a datastore version:
#. Register image with Image service
You need to register your guest image with the Image service as cloud admin.
+ In this example, the image is assigned tags that will be used when creating
+ datastore version.
.. code-block:: console
@@ -69,7 +72,8 @@ To create a datastore version:
openstack datastore version create 5.7.29 mysql mysql "" \
--image-tags trove,mysql \
- --active --default
+ --active --default \
+ --version-number 5.7.29
#. Load validation rules for configuration groups
diff --git a/doc/source/admin/run_trove_in_production.rst b/doc/source/admin/run_trove_in_production.rst
index 5bdf36d9..5cfde6b3 100644
--- a/doc/source/admin/run_trove_in_production.rst
+++ b/doc/source/admin/run_trove_in_production.rst
@@ -334,7 +334,8 @@ Command examples:
$ # Creating datastore 'mysql' and datastore version 5.7.29.
$ openstack datastore version create 5.7.29 mysql mysql "" \
--image-tags trove,mysql \
- --active --default
+ --active --default \
+ --version-number 5.7.29
$ # Register configuration parameters for the datastore version
$ trove-manage db_load_datastore_config_parameters mysql 5.7.29 ${trove_repo_dir}}/trove/templates/mysql/validation-rules.json