dadrobna/gaussdb-mysql
1
0
Fork 0
forked from docs/gaussdb-mysql
Code Pull Requests Activity

Compare commits

base: dadrobna:main
Branches Tags
dadrobna:main
dadrobna:propose-gaussdb_mysql_api-ref-1162
dadrobna:propose-gaussdb_mysql_umn-1161
dadrobna:propose-gaussdb_mysql_umn-1090
dadrobna:propose-gaussdb_mysql_api-ref-1089
dadrobna:propose-gaussdb_mysql_api-ref-1067
dadrobna:zuul-tox-update
dadrobna:update_config_pdf
dadrobna:propose-gaussdb_mysql_umn-963
dadrobna:minify_sphinx_gitea
dadrobna:minify_sphinx_internal
dadrobna:propose-gaussdb_mysql_umn-943
dadrobna:propose-gaussdb_mysql_api-ref-942
dadrobna:propose-gaussdb_mysql_api-ref-928
dadrobna:propose-gaussdb_mysql_api-ref-926
dadrobna:propose-gaussdb_mysql_umn-834
dadrobna:propose-gaussdb_mysql_api-ref-834
dadrobna:propose-gaussdb_mysql_umn-833
dadrobna:propose-gaussdb_mysql_api-ref-833
dadrobna:constraints
dadrobna:propose-gaussdb_mysql_api-ref-815
dadrobna:propose-gaussdb_mysql_api-ref-546
dadrobna:propose-gaussdb_mysql_umn-769
dadrobna:propose-gaussdb_mysql_umn-773
dadrobna:propose-gaussdb_mysql_api-ref-773
dadrobna:propose-gaussdb_mysql_api-ref-769
dadrobna:service_based_view
dadrobna:propose-gaussdb_mysql_umn-569
dadrobna:propose-gaussdb_mysql_api-ref-569
dadrobna:tox4-cleanup
dadrobna:tox4
dadrobna:propose-gaussdb_mysql_umn-497
dadrobna:propose-gaussdb_mysql_api-ref-497
dadrobna:propose-gaussdb_mysql_umn-270
dadrobna:propose-gaussdb_mysql_api-ref-271
dadrobna:x4
dadrobna:x2
dadrobna:propose-gaussdb_mysql_umn-412
dadrobna:propose-gaussdb_mysql_api-ref-412
dadrobna:confpy-2
dadrobna:propose-gaussdb_mysql_umn-371
dadrobna:propose-gaussdb_mysql_api-ref-371
dadrobna:zuul
dadrobna:propose-gaussdb_mysql_api-ref-199
..
compare: dadrobna:minify_sphinx_internal
Branches Tags
dadrobna:propose-gaussdb_mysql_api-ref-1162
dadrobna:main
dadrobna:propose-gaussdb_mysql_umn-1161
dadrobna:propose-gaussdb_mysql_umn-1090
dadrobna:propose-gaussdb_mysql_api-ref-1089
dadrobna:propose-gaussdb_mysql_api-ref-1067
dadrobna:zuul-tox-update
dadrobna:update_config_pdf
dadrobna:propose-gaussdb_mysql_umn-963
dadrobna:minify_sphinx_gitea
dadrobna:minify_sphinx_internal
dadrobna:propose-gaussdb_mysql_umn-943
dadrobna:propose-gaussdb_mysql_api-ref-942
dadrobna:propose-gaussdb_mysql_api-ref-928
dadrobna:propose-gaussdb_mysql_api-ref-926
dadrobna:propose-gaussdb_mysql_umn-834
dadrobna:propose-gaussdb_mysql_api-ref-834
dadrobna:propose-gaussdb_mysql_umn-833
dadrobna:propose-gaussdb_mysql_api-ref-833
dadrobna:constraints
dadrobna:propose-gaussdb_mysql_api-ref-815
dadrobna:propose-gaussdb_mysql_api-ref-546
dadrobna:propose-gaussdb_mysql_umn-769
dadrobna:propose-gaussdb_mysql_umn-773
dadrobna:propose-gaussdb_mysql_api-ref-773
dadrobna:propose-gaussdb_mysql_api-ref-769
dadrobna:service_based_view
dadrobna:propose-gaussdb_mysql_umn-569
dadrobna:propose-gaussdb_mysql_api-ref-569
dadrobna:tox4-cleanup
dadrobna:tox4
dadrobna:propose-gaussdb_mysql_umn-497
dadrobna:propose-gaussdb_mysql_api-ref-497
dadrobna:propose-gaussdb_mysql_umn-270
dadrobna:propose-gaussdb_mysql_api-ref-271
dadrobna:x4
dadrobna:x2
dadrobna:propose-gaussdb_mysql_umn-412
dadrobna:propose-gaussdb_mysql_api-ref-412
dadrobna:confpy-2
dadrobna:propose-gaussdb_mysql_umn-371
dadrobna:propose-gaussdb_mysql_api-ref-371
dadrobna:zuul
dadrobna:propose-gaussdb_mysql_api-ref-199

1 Commits
main ... minify_sph

Author SHA1 Message Date
Sebastian Gode
aba481bd57 Update tox.ini && conf.py file 
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
 2023-11-06 14:03:25 +00:00
61 changed files with 151 additions and 393 deletions
Show Stats Expand all files Collapse all files

BIN
api-ref/source/_static/images/en-us_image_0000001476990897.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 136 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001477110589.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 51 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001828921437.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 120 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001828922089.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 350 KiB

107
api-ref/source/apis_recommended/backup_management/deleting_a_manual_backup.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis_recommended/backup_management/index.rst
View File

