From 71b09bae42175ddd76a81f552ef820b722342b87 Mon Sep 17 00:00:00 2001 From: Dariusz Krol Date: Mon, 11 Feb 2019 22:41:59 +0100 Subject: [PATCH] User guide update to use Openstack client syntax Change-Id: I13f80047cf1fb64f3452f20df58cc3cf21a17456 Signed-off-by: Dariusz Krol Signed-off-by: Dariusz Krol --- doc/source/user/backup-db-incremental.rst | 10 +++--- doc/source/user/backup-db.rst | 40 +++++++++++------------ doc/source/user/create-db.rst | 10 +++--- doc/source/user/manage-db-config.rst | 28 ++++++++-------- doc/source/user/set-up-clustering.rst | 24 +++++++------- doc/source/user/set-up-replication.rst | 19 ++++++----- 6 files changed, 66 insertions(+), 65 deletions(-) diff --git a/doc/source/user/backup-db-incremental.rst b/doc/source/user/backup-db-incremental.rst index cd08792532..8ad0bbb5dd 100644 --- a/doc/source/user/backup-db-incremental.rst +++ b/doc/source/user/backup-db-incremental.rst @@ -29,7 +29,7 @@ Create and use incremental backups #. **Create your first incremental backup** - Use the :command:`trove backup-create` command and specify: + Use the :command:`openstack database backup create` command and specify: - The ``INSTANCE_ID`` of the database instance you are doing the incremental backup for (in this example, @@ -43,7 +43,7 @@ Create and use incremental backups .. code-block:: console - $ trove backup-create INSTANCE_ID backup1.1 --parent BACKUP_ID + $ openstack database backup create INSTANCE_ID backup1.1 --parent BACKUP_ID +-------------+--------------------------------------+ | Property | Value | @@ -73,7 +73,7 @@ Create and use incremental backups .. code-block:: console - $ trove backup-create INSTANCE_ID backup1.2 --parent BACKUP_ID + $ openstack database backup create INSTANCE_ID backup1.2 --parent BACKUP_ID +-------------+--------------------------------------+ | Property | Value | @@ -94,7 +94,7 @@ Create and use incremental backups Now assume that your ``guest1`` database instance is damaged and you need to restore it from your incremental backups. In this example, - you use the :command:`trove create` command to create a new database + you use the :command:`openstack database instance create` command to create a new database instance called ``guest2``. To incorporate your incremental backups, you simply use the @@ -105,7 +105,7 @@ Create and use incremental backups .. code-block:: console - $ trove create guest2 10 --size 1 --backup BACKUP_ID + $ openstack database instance create guest2 10 --size 1 --backup BACKUP_ID +-------------------+-----------------------------------------------------------+ | Property | Value | diff --git a/doc/source/user/backup-db.rst b/doc/source/user/backup-db.rst index cb7f26f2b2..7a1331568e 100644 --- a/doc/source/user/backup-db.rst +++ b/doc/source/user/backup-db.rst @@ -26,11 +26,11 @@ This example shows you how to back up and restore a MySQL database. - Users: The ``user1`` user with the ``password`` password First, get the ID of the ``guest1`` database instance by using the - :command:`trove list` command: + :command:`openstack database instance list` command: .. code-block:: console - $ trove list + $ openstack database instance list +--------------------------------------+--------+-----------+-------------------+--------+-----------+------+ | id | name | datastore | datastore_version | status | flavor_id | size | @@ -38,7 +38,7 @@ This example shows you how to back up and restore a MySQL database. | 97b4b853-80f6-414f-ba6f-c6f455a79ae6 | guest1 | mysql | mysql-5.5 | ACTIVE | 10 | 2 | +--------------------------------------+--------+-----------+-------------------+--------+-----------+------+ - Back up the database instance by using the :command:`trove backup-create` + Back up the database instance by using the :command:`openstack database backup create` command. In this example, the backup is called ``backup1``. In this example, replace ``INSTANCE_ID`` with ``97b4b853-80f6-414f-ba6f-c6f455a79ae6``: @@ -51,7 +51,7 @@ This example shows you how to back up and restore a MySQL database. .. code-block:: console - $ trove backup-create INSTANCE_ID backup1 + $ openstack database backup create INSTANCE_ID backup1 +-------------+--------------------------------------+ | Property | Value | @@ -71,12 +71,12 @@ This example shows you how to back up and restore a MySQL database. Note that the command returns both the ID of the original instance (``instance_id``) and the ID of the backup artifact (``id``). - Later on, use the :command:`trove backup-list` command to get this + Later on, use the :command:`openstack database backup list` command to get this information: .. code-block:: console - $ trove backup-list + $ openstack database backup list +--------------------------------------+--------------------------------------+---------+-----------+-----------+---------------------+ | id | instance_id | name | status | parent_id | updated | +--------------------------------------+--------------------------------------+---------+-----------+-----------+---------------------+ @@ -84,12 +84,12 @@ This example shows you how to back up and restore a MySQL database. +--------------------------------------+--------------------------------------+---------+-----------+-----------+---------------------+ You can get additional information about the backup by using the - :command:`trove backup-show` command and passing in the ``BACKUP_ID``, + :command:`openstack database backup show` command and passing in the ``BACKUP_ID``, which is ``8af30763-61fd-4aab-8fe8-57d528911138``. .. code-block:: console - $ trove backup-show BACKUP_ID + $ openstack database backup show BACKUP_ID +-------------+----------------------------------------------------+ | Property | Value | @@ -109,7 +109,7 @@ This example shows you how to back up and restore a MySQL database. #. **Restore a database instance** Now assume that your ``guest1`` database instance is damaged and you - need to restore it. In this example, you use the :command:`trove create` + need to restore it. In this example, you use the :command:`openstack database instance create` command to create a new database instance called ``guest2``. - You specify that the new ``guest2`` instance has the same flavor @@ -123,7 +123,7 @@ This example shows you how to back up and restore a MySQL database. .. code-block:: console - $ trove create guest2 10 --size 2 --backup BACKUP_ID + $ openstack database instance create guest2 10 --size 2 --backup BACKUP_ID +-------------------+----------------------------------------------+ | Property | Value | @@ -148,7 +148,7 @@ This example shows you how to back up and restore a MySQL database. .. code-block:: console - $ trove list + $ openstack database instance list +-----------+--------+-----------+-------------------+--------+-----------+------+ | id | name | datastore | datastore_version | status | flavor_id | size | @@ -157,13 +157,13 @@ This example shows you how to back up and restore a MySQL database. | ac7...04b | guest2 | mysql | mysql-5.5 | ACTIVE | 10 | 2 | +-----------+--------+-----------+-------------------+--------+-----------+------+ - Use the :command:`trove show` command to display information about the new + Use the :command:`openstack database instance show` command to display information about the new guest2 instance. Pass in guest2's ``INSTANCE_ID``, which is ``ac7a2b35-a9b4-4ff6-beac-a1bcee86d04b``. .. code-block:: console - $ trove show INSTANCE_ID + $ openstack database instance INSTANCE_ID +-------------------+--------------------------------------+ | Property | Value | @@ -184,12 +184,12 @@ This example shows you how to back up and restore a MySQL database. Note that the data store, flavor ID, and volume size have the same values as in the original ``guest1`` instance. - Use the :command:`trove database-list` command to check that the original + Use the :command:`openstack database db list` command to check that the original databases (``db1`` and ``db2``) are present on the restored instance. .. code-block:: console - $ trove database-list INSTANCE_ID + $ openstack database db list INSTANCE_ID +--------------------+ | name | @@ -200,12 +200,12 @@ This example shows you how to back up and restore a MySQL database. | test | +--------------------+ - Use the :command:`trove user-list` command to check that the original user + Use the :command:`openstack database user list` command to check that the original user (``user1``) is present on the restored instance. .. code-block:: console - $ trove user-list INSTANCE_ID + $ openstack database user list INSTANCE_ID +--------+------+-----------+ | name | host | databases | @@ -219,14 +219,14 @@ This example shows you how to back up and restore a MySQL database. database instance that they can now access ``guest2``. Provide them with ``guest2``'s name, IP address, and any other information they might need. (You can get this information by using the - :command:`trove show` command.) + :command:`openstack database instance show` command.) #. **Clean up** At this point, you might want to delete the disabled ``guest1`` - instance, by using the :command:`trove delete` command. + instance, by using the :command:`openstack database instance delete` command. .. code-block:: console - $ trove delete INSTANCE_ID + $ openstack database instance delete INSTANCE_ID diff --git a/doc/source/user/create-db.rst b/doc/source/user/create-db.rst index 30c6cd27ac..a8b0c484f5 100644 --- a/doc/source/user/create-db.rst +++ b/doc/source/user/create-db.rst @@ -106,7 +106,7 @@ Create and access a database .. code-block:: console - $ trove create mysql_instance_1 6 --size 5 --databases myDB \ + $ openstack database instance create mysql_instance_1 6 --size 5 --databases myDB \ --users userA:password --datastore_version mysql-5.5 \ --datastore mysql +-------------------+---------------------------------------------------------------------------------------t-----------------------------------------------------------------------------------------------------------------+ @@ -125,12 +125,12 @@ Create and access a database #. **Get the IP address of the database instance** - First, use the :command:`trove list` command to list all instances and + First, use the :command:`openstack database instance list` command to list all instances and their IDs: .. code-block:: console - $ trove list + $ openstack database instance list +--------------------------------------+------------------+-----------+-------------------+--------+-----------+------+ | id | name | datastore | datastore_version | status | flavor_id | size | +--------------------------------------+------------------+-----------+-------------------+--------+-----------+------+ @@ -139,13 +139,13 @@ Create and access a database This command returns the instance ID of your new instance. - You can now pass in the instance ID with the :command:`trove show` command + You can now pass in the instance ID with the :command:`openstack database instance show` command to get the IP address of the instance. In this example, replace ``INSTANCE_ID`` with ``5599dad6-731e-44df-bb60-488da3da9cfe``. .. code-block:: console - $ trove show INSTANCE_ID + $ openstack database instance show INSTANCE_ID +-------------------+--------------------------------------+ | Property | Value | diff --git a/doc/source/user/manage-db-config.rst b/doc/source/user/manage-db-config.rst index d9f4711d92..f8b1d72b0d 100644 --- a/doc/source/user/manage-db-config.rst +++ b/doc/source/user/manage-db-config.rst @@ -27,7 +27,7 @@ Bulk-configure a database or databases .. code-block:: console - $ trove datastore-version-list mysql + $ openstack datastore version list mysql +--------------------------------------+-----------+ | id | name | @@ -36,12 +36,12 @@ Bulk-configure a database or databases +--------------------------------------+-----------+ Pass in the data store version ID with the - :command:`trove configuration-parameter-list` command to get the available + :command:`openstack database configuration parameter list` command to get the available options: .. code-block:: console - $ trove configuration-parameter-list DATASTORE_VERSION_ID + $ openstack database configuration parameter list DATASTORE_VERSION_ID +--------------------------------+---------+---------+----------------------+------------------+ | name | type | min | max | restart_required | @@ -82,7 +82,7 @@ Bulk-configure a database or databases | wait_timeout | integer | 1 | 31536000 | False | +--------------------------------+---------+---------+----------------------+------------------+ - In this example, the :command:`trove configuration-parameter-list` command + In this example, the :command:`openstack database configuration parameter list` command returns a list of options that work with MySQL 5.5. #. **Create a configuration group** @@ -91,12 +91,12 @@ Bulk-configure a database or databases pairs. Each pair consists of a configuration option and its value. You can create a configuration group by using the - :command:`trove configuration-create` command. The general syntax + :command:`openstack database configuration create` command. The general syntax for this command is: .. code-block:: console - $ trove configuration-create NAME VALUES --datastore DATASTORE_NAME + $ openstack database configuration create NAME VALUES --datastore DATASTORE_NAME - *NAME*. The name you want to use for this group. @@ -116,7 +116,7 @@ Bulk-configure a database or databases .. code-block:: console - $ trove configuration-create group1 '{"sync_binlog" : 1}' --datastore mysql + $ openstack database configuration create group1 '{"sync_binlog" : 1}' --datastore mysql +----------------------+--------------------------------------+ | Property | Value | @@ -154,14 +154,14 @@ Bulk-configure a database or databases You can change a database's configuration by attaching a configuration group to a database instance. You do this by using the - :command:`trove configuration-attach` command and passing in the ID of the + :command:`openstack database configuration attach` command and passing in the ID of the database instance and the ID of the configuration group. Get the ID of the database instance: .. code-block:: console - $ trove list + $ openstack database instance list +-------------+------------------+-----------+-------------------+--------+-----------+------+ | id | name | datastore | datastore_version | status | flavor_id | size | @@ -173,7 +173,7 @@ Bulk-configure a database or databases .. code-block:: console - $ trove configuration-list + $ openstack database configuration list +-------------+--------+-------------+---------------------+ | id | name | description |datastore_version_id | @@ -191,7 +191,7 @@ Bulk-configure a database or databases .. code-block:: console - $ trove configuration-attach DB_INSTANCE_ID CONFIG_GROUP_ID + $ openstack database configuration attach DB_INSTANCE_ID CONFIG_GROUP_ID #. **Re-examine the database configuration** @@ -225,15 +225,15 @@ cloud configuration, on the fly, on a massive scale. features for working with configuration groups. You can: - Disassociate a configuration group from a database instance, using - the :command:`trove configuration-detach` command. + the :command:`openstack database configuration detach` command. - Modify a configuration group on the fly, using the :command:`trove configuration-patch` command. - Find out what instances are using a configuration group, using the - :command:`trove configuration-instances` command. + :command:`openstack database configuration instances` command. - Delete a configuration group, using the - :command:`trove configuration-delete` command. You might want to + :command:`openstack database configuration delete` command. You might want to do this if no instances use a group. diff --git a/doc/source/user/set-up-clustering.rst b/doc/source/user/set-up-clustering.rst index 5097a5bfdf..e5a0caa3d8 100644 --- a/doc/source/user/set-up-clustering.rst +++ b/doc/source/user/set-up-clustering.rst @@ -36,7 +36,7 @@ Set up clustering #. **Create a cluster** - Create a cluster by using the :command:`trove cluster-create` command. This + Create a cluster by using the :command:`openstack database cluster create` command. This command creates a one-shard cluster. Pass in: - The name of the cluster. @@ -52,7 +52,7 @@ Set up clustering .. code-block:: console - $ trove cluster-create cluster1 mongodb "2.4" \ + $ openstack database cluster create cluster1 mongodb "2.4" \ --instance flavor=7,volume=2 --instance flavor=7,volume=2 \ --instance flavor=7,volume=2 +-------------------+--------------------------------------+ @@ -71,15 +71,15 @@ Set up clustering #. **Display cluster information** Display information about a cluster by using the - :command:`trove cluster-show` command. Pass in the ID of the cluster. + :command:`openstack database cluster show` command. Pass in the ID of the cluster. The cluster ID displays when you first create a cluster. (If you need - to find it later on, use the :command:`trove cluster-list` command to list + to find it later on, use the :command:`openstack database cluster list` command to list the names and IDs of all the clusters in your system.) .. code-block:: console - $ trove cluster-show CLUSTER_ID + $ openstack database cluster show CLUSTER_ID +-------------------+--------------------------------------+ | Property | Value | +-------------------+--------------------------------------+ @@ -97,7 +97,7 @@ Set up clustering .. note:: - **Your application connects to this IP address.** The :command:`trove cluster-show` + **Your application connects to this IP address.** The :command:`openstack database cluster show` command displays the IP address of the query router. This is the IP address your application uses to retrieve data from the database. @@ -105,11 +105,11 @@ Set up clustering #. **List cluster instances** List the instances in a cluster by using the - :command:`trove cluster-instances` command. + :command:`openstack database cluster list instances` command. .. code-block:: console - $ trove cluster-instances CLUSTER_ID + $ openstack database cluster list instances CLUSTER_ID +--------------------------------------+----------------+-----------+------+ | ID | Name | Flavor ID | Size | +--------------------------------------+----------------+-----------+------+ @@ -139,11 +139,11 @@ Set up clustering #. **List clusters** List all the clusters in your system, using the - :command:`trove cluster-list` command. + :command:`openstack database cluster list` command. .. code-block:: console - $ trove cluster-list + $ openstack database cluster list +--------------------------------------+----------+-----------+-------------------+-----------+ | ID | Name | Datastore | Datastore Version | Task Name | +--------------------------------------+----------+-----------+-------------------+-----------+ @@ -153,11 +153,11 @@ Set up clustering #. **Delete a cluster** - Delete a cluster, using the :command:`trove cluster-delete` command. + Delete a cluster, using the :command:`openstack database cluster delete` command. .. code-block:: console - $ trove cluster-delete CLUSTER_ID + $ openstack database cluster delete CLUSTER_ID Query routers and config servers -------------------------------- diff --git a/doc/source/user/set-up-replication.rst b/doc/source/user/set-up-replication.rst index 18610471d0..1f6e0b0ca3 100644 --- a/doc/source/user/set-up-replication.rst +++ b/doc/source/user/set-up-replication.rst @@ -26,7 +26,7 @@ Set up replication .. code-block:: console - $ trove list + $ openstack database instance list +-----------+------------+-----------+-------------------+--------+-----------+------+ | id | name | datastore | datastore_version | status | flavor_id | size | +-----------+------------+-----------+-------------------+--------+-----------+------+ @@ -37,25 +37,26 @@ Set up replication Create a new instance that will be a replica of the original instance. You do this by passing in the ``--replica_of`` option with - the :command:`trove create` command. This example creates a replica + the :command:`openstack database instance create` command. This example creates a replica called ``replica_1``. ``replica_1`` is a replica of the original instance, ``base_1``: .. code-block:: console - $ trove create replica_1 6 --size=5 --datastore_version mysql-5.5 \ + $ openstack database instance create replica_1 6 --size=5 \ + --datastore_version mysql-5.5 \ --datastore mysql --replica_of ID_OF_ORIGINAL_INSTANCE #. **Verify replication status** - Pass in ``replica_1``'s instance ID with the :command:`trove show` command + Pass in ``replica_1``'s instance ID with the :command:`openstack database instance show` command to verify that the newly created ``replica_1`` instance is a replica of the original ``base_1``. Note that the ``replica_of`` property is set to the ID of ``base_1``. .. code-block:: console - $ trove show INSTANCE_ID_OF_REPLICA_1 + $ openstack database instance show INSTANCE_ID_OF_REPLICA_1 +-------------------+--------------------------------------+ | Property | Value | +-------------------+--------------------------------------+ @@ -71,14 +72,14 @@ Set up replication | volume | 5 | +-------------------+--------------------------------------+ - Now pass in ``base_1``'s instance ID with the :command:`trove show` command + Now pass in ``base_1``'s instance ID with the :command:`openstack database instance show` command to list the replica(s) associated with the original instance. Note that the ``replicas`` property is set to the ID of ``replica_1``. If there are multiple replicas, they appear as a comma-separated list. .. code-block:: console - $ trove show INSTANCE_ID_OF_BASE_1 + $ openstack database instance show INSTANCE_ID_OF_BASE_1 +-------------------+--------------------------------------+ | Property | Value | +-------------------+--------------------------------------+ @@ -102,8 +103,8 @@ Set up replication replica becomes a standalone database instance. You can then take the new standalone instance and create a new replica of that instance. - You detach a replica using the :command:`trove detach-replica` command: + You detach a replica using the :command:`openstack database instance detach replica` command: .. code-block:: console - $ trove detach-replica INSTANCE_ID_OF_REPLICA + $ openstack database instance detach replica INSTANCE_ID_OF_REPLICA