diff options
Diffstat (limited to 'doc/source/user/create-db.rst')
| -rw-r--r-- | doc/source/user/create-db.rst | 164 |
1 files changed, 62 insertions, 102 deletions
diff --git a/doc/source/user/create-db.rst b/doc/source/user/create-db.rst index 8be08079..a8a111e1 100644 --- a/doc/source/user/create-db.rst +++ b/doc/source/user/create-db.rst @@ -7,82 +7,32 @@ Assume that you have installed the Database service and populated your data store with images for the type and versions of databases that you want, and that you can create and access a database instance. -This example shows you how to create and access a MySQL 5.7 database. +This example shows you how to create and access a MySQL 5.7.29 database. Create and access a database instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#. **Determine which flavor to use for your database** +#. **Before creating the instance** - When you create a database instance, you must specify a nova flavor. - The flavor indicates various characteristics of the instance, such as - RAM and root volume size. You will need to create or - obtain new nova flavors that work for databases. + * Choose the flavor. A flavor defines RAM and root volume size for the instance. Trove OpenStack CLI provides a command to get a flavor list that are supported to create trove instance. - The first step is to list flavors by using the - :command:`openstack flavor list` command. + .. code-block:: console - .. code-block:: console - - $ openstack flavor list - - Now take a look at the minimum requirements for various database - instances: - - +--------------------+--------------------+--------------------+--------------------+ - | Database | RAM (MB) | Disk (GB) | VCPUs | - +====================+====================+====================+====================+ - | MySQL | 512 | 5 | 1 | - +--------------------+--------------------+--------------------+--------------------+ - | Cassandra | 2048 | 5 | 1 | - +--------------------+--------------------+--------------------+--------------------+ - | MongoDB | 1024 | 5 | 1 | - +--------------------+--------------------+--------------------+--------------------+ - | Redis | 512 | 5 | 1 | - +--------------------+--------------------+--------------------+--------------------+ - - - If you have a custom flavor that meets the needs of the database - that you want to create, proceed to - :ref:`Step 2 <create-database-instance>` and use that flavor. + $ openstack database flavor list - - If your environment does not have a suitable flavor, an - administrative user must create a custom flavor by using the - :command:`openstack flavor create` command. + .. note:: - **MySQL example.** This example creates a flavor that you can use - with a MySQL database. This example has the following attributes: + If creating instance as a replica for the replication cluster, flavor is not needed as it's the same with the replication primary. - - Flavor name: ``mysql_minimum`` + * Choose a neutron network that the instance is allocated IP address from. You can either specify the network ID or the subnet ID, you can even specify the IP address (must be available). + * Choose the volume size. The cinder volume is used as data storage for the database. + * Choose datastore version. - - Flavor ID: You must use an ID that is not already in use. In this - example, IDs 1 through 5 are in use, so use ID ``6``. + .. note:: - - RAM: ``512`` - - - Root volume size in GB: ``5`` - - - Virtual CPUs: ``1`` - - .. code-block:: console + If creating instance as a replica for the replication cluster, datastore is not needed as it's the same with the replication primary. - $ openstack flavor create mysql-minimum --id 6 --ram 512 --disk 5 --vcpus 1 - +----------------------------+---------------+ - | Field | Value | - +----------------------------+---------------+ - | OS-FLV-DISABLED:disabled | False | - | OS-FLV-EXT-DATA:ephemeral | 0 | - | disk | 5 | - | id | 6 | - | name | mysql-minimum | - | os-flavor-access:is_public | True | - | properties | | - | ram | 512 | - | rxtx_factor | 1.0 | - | swap | | - | vcpus | 1 | - +----------------------------+---------------+ - - .. _create-database-instance: + * (Optional) Choose the data source. You can create a new instance by restoring a backup using ``--backup <BACKUP_ID>``, or create a replica instance for a replication cluster using ``--replica-of <PRIMARY_INSTANCE_ID>`` #. **Create a database instance** @@ -90,19 +40,18 @@ Create and access a database instance parameters: - Name of the instance: ``mysql_instance_1`` - - Database flavor: ``6`` + - Database flavor: ``1fb05bb0-4605-48b6-81e6-3d4622e4a330`` - A volume size of ``5`` (5 GB) - A database named ``test`` - The database is based on the ``mysql`` data store and the - ``5.7`` datastore version + ``5.7.29`` datastore version - The ``userA`` user with the ``password`` password. - A Neutron network ``8799cf10-01ef-40e2-b04e-06da7cfa5668`` to allocate the database IP address (for internal access). - Expose the instance to the public via ``--is-public`` (for external - access). Ignore this parameter if you don't want to expose database - service to the public internet. + access). - Only the IP addresses coming from ``202.37.199.1/24`` or ``10.1.0.1/24`` - are allowed to access the database service. + are allowed to access the database. .. code-block:: console @@ -111,54 +60,65 @@ Create and access a database instance --size 5 \ --nic net-id=8799cf10-01ef-40e2-b04e-06da7cfa5668 \ --databases test --users userA:password \ - --datastore mysql --datastore-version 5.7 \ + --datastore mysql --datastore-version 5.7.29 \ --is-public \ --allowed-cidr 10.1.0.1/24 \ --allowed-cidr 202.37.199.1/24 - +-------------------+--------------------------------------+ - | Field | Value | - +-------------------+--------------------------------------+ - | created | 2019-09-11T09:19:18 | - | datastore | mysql | - | datastore_version | 5.7 | - | flavor | 6 | - | id | 4bca2f27-f986-419e-ab4a-df1db399d590 | - | name | mysql_instance_1 | - | region | RegionOne | - | status | BUILD | - | updated | 2019-09-11T09:19:18 | - | volume | 5 | - +-------------------+--------------------------------------+ + +--------------------------+--------------------------------------+ + | Field | Value | + +--------------------------+--------------------------------------+ + | allowed_cidrs | [10.1.0.1/24, 202.37.199.1/24] | + | created | 2020-12-08T21:00:19 | + | datastore | mysql | + | datastore_version | 5.7.29 | + | datastore_version_number | 5.7.29 | + | flavor | 1fb05bb0-4605-48b6-81e6-3d4622e4a330 | + | id | ad40cf6c-6532-4a22-a3f3-7364f0f04a0f | + | name | mysql_instance_1 | + | operating_status | | + | public | True | + | region | RegionOne | + | service_status_updated | 2020-12-08T21:00:19 | + | status | BUILD | + | updated | 2020-12-08T21:00:19 | + | volume | 5 | + +--------------------------+--------------------------------------+ #. **Get the IP address of the database instance** - Both internal and external IP addresses can be shown by running: + Wait until the instance ``operating_status`` changes to HEALTHY before getting IP address to access the database: .. code-block:: console - $ openstack database instance show 4bca2f27-f986-419e-ab4a-df1db399d590 - +-------------------+--------------------------------------+ - | Field | Value | - +-------------------+--------------------------------------+ - | created | 2019-09-11T07:14:37 | - | datastore | mysql | - | datastore_version | 5.7 | - | flavor | 6 | - | id | 4bca2f27-f986-419e-ab4a-df1db399d590 | - | ip | 10.1.0.14, 172.24.5.15 | - | name | mysql_instance_1 | - | region | RegionOne | - | status | ACTIVE | - | updated | 2019-09-11T07:14:47 | - | volume | 5 | - | volume_used | 0.12 | - +-------------------+--------------------------------------+ + $ openstack database instance show ad40cf6c-6532-4a22-a3f3-7364f0f04a0f + +--------------------------+----------------------------------------------------------------------------------------------+ + | Field | Value | + +--------------------------+----------------------------------------------------------------------------------------------+ + | addresses | [{'address': '10.0.0.59', 'type': 'private'}, {'address': '172.24.4.242', 'type': 'public'}] | + | allowed_cidrs | [] | + | created | 2020-12-08T21:00:20 | + | datastore | mysql | + | datastore_version | 5.7.29 | + | datastore_version_number | 5.7.29 | + | flavor | 1fb05bb0-4605-48b6-81e6-3d4622e4a330 | + | id | ad40cf6c-6532-4a22-a3f3-7364f0f04a0f | + | ip | 10.0.0.59, 172.24.4.242 | + | name | mysql_instance_1 | + | operating_status | HEALTHY | + | public | True | + | region | RegionOne | + | service_status_updated | 2020-12-08T21:05:51 | + | status | ACTIVE | + | updated | 2020-12-08T21:04:39 | + | volume | 5 | + | volume_used | 0.2 | + +--------------------------+----------------------------------------------------------------------------------------------+ #. **Access the new database** You can now access the new database you just created by using typical database access commands. In this MySQL example, replace - ``IP_ADDRESS`` with either 10.1.0.14 or 172.24.5.15 according to where the + ``IP_ADDRESS`` with either 10.0.0.59 or 172.24.4.242 according to where the command is running. Make sure your IP address is in the allowed CIDRs specified in the above command. |