@ -9,7 +9,6 @@ Backup Management
- :ref:`Querying Backups <gaussdb_06_0004>` - :ref:`Querying Backups <gaussdb_06_0004>`
- :ref:`Querying an Automated Backup Policy <gaussdb_06_0005>` - :ref:`Querying an Automated Backup Policy <gaussdb_06_0005>`
- :ref:`Modifying an Automated Backup Policy <gaussdb_06_0006>` - :ref:`Modifying an Automated Backup Policy <gaussdb_06_0006>`
- :ref:`Deleting a Manual Backup <deletegaussmysqlbackup>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -19,4 +18,3 @@ Backup Management
querying_backups querying_backups
querying_an_automated_backup_policy querying_an_automated_backup_policy
modifying_an_automated_backup_policy modifying_an_automated_backup_policy
deleting_a_manual_backup

52
api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst
View File

@ -30,29 +30,35 @@ GET /v3/{project_id}/instances
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+================+===========+=========+==========================================================================================================================================================================================================================================================================================================+ +=================+=================+=================+==========================================================================================================================================================================================================================================================================================================+
| id | No | String | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). | | id | No | String | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | No | String | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). | | name | No | String | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | No | String | DB instance type to be queried. Currently, its value can only be **Cluster**. | | type | No | String | DB instance type to be queried. Currently, its value can only be **Cluster**. |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. | | datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | No | String | VPC ID. | | vpc_id | No | String | VPC ID. |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | |
| subnet_id | No | String | Network ID of the subnet. | | | | | - Method 1: Log in to VPC console and view the VPC ID in the VPC details. |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | - Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*. |
| private_ip | No | String | Private IP address. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | subnet_id | No | String | Network ID of the subnet. |
| offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. | | | | | |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | - Method 1: Log in to VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. |
| limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | | | | | - Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the *Virtual Private Cloud API Reference*. |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | String | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship. | | private_ip | No | String | Private IP address. |
+----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | String | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

5
api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst
View File

@ -13,11 +13,6 @@ This API is used to configure resource quotas for a specified enterprise project
- Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
- Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
Precautions
-----------
Before using this API, ensure that the enterprise project has been enabled and you have the **gaussdb:quota:modify** permission.
URI URI
--- ---

5
api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst
View File

@ -13,11 +13,6 @@ This API is used to modify the resource quota of a specified enterprise project.
- Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
- Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
Precautions
-----------
Before using this API, ensure that the enterprise project has been enabled and you have the **gaussdb:quota:modify** permission.
URI URI
--- ---

2
api-ref/source/appendix/obtaining_a_project_id.rst
View File

@ -60,7 +60,7 @@ Obtain a Project ID from the Console
On the **My Credentials** page, view project IDs in the project list. On the **My Credentials** page, view project IDs in the project list.
.. figure:: /_static/images/en-us_image_0000001828922089.png .. figure:: /_static/images/en-us_image_0000001476990897.jpg
:alt: **Figure 1** Viewing project IDs :alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs **Figure 1** Viewing project IDs

2
api-ref/source/before_you_start/concepts.rst
View File

@ -28,7 +28,7 @@ Concepts
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
.. figure:: /_static/images/en-us_image_0000001828921437.png .. figure:: /_static/images/en-us_image_0000001477110589.gif
:alt: **Figure 1** Project isolating model :alt: **Figure 1** Project isolating model
**Figure 1** Project isolating model **Figure 1** Project isolating model

8
api-ref/source/change_history.rst
View File

@ -8,14 +8,6 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+=========================================================================================================================================================================================================================+ +===================================+=========================================================================================================================================================================================================================+
| 2024-02-28 | Modified the following content: |
| | |
| | Added precautions in :ref:`Configuring Resource Quotas <gaussdb_04_0012>` and :ref:`Modifying Resource Quotas <gaussdb_04_0013>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-10-25 | Modified the following content: |
| | |
| | Modified the response parameters and examples in :ref:`Deleting a Manual Backup <deletegaussmysqlbackup>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-10-20 | Modified the following content: | | 2023-10-20 | Modified the following content: |
| | | | | |
| | Added the **total_count** field to the example response in :ref:`Querying Resource Quotas <gaussdb_04_0011>`. | | | Added the **total_count** field to the example response in :ref:`Querying Resource Quotas <gaussdb_04_0011>`. |

1
doc/requirements.txt
View File

@ -8,4 +8,3 @@ reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0 otc-sphinx-directives>=0.1.0
sphinx-minify>=0.0.1 # Apache-2.0 sphinx-minify>=0.0.1 # Apache-2.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
setuptools

21
tox.ini
View File

@ -43,19 +43,15 @@ commands =
{[testenv:json-umn]commands} {[testenv:json-umn]commands}
[testenv:docs-pdf] [testenv:docs-pdf]
deps = deps = {[testenv:docs]deps}
{[testenv:docs]deps}
{[testenv:bindeps]deps}
allowlist_externals = allowlist_externals =
rm rm
mkdir mkdir
wget
make make
bash bash
cp cp
commands = commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
{[testenv:bindeps]commands}
{[testenv:api-ref-pdf-docs]commands} {[testenv:api-ref-pdf-docs]commands}
{[testenv:umn-pdf-docs]commands} {[testenv:umn-pdf-docs]commands}
@ -153,21 +149,6 @@ commands =
[testenv:bindeps]
deps =
bindep
allowlist_externals =
wget
rm
bash
commands =
rm -rf {toxinidir}/bindep.txt
rm -rf {toxinidir}/packages.txt
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
[doc8] [doc8]
ignore = D001 ignore = D001
extensions = .rst, .yaml extensions = .rst, .yaml

BIN
umn/source/_static/images/en-us_image_0000001352538844.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 446 B

BIN
umn/source/_static/images/en-us_image_0000001460761526.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 80 KiB

BIN
umn/source/_static/images/en-us_image_0000001896928157.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 14 KiB

92
umn/source/change_history.rst
View File

@ -5,58 +5,40 @@
Change History Change History
============== ==============
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+============================================================================================================================================+ +===================================+==================================================================================+
| 2024-04-15 | Modified the following content: | | 2023-04-06 | Added :ref:`Changing an Instance Description <gaussdb_03_0132>`. |
| | | +-----------------------------------+----------------------------------------------------------------------------------+
| | Added :ref:`Backup Space and Billing <gaussdb_03_0069>`. | | 2022-11-30 | Modified the following content: |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | | |
| 2024-02-28 | Modified the following content: | | | - Added :ref:`Introducing Read/Write Splitting <gaussdb_02_0011>`. |
| | | | | - Added :ref:`Enabling Read/Write Splitting <gaussdb_11_0017>`. |
| | Modified the parameter description in :ref:`Setting Alarm Rules <gaussdb_03_0087>`. | | | - Added :ref:`Changing the Read/Write Splitting Address <gaussdb_11_0031>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | | - Added :ref:`Disabling Read/Write Splitting <gaussdb_11_0019>`. |
| 2023-11-13 | Modified the following content: | | | - Added :ref:`Enabling or Disabling Access Control <gaussdb_11_0025>`. |
| | | | | - Added :ref:`Enabling or Disabling Access Control <gaussdb_11_0025>`. |
| | Allowed you to change the node names synchronously during DB instance name change in :ref:`Changing a DB Instance Name <gaussdb_03_0032>`. | | | - Added :ref:`Testing Read/Write Splitting Performance <gaussdb_11_0021>`. |
| | | +-----------------------------------+----------------------------------------------------------------------------------+
| | Added the event of deleting a task from the task center in :ref:`Key Operations Supported by CTS <gaussdb_03_0014>`. | | 2021-12-09 | Modified the following content: |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | | |
| 2023-10-25 | Modified the following content: | | | - Modified instance specifications. |
| | | | | - Modified the parameter description about adding a security group rule. |
| | Added specifications (2 vCPUs \| 8 GB) in :ref:`DB Instance Specifications <gaussdb_01_0004>`. | | | - Modified the description of changing parameters in parameter templates. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | | - Modified the content of the section "Task Center". |
| 2023-04-06 | Added :ref:`Changing an Instance Description <gaussdb_03_0132>`. | | | - Optimized the description of the section "Viewing Monitoring Metrics". |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------+
| 2022-11-30 | Modified the following content: | | 2021-11-30 | Optimized :ref:`Deleting a Task Record <gaussdb_task_0002>`. |
| | | +-----------------------------------+----------------------------------------------------------------------------------+
| | - Added :ref:`Introducing Read/Write Splitting <gaussdb_02_0011>`. | | 2021-08-31 | Added :ref:`Enabling or Disabling SQL Explorer <gaussdb_03_0152>`. |
| | - Added :ref:`Enabling Read/Write Splitting <gaussdb_11_0017>`. | +-----------------------------------+----------------------------------------------------------------------------------+
| | - Added :ref:`Changing the Read/Write Splitting Address <gaussdb_11_0031>`. | | 2020-10-31 | Optimized the content in :ref:`Configuring Displayed Metrics <gaussdb_03_0085>`. |
| | - Added :ref:`Disabling Read/Write Splitting <gaussdb_11_0019>`. | +-----------------------------------+----------------------------------------------------------------------------------+
| | - Added :ref:`Enabling or Disabling Access Control <gaussdb_11_0025>`. | | 2020-07-31 | Modified the following content: |
| | - Added :ref:`Enabling or Disabling Access Control <gaussdb_11_0025>`. | | | |
| | - Added :ref:`Testing Read/Write Splitting Performance <gaussdb_11_0021>`. | | | - Product description in :ref:`What Is GaussDB(for MySQL)? <introduction>` |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | | |
| 2021-12-09 | Modified the following content: | | | - Optimized DB instance specifications. |
| | | +-----------------------------------+----------------------------------------------------------------------------------+
| | - Modified instance specifications. | | 2020-07-14 | This issue is the first official release. |
| | - Modified the parameter description about adding a security group rule. | +-----------------------------------+----------------------------------------------------------------------------------+
| | - Modified the description of changing parameters in parameter templates. |
| | - Modified the content of the section "Task Center". |
| | - Optimized the description of the section "Viewing Monitoring Metrics". |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 2021-11-30 | Optimized :ref:`Deleting a Task Record <gaussdb_task_0002>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 2021-08-31 | Added :ref:`Enabling or Disabling SQL Explorer <gaussdb_03_0152>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-10-31 | Optimized the content in :ref:`Configuring Displayed Metrics <gaussdb_03_0085>`. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-07-31 | Modified the following content: |
| | |
| | - Product description in :ref:`What Is GaussDB(for MySQL)? <introduction>` |
| | |
| | - Optimized DB instance specifications. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-07-14 | This issue is the first official release. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+

