diff options
author | Lingxian Kong <anlin.kong@gmail.com> | 2021-10-06 13:16:40 +1300 |
---|---|---|
committer | Lingxian Kong <anlin.kong@gmail.com> | 2021-10-06 13:16:40 +1300 |
commit | be86b79119d16ee77f596172f43b0c97cb2617bd (patch) | |
tree | 8bbc4fa4117cabdf5a8f9ef64c9214b1390bcb0b /doc | |
parent | f961fa0c4f4b7f25f04390314316c2f234a7b593 (diff) | |
download | trove-be86b79119d16ee77f596172f43b0c97cb2617bd.tar.gz |
[Doc] Describe the usage of root_on_create option
Change-Id: I8a64f3dfaae824d03927d291d3510ffd04fc1995
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/user/manage-db-and-users.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/source/user/manage-db-and-users.rst b/doc/source/user/manage-db-and-users.rst index ad25b1d8..e6be85d6 100644 --- a/doc/source/user/manage-db-and-users.rst +++ b/doc/source/user/manage-db-and-users.rst @@ -6,12 +6,17 @@ Assume that you installed Trove service and uploaded images with datastore of your choice. This section shows how to manage users and databases in a MySQL 5.7 instance. -.. warning:: +Currently, the Database and User API is only supported by mysql datastore. - Currently, the Database and User API is only supported by mysql datastore. - For others, the recommended way is to get root password (``POST - /v1.0/{project_id}/instances/{instance_id}/root``) and communicate with the - database service directly for database and user management. +For database user management, there are two approaches: + +1. If the ``root_on_create`` option is enabled for the datastore in trove + service config file, the root user password is returned after creating + instance, which can be used directly to access the database. +2. If ``root_on_create=False``, the recommended way is to get root password + (``POST /v1.0/{project_id}/instances/{instance_id}/root`` or ``openstack + database root enable`` in CLI) and communicate with the database service + directly for database and user management. Manage root user ~~~~~~~~~~~~~~~~ @@ -32,7 +37,7 @@ further database operations. If needed, ``openstack database root disable <instance_id>`` command could disable the root user. -Database and User management via Trove API +Database and User management via Trove CLI ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Trove provides API to manage users and databases for mysql datastore. |