commit e21f90a0254480ff06d919c5bc7e6c452c6665e2 Author: Lingxian Kong Date: Tue Oct 13 22:22:40 2020 +1300 [Doc] datastore guide Change-Id: Id2ab6f94a372395563eef12a6fd5f0682eb94777 diff --git a/doc/source/admin/datastore.rst b/doc/source/admin/datastore.rst index 59e2b26..98f0922 100644 --- a/doc/source/admin/datastore.rst +++ b/doc/source/admin/datastore.rst @@ -7,12 +7,20 @@ Datastore Introduction ~~~~~~~~~~~~ -A datastore is typically created as a type of database. For each datastore, -there could be multiple datastore versions. For example, for MySQL database, -Trove could support 5.7.29, 5.7.30 or 5.8. - Admin user needs to create datastore and its versions as required. +A datastore is typically created as a type of database, e.g. the cloud admin +could create 2 datastores for MySQL and PostgreSQL, separately. For each +datastore, there could be multiple datastore versions. For example, for MySQL +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 + `_ needs to be created. + A datastore version is always associated with a Glance image, either by image ID or image tags. If the image ID is not provided, the image can be retrieved by the image tags. The tags are used for filtering as a whole rather than @@ -119,21 +127,21 @@ Sometimes, it's needed to make a datastore version invisible to the cloud users, e.g when a datastore version is deprecated or creating a datastore version for testing purpose, to do that: - .. code-block:: console +.. code-block:: console - $ openstack datastore version set --disable + $ openstack datastore version set --disable Replace image ID with tags ~~~~~~~~~~~~~~~~~~~~~~~~~~ -For datastore versions what are created using image ID, it's easy to switch to +For datastore versions that are created using image ID, it's easy to switch to image tags without affecting the existing instances. New instances will be created by the image ID (the most recently uploaded) that getting from Glance using image tags. To do that, as the cloud admin user: - .. code-block:: console +.. code-block:: console - $ openstack datastore version set --image-tags trove,mysql + $ openstack datastore version set --image-tags trove,mysql Ignoring ``--image`` means removing the image ID from the datastore version if it's associated.