8
umn/source/faqs/how_can_i_import_the_root_certificate_to_a_windows_or_linux_os.rst
View File

@ -32,11 +32,3 @@ Importing the Root Certificate to the Linux OS
---------------------------------------------- ----------------------------------------------
You can use a connection tool (such as WinSCP or PuTTY) to upload the certificate to any directory on a Linux OS. You can use a connection tool (such as WinSCP or PuTTY) to upload the certificate to any directory on a Linux OS.
Example:
.. figure:: /_static/images/en-us_image_0000001460761526.png
:alt: **Figure 1** Importing a certificate
**Figure 1** Importing a certificate

6
umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_1_create_a_db_instance.rst
View File

@ -16,7 +16,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click **Create DB Instance**. #. On the **Instance Management** page, click **Create DB Instance**.
#. On the displayed page, configure parameters about the DB instance specifications. Then, click **Create Now**. #. On the displayed page, configure parameters about the DB instance specifications. Then, click **Create Now**.
.. table:: **Table 1** Basic information .. table:: **Table 1** Basic information
@ -24,7 +24,7 @@ Procedure
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+===================================+====================================================================================================================================================================================================================================================+ +===================================+====================================================================================================================================================================================================================================================+
| Region | A region where the tenant is located. You can change it on the creation page, or go back to the **Instances** page and change it in the upper left corner. | | Region | A region where the tenant is located. You can change it on the creation page, or go back to the **Instance Management** page and change it in the upper left corner. |
| | | | | |
| | .. important:: | | | .. important:: |
| | | | | |
@ -118,7 +118,7 @@ Procedure
- If you need to modify your settings, click **Previous**. - If you need to modify your settings, click **Previous**.
- If you do not need to modify your settings, click **Submit**. - If you do not need to modify your settings, click **Submit**.
#. To view and manage DB instances, go to the **Instances** page. #. To view and manage DB instances, go to the **Instance Management** page.
- During the creation process, the DB instance status is **Creating**. When the status of the created instance is **Available**, the DB instance can be used. - During the creation process, the DB instance status is **Creating**. When the status of the created instance is **Available**, the DB instance can be used.

2
umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_2_configure_security_group_rules.rst
View File

@ -42,7 +42,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. #. On the **Instance Management** page, click the target DB instance.
#. Configure security group rules. #. Configure security group rules.

6
umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_1_create_a_db_instance.rst
View File

@ -16,7 +16,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click **Create DB Instance**. #. On the **Instance Management** page, click **Create DB Instance**.
#. On the displayed page, configure parameters about the DB instance specifications. Then, click **Create Now**. #. On the displayed page, configure parameters about the DB instance specifications. Then, click **Create Now**.
.. table:: **Table 1** Basic information .. table:: **Table 1** Basic information
@ -24,7 +24,7 @@ Procedure
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+===================================+====================================================================================================================================================================================================================================================+ +===================================+====================================================================================================================================================================================================================================================+
| Region | A region where the tenant is located. You can change it on the creation page, or go back to the **Instances** page and change it in the upper left corner. | | Region | A region where the tenant is located. You can change it on the creation page, or go back to the **Instance Management** page and change it in the upper left corner. |
| | | | | |
| | .. important:: | | | .. important:: |
| | | | | |
@ -118,7 +118,7 @@ Procedure
- If you need to modify your settings, click **Previous**. - If you need to modify your settings, click **Previous**.
- If you do not need to modify your settings, click **Submit**. - If you do not need to modify your settings, click **Submit**.
#. To view and manage DB instances, go to the **Instances** page. #. To view and manage DB instances, go to the **Instance Management** page.
- During the creation process, the DB instance status is **Creating**. When the status of the created instance is **Available**, the DB instance can be used. - During the creation process, the DB instance status is **Creating**. When the status of the created instance is **Available**, the DB instance can be used.

2
umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_2_bind_an_eip.rst
View File

@ -24,7 +24,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. #. On the **Instance Management** page, click the target DB instance.
#. In the **Network Information** area, click **Bind** in the Private IP Address field. #. In the **Network Information** area, click **Bind** in the Private IP Address field.

6
umn/source/introduction/db_instance_description/db_instance_specifications.rst
View File

@ -12,8 +12,7 @@ GaussDB(for MySQL) instance specifications are listed in the following table and
======================= ===== =========== ======================= ===== ===========
Instance Specifications vCPUs Memory (GB) Instance Specifications vCPUs Memory (GB)
======================= ===== =========== ======================= ===== ===========
Dedicated 2 8 Dedicated Edition 4 32
\ 4 32
\ 8 64 \ 8 64
\ 16 128 \ 16 128
\ 32 256 \ 32 256
@ -25,8 +24,7 @@ GaussDB(for MySQL) instance specifications are listed in the following table and
======================= ===== =========== ======================= ===== ===========
Instance Specifications vCPUs Memory (GB) Instance Specifications vCPUs Memory (GB)
======================= ===== =========== ======================= ===== ===========
Dedicated 2 8 Dedicated Edition 4 32
\ 4 32
\ 8 64 \ 8 64
\ 16 128 \ 16 128
\ 32 256 \ 32 256

58
umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/backup_space_and_billing.rst
View File

@ -1,58 +0,0 @@
:original_name: gaussdb_03_0069.html
.. _gaussdb_03_0069:
Backup Space and Billing
========================
Category
--------
- The full backup mode is used to back up all target data even if no data is updated since the last backup.
- Incremental backup: The system automatically backs up data that has changed since the last automated backup or incremental backup in binlogs every 5 minutes. The binlogs can be used to restore data to a specified point in time.
- Differential backup: The system backs up data that has changed since the most recent full backup or differential backup in to physical files. Physical files cannot be used for log replay.
- Billable space: Backup space that you are billed for.
- Logical space: Space occupied by full backups.
- Physical space: The amount of data that is backed up to OBS.
.. note::
After you create a DB instance, the logical space is the same as the physical space. When a backup starts in a backup chain, the physical space stores the data of the first full backup and subsequent differential backups.
Backup Space Calculation Methods
--------------------------------
There is a default backup chain (where there are seven backups). The first automated backup is a full backup, and subsequent automated backups are differential backups.
In a backup chain, the backup space is released only after all full backups and differential backups are deleted.
- Logical space: Total size of the logical space - Logical size of the expired backup file
- Physical space: Size of the first full backup file + total size of subsequent differential backup files
- Free space: There is free backup storage up to 100% of your provisioned database storage.
Billing is calculated as follows:
The system deducts the free space from either the logical space or the physical space, whichever is smaller.
Example
-------
A backup line contains seven backups by default. There are 11 backups shown in the following figure. The 1st backup to the 7th belong to one backup line and the 8th to the 11th belong to another.
.. figure:: /_static/images/en-us_image_0000001896928157.png
:alt: **Figure 1** Backup example
**Figure 1** Backup example
If there is 1,000 MB of backup space and the logical space is 1,000 MB each time, the physical space for the 1st backup is 1,000 MB. If the incremental data size is 100 MB each time, the physical space for the 2nd backup to 7th is 100 MB.
A backup line contains seven backups by default. The physical space for the 8th backup is 1,000 MB because it represents a new backup line.
Billed space includes the space of the two chains in the example.
Suppose that after the 11th backup was created, and the 1st, 2nd and 3rd backups expired and were automatically deleted. The size of each space is calculated as follows:
- Total logical space size = Total logical space size - Logical size of the expired backup file (1,000 MB x 11 - 3,000 MB = 8,000 MB in this example).
- Physical space: size of data backed up to OBS. In this example, physical space includes the sum of physical space on the two backup links: 1,000 MB + (100 MB x 6) +1,000 MB+ (100 MB X 3) =2,900 MB
- Total billed space = Min (Total size of logical space, Total size of physical space) - free space, so the total billed space in this example = Min (8,000 MB, 2,900 MB) - 1,000 MB = 1,900 MB

10
umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/creating_a_manual_backup.rst
View File

@ -18,14 +18,14 @@ Method 1
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, locate the target DB instance and choose **More** > **Create Backup** in the **Operation** column. #. On the **Instance Management** page, locate the target DB instance and choose **More** > **Create Backup** in the **Operation** column.
#. In the displayed dialog box, enter a backup name and description. Then, click **OK**. If you want to cancel the backup creation task, click **Cancel**. #. In the displayed dialog box, enter a backup name and description. Then, click **OK**. If you want to cancel the backup creation task, click **Cancel**.
- The backup name must consist of 4 to 64 characters and start with a letter. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - The backup name must consist of 4 to 64 characters and start with a letter. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).
- The description must consist of a maximum of 256 characters and cannot contain the carriage return character or the following special characters: !<"='>& - The description must consist of a maximum of 256 characters and cannot contain the carriage return character or the following special characters: !<"='>&
- The time required for creating a manual backup depends on the data volume of the DB instance. - The time required for creating a manual backup depends on the data volume of the DB instance.
#. After a manual backup has been created, you can view and manage it on the **Backups** page. #. After a manual backup has been created, you can view and manage it on the **Backup Management** page.
Method 2 Method 2
-------- --------
@ -33,14 +33,14 @@ Method 2
#. Log in to the management console. #. Log in to the management console.
#. Click |image2| in the upper left corner and select a region and a project. #. Click |image2| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. #. On the **Instance Management** page, click the target DB instance.
#. On the **Backups** page, click **Create Backup**. In the displayed dialog box, enter a backup name and a description, and click **OK**. If you want to cancel the backup creation task, click **Cancel**. #. On the **Backups & Restorations** page, click **Create Backup**. In the displayed dialog box, enter a backup name and a description, and click **OK**. If you want to cancel the backup creation task, click **Cancel**.
- The backup name must consist of 4 to 64 characters and start with a letter. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - The backup name must consist of 4 to 64 characters and start with a letter. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).
- The description must consist of a maximum of 256 characters and cannot contain the carriage return character or the following special characters: !<"='>& - The description must consist of a maximum of 256 characters and cannot contain the carriage return character or the following special characters: !<"='>&
- The time required for creating a manual backup depends on the data volume of the DB instance. - The time required for creating a manual backup depends on the data volume of the DB instance.
#. After a manual backup has been created, you can view and manage it on the **Backups** page. #. After a manual backup has been created, you can view and manage it on the **Backup Management** page.
.. |image1| image:: /_static/images/en-us_image_0000001352219100.png .. |image1| image:: /_static/images/en-us_image_0000001352219100.png
.. |image2| image:: /_static/images/en-us_image_0000001352219100.png .. |image2| image:: /_static/images/en-us_image_0000001352219100.png

2
umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/deleting_a_manual_backup.rst
View File

@ -23,7 +23,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. In the navigation pane on the left, choose **Backups**. On the displayed page, locate the manual backup to be deleted and click **Delete** in the **Operation** column. #. In the navigation pane on the left, choose **Backup Management**. On the displayed page, locate the manual backup to be deleted and click **Delete** in the **Operation** column.
The following backups cannot be deleted: The following backups cannot be deleted:

2
umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/index.rst
View File

@ -6,7 +6,6 @@ Backups and Restorations
======================== ========================
- :ref:`Working with Backups <gaussdb_03_0056>` - :ref:`Working with Backups <gaussdb_03_0056>`
- :ref:`Backup Space and Billing <gaussdb_03_0069>`
- :ref:`Creating a Manual Backup <gaussdb_03_0058>` - :ref:`Creating a Manual Backup <gaussdb_03_0058>`
- :ref:`Restoring Data from a Backup <gaussdb_03_0063>` - :ref:`Restoring Data from a Backup <gaussdb_03_0063>`
- :ref:`Deleting a Manual Backup <gaussdb_03_0068>` - :ref:`Deleting a Manual Backup <gaussdb_03_0068>`
@ -16,7 +15,6 @@ Backups and Restorations
:hidden: :hidden:
working_with_backups working_with_backups
backup_space_and_billing
creating_a_manual_backup creating_a_manual_backup
restoring_data_from_a_backup restoring_data_from_a_backup
deleting_a_manual_backup deleting_a_manual_backup

2
umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/restoring_data_from_a_backup.rst
View File

@ -19,7 +19,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Backups** page, select the backup to be restored and click **Restore** in the **Operation** column. #. On the **Backup Management** page, select the backup to be restored and click **Restore** in the **Operation** column.
#. Click **OK**. Currently, you can only restore data to a new DB instance. #. Click **OK**. Currently, you can only restore data to a new DB instance.

2
umn/source/working_with_gaussdbfor_mysql/connection_management/binding_and_unbinding_an_eip.rst
View File

@ -31,7 +31,7 @@ Binding an EIP
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the **Network Information** area, click **Bind** in the **Public IP Address (EIP)** field. #. In the **Network Information** area, click **Bind** in the **Public IP Address (EIP)** field.

2
umn/source/working_with_gaussdbfor_mysql/connection_management/changing_a_database_port.rst
View File

@ -24,7 +24,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the **Network Information** area, click |image2| in the **Database Port** field. #. In the **Network Information** area, click |image2| in the **Database Port** field.

2
umn/source/working_with_gaussdbfor_mysql/data_security/changing_a_security_group.rst
View File

@ -16,7 +16,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the **Network Information** area, click |image2| in the **Security Group** field. #. In the **Network Information** area, click |image2| in the **Security Group** field.
- To submit the change, click |image3|. - To submit the change, click |image3|.

4
umn/source/working_with_gaussdbfor_mysql/data_security/resetting_the_administrator_password.rst
View File

@ -33,7 +33,7 @@ Method 1
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, locate the target DB instance and choose **More** > **Reset Password** in the **Operation** column. #. On the **Instance Management** page, locate the target DB instance and choose **More** > **Reset Password** in the **Operation** column.
#. Enter a new password and confirm the password. #. Enter a new password and confirm the password.
@ -55,7 +55,7 @@ Method 2
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the **DB Instance Information** area, click **Reset Password** in the **Administrator** field. In the displayed dialog box, enter a new password and confirm the password. #. In the **DB Instance Information** area, click **Reset Password** in the **Administrator** field. In the displayed dialog box, enter a new password and confirm the password.

4
umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/assigning_read_weights.rst
View File

@ -12,7 +12,7 @@ Description
- After read/write splitting is enabled, you can assign read weights for the primary node and read replicas. - After read/write splitting is enabled, you can assign read weights for the primary node and read replicas.
- The default read weight of the primary node is 0. The higher read weight the primary node is assigned, the more read requests it can process. - The default read weight of the primary node is 0. The higher read weight the primary node is assigned, the more read requests it can process.
- When the read weights of all nodes are 0, services are not affected. In this case, the primary node processes all read and write requests by default. - If the read weight of a read replica is 0, the read replica does not process any read requests.
- The weight of a read replica ranges from 0 to 1000. - The weight of a read replica ranges from 0 to 1000.
- For details about how to assign read weights, see :ref:`Weight Assignment Rules <gaussdb_11_0018__en-us_topic_0200110324_section18253121664211>`. - For details about how to assign read weights, see :ref:`Weight Assignment Rules <gaussdb_11_0018__en-us_topic_0200110324_section18253121664211>`.
@ -42,7 +42,7 @@ Procedure
#. Under **Database**, click **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**. #. Under **Database**, click **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**.
#. On the **Instances** page, click the instance name to go to the **Basic Information** page. #. On the **Instance Management** page, click the instance name to go to the **Basic Information** page.
#. In the navigation pane on the left, choose **Database Proxy**. On the displayed page, click the **Read/Write Splitting** tab. #. In the navigation pane on the left, choose **Database Proxy**. On the displayed page, click the **Read/Write Splitting** tab.

2
umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/disabling_read_write_splitting.rst
View File

@ -13,7 +13,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the navigation pane on the left, choose **Database Proxy**. #. In the navigation pane on the left, choose **Database Proxy**.
#. On the **Database Proxy** page, locate the desired proxy instance and click **Disable Database Proxy** in the **Operation** column. In the displayed dialog box, click **Yes**. #. On the **Database Proxy** page, locate the desired proxy instance and click **Disable Database Proxy** in the **Operation** column. In the displayed dialog box, click **Yes**.

2
umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_read_write_splitting.rst
View File

@ -16,7 +16,7 @@ Procedure
#. Under **Database**, click **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**. #. Under **Database**, click **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the navigation pane on the left, choose **Database Proxy**. #. In the navigation pane on the left, choose **Database Proxy**.

16
umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_a_db_instance_name.rst
View File

@ -14,13 +14,17 @@ Procedure
--------- ---------
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, locate the instance name and click |image2| in the **Name/ID** column to edit the instance name.
- The DB instance name must start with a letter and consist of 4 to 64 characters. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. #. Click |image1| in the upper left corner and select a region and a project.
- When changing the instance name, you can determine whether to select **Change node names synchronously** as required. If this option is selected, the names of the corresponding nodes are changed when the instance name is changed. If this option is not selected, only the instance name is changed, and the corresponding node names are not changed.
- If you want to submit the change, click **OK**. If you want to cancel the change, click **Cancel**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instance Management** page, locate the target DB instance and click |image2| next to it to edit the DB instance name. Then, click **OK**.
The DB instance name must start with a letter and consist of 4 to 64 characters. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
- To submit the change, click **OK**.
- To cancel the change, click **Cancel**.
#. View the result of the change on the **Basic Information** page. #. View the result of the change on the **Basic Information** page.

4
umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_vcpus_and_memory_of_an_instance.rst
View File

@ -29,7 +29,7 @@ Procedure
#. You can change the instance specifications in either of the following ways: #. You can change the instance specifications in either of the following ways:
- On the **Instances** page, locate the target DB instance and choose **More** > **Change Instance Specifications** in the **Operation** column. - On the **Instance Management** page, locate the target DB instance and choose **More** > **Change Instance Specifications** in the **Operation** column.
- Click the target DB instance to go to the **Basic Information** page. In the **DB Instance Information** area, click **Change** in the **Instance Specifications** field. - Click the target DB instance to go to the **Basic Information** page. In the **DB Instance Information** area, click **Change** in the **Instance Specifications** field.
#. On the displayed page, specify the new instance specifications, and click **Next**. #. On the displayed page, specify the new instance specifications, and click **Next**.
@ -41,7 +41,7 @@ Procedure
#. View the DB instance specification change result. #. View the DB instance specification change result.
Changing the instance specifications takes 5-15 minutes. During this period, the status of the instance on the **Instances** page is **Changing instance specifications**. After a few minutes, you can click the instance name to view the new instance specifications on the displayed **Basic Information** page. Changing the instance specifications takes 5-15 minutes. During this period, the status of the instance on the **Instance Management** page is **Changing instance specifications**. After a few minutes, you can click the instance name to view the new instance specifications on the displayed **Basic Information** page.
.. important:: .. important::

6
umn/source/working_with_gaussdbfor_mysql/instance_modifications/deleting_a_db_instance.rst
View File

@ -8,7 +8,7 @@ Deleting a DB Instance
Scenarios Scenarios
--------- ---------
You can manually delete a DB instance on the **Instances** page. You can manually delete a DB instance on the **Instance Management** page.
.. important:: .. important::
@ -27,7 +27,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, locate the DB instance to be deleted and click **More** > **Delete** in the **Operation** column. #. On the **Instance Management** page, locate the DB instance to be deleted and click **More** > **Delete** in the **Operation** column.
#. In the displayed dialog box, click **Yes**. Refresh the **Instances** page later to check that the deletion is successful. #. In the displayed dialog box, click **Yes**. Refresh the **Instance Management** page later to check that the deletion is successful.
.. |image1| image:: /_static/images/en-us_image_0000001352219100.png .. |image1| image:: /_static/images/en-us_image_0000001352219100.png

4
umn/source/working_with_gaussdbfor_mysql/instance_modifications/exporting_db_instance_information.rst
View File

@ -16,7 +16,7 @@ Exporting Information About All DB Instances
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click |image2| in the upper right corner of the page. In the displayed dialog box, select the items to be exported and click **Export**. #. On the **Instance Management** page, click |image2| in the upper right corner of the page. In the displayed dialog box, select the items to be exported and click **Export**.
#. After the export task is complete, a .csv file is generated locally. #. After the export task is complete, a .csv file is generated locally.
Exporting Information About Selected DB Instances Exporting Information About Selected DB Instances
@ -25,7 +25,7 @@ Exporting Information About Selected DB Instances
#. Log in to the management console. #. Log in to the management console.
#. Click |image3| in the upper left corner and select a region and a project. #. Click |image3| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, select the DB instances to be exported and click |image4| in the upper right corner of the page. In the displayed dialog box, select the items to be exported and click **Export**. #. On the **Instance Management** page, select the DB instances to be exported and click |image4| in the upper right corner of the page. In the displayed dialog box, select the items to be exported and click **Export**.
#. After the export task is complete, a .csv file is generated locally. #. After the export task is complete, a .csv file is generated locally.
.. |image1| image:: /_static/images/en-us_image_0000001352219100.png .. |image1| image:: /_static/images/en-us_image_0000001352219100.png

2
umn/source/working_with_gaussdbfor_mysql/instance_modifications/rebooting_a_db_instance.rst
View File

@ -27,7 +27,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, locate the target DB instance and choose **More** > **Reboot** in the **Operation** column. #. On the **Instance Management** page, locate the target DB instance and choose **More** > **Reboot** in the **Operation** column.
Alternatively, click the target DB instance. On the displayed page, click **Reboot** in the upper right corner of the page. Alternatively, click the target DB instance. On the displayed page, click **Reboot** in the upper right corner of the page.

2
umn/source/working_with_gaussdbfor_mysql/interconnection_with_cts/key_operations_supported_by_cts.rst
View File

@ -60,5 +60,3 @@ Cloud Trace Service (CTS) records operations related to GaussDB(for MySQL) for f
+----------------------------------------------+----------------+-----------------------+ +----------------------------------------------+----------------+-----------------------+
| Applying a parameter template | parameterGroup | applyParameterGroup | | Applying a parameter template | parameterGroup | applyParameterGroup |
+----------------------------------------------+----------------+-----------------------+ +----------------------------------------------+----------------+-----------------------+
| Deleting a task from the task center | job | deleteTaskCenterJob |
+----------------------------------------------+----------------+-----------------------+

2
umn/source/working_with_gaussdbfor_mysql/logs/viewing_error_logs.rst
View File

@ -13,7 +13,7 @@ Viewing Log Details
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the navigation pane on the left, choose **Logs**. #. In the navigation pane on the left, choose **Logs**.
#. On the **Error Logs** page, select a node and view the error log details of the node, including: #. On the **Error Logs** page, select a node and view the error log details of the node, including:

2
umn/source/working_with_gaussdbfor_mysql/logs/viewing_slow_query_logs.rst
View File

@ -29,7 +29,7 @@ Viewing Log Details
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. The **Basic Information** page is displayed. #. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed.
#. In the navigation pane on the left, choose **Logs**. #. In the navigation pane on the left, choose **Logs**.

30
umn/source/working_with_gaussdbfor_mysql/monitoring/setting_alarm_rules.rst
View File

@ -25,33 +25,17 @@ Procedure
#. On the displayed page, set parameters as required. #. On the displayed page, set parameters as required.
.. table:: **Table 1** Parameter description - Specify **Name** and **Description**.
- Select **Use template** for **Method**. The template contains the following common metrics: CPU usage, memory usage, and storage space usage.
- Click |image2| to enable alarm notification. The validity period is 24 hours by default. If the topics you require are not displayed in the drop-down list, click **Create an SMN topic**. Then, select **Generated alarm** and **Cleared alarm** for **Trigger Condition**.
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note::
| Parameter | Parameter description |
+===================================+==========================================================================================================================================================+ Cloud Eye sends notifications only within the validity period specified in the alarm rule.
| Name | Alarm rule name. The system generates a random name, which you can modify. |
| | |
| | Example value: **alarm-b6al** |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Description | (Optional) Supplementary information about the alarm rule. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Method | There are two options: **Use existing template**, and **Configure manually**. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Template | Template to be used. |
| | |
| | You can select a default alarm template or create a custom template. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Alarm Notification | Whether to notify users when alarms are triggered. Notifications can be sent by email, text message, or HTTP/HTTPS message. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Notification Object | Object that receives alarm notifications. You can select the account contact or a topic. |
| | |
| | - Account contact is the mobile phone number and email address of the registered account. |
| | - Topic is used to publish messages and subscribe to notifications. If the required topic is unavailable, create one first and add subscriptions to it. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
#. Click **Create**. The alarm rule is created. #. Click **Create**. The alarm rule is created.
For operation details, see the *Cloud Eye User Guide*. For operation details, see the *Cloud Eye User Guide*.
.. |image1| image:: /_static/images/en-us_image_0000001403218685.png .. |image1| image:: /_static/images/en-us_image_0000001403218685.png
.. |image2| image:: /_static/images/en-us_image_0000001352538844.png

2
umn/source/working_with_gaussdbfor_mysql/monitoring/viewing_monitoring_metrics.rst
View File

@ -38,7 +38,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, locate the target DB instance and click **View Metric** in the **Operation** column to go to the Cloud Eye console. #. On the **Instance Management** page, locate the target DB instance and click **View Metric** in the **Operation** column to go to the Cloud Eye console.
You can use either of the following methods to view monitoring metrics: You can use either of the following methods to view monitoring metrics:

2
umn/source/working_with_gaussdbfor_mysql/parameter_template_management/applying_a_parameter_template.rst
View File

@ -22,7 +22,7 @@ Procedure
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Parameter Templates** page, you can apply a default template or a custom template to a target DB instance: #. On the **Parameter Template Management** page, you can apply a default template or a custom template to a target DB instance:
- To apply a default template, click **Default Templates**, locate the target parameter template, and in the **Operation** column, click **Apply**. - To apply a default template, click **Default Templates**, locate the target parameter template, and in the **Operation** column, click **Apply**.
- To apply a custom template, click **Custom Templates**, locate the target parameter template, and in the **Operation** column, choose **More** > **Apply**. - To apply a custom template, click **Custom Templates**, locate the target parameter template, and in the **Operation** column, choose **More** > **Apply**.

4
umn/source/working_with_gaussdbfor_mysql/parameter_template_management/comparing_a_parameter_template.rst
View File

@ -18,7 +18,7 @@ Comparing Instance Parameters with a Parameter Template
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Instances** page, click the target DB instance. #. On the **Instance Management** page, click the target DB instance.
#. In the navigation pane on the left, choose **Parameters**. On the displayed page, click **Compare** above the parameter list. #. In the navigation pane on the left, choose **Parameters**. On the displayed page, click **Compare** above the parameter list.
#. In the displayed dialog box, select a parameter template to be compared and click **OK**. #. In the displayed dialog box, select a parameter template to be compared and click **OK**.
@ -31,7 +31,7 @@ Comparing Parameter Templates
#. Log in to the management console. #. Log in to the management console.
#. Click |image2| in the upper left corner and select a region and a project. #. Click |image2| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Parameter Templates** page, click **Custom Templates**. Locate the target parameter template and click **Compare** in the **Operation** column. #. On the **Parameter Template Management** page, click **Custom Templates**. Locate the target parameter template and click **Compare** in the **Operation** column.
#. In the displayed dialog box, select a parameter template that uses the same DB engine as the target template and click **OK**. #. In the displayed dialog box, select a parameter template that uses the same DB engine as the target template and click **OK**.
- If their settings are different, the parameter names and values of both parameter templates are displayed. - If their settings are different, the parameter names and values of both parameter templates are displayed.

2
umn/source/working_with_gaussdbfor_mysql/parameter_template_management/creating_a_parameter_template.rst
View File

@ -26,7 +26,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Parameter Templates** page, click **Create Parameter Template**. #. On the **Parameter Template Management** page, click **Create Parameter Template**.
#. In the displayed dialog box, configure required information and click **OK**. #. In the displayed dialog box, configure required information and click **OK**.
- Select a DB engine for the parameter template. - Select a DB engine for the parameter template.

2
umn/source/working_with_gaussdbfor_mysql/parameter_template_management/deleting_a_parameter_template.rst
View File

@ -21,7 +21,7 @@ Procedure
#. Log in to the management console. #. Log in to the management console.
#. Click |image1| in the upper left corner and select a region and a project. #. Click |image1| in the upper left corner and select a region and a project.
#. Click **Service List**. Under **Database**, click **GaussDB**. #. Click **Service List**. Under **Database**, click **GaussDB**.
#. On the **Parameter Templates** page, click **Custom Templates**. Locate the parameter template to be deleted and choose **More** > **Delete** in the **Operation** column. #. On the **Parameter Template Management** page, click **Custom Templates**. Locate the parameter template to be deleted and choose **More** > **Delete** in the **Operation** column.
#. In the displayed dialog box, click **Yes**. #. In the displayed dialog box, click **Yes**.
.. |image1| image:: /_static/images/en-us_image_0000001352219100.png .. |image1| image:: /_static/images/en-us_image_0000001352219100.png

Some files were not shown because too many files have changed in this diff Show More