diff --git a/umn/source/_static/images/en-us_image_0000001352059444.png b/umn/source/_static/images/en-us_image_0000001352059444.png deleted file mode 100644 index 4b1ef62..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001352059444.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001352219100.png b/umn/source/_static/images/en-us_image_0000001352219100.png deleted file mode 100644 index 1909444..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001352219100.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001400271265.png b/umn/source/_static/images/en-us_image_0000001400271265.png deleted file mode 100644 index 973daae..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001400271265.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001400391461.png b/umn/source/_static/images/en-us_image_0000001400391461.png deleted file mode 100644 index 1909444..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001400391461.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001352378996.png b/umn/source/_static/images/en-us_image_0000001400623516.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352378996.png rename to umn/source/_static/images/en-us_image_0000001400623516.png diff --git a/umn/source/_static/images/en-us_image_0000001352538852.png b/umn/source/_static/images/en-us_image_0000001400623556.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352538852.png rename to umn/source/_static/images/en-us_image_0000001400623556.png diff --git a/umn/source/_static/images/en-us_image_0000001352379036.png b/umn/source/_static/images/en-us_image_0000001400783432.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352379036.png rename to umn/source/_static/images/en-us_image_0000001400783432.png diff --git a/umn/source/_static/images/en-us_image_0000001402979149.png b/umn/source/_static/images/en-us_image_0000001400783456.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402979149.png rename to umn/source/_static/images/en-us_image_0000001400783456.png diff --git a/umn/source/_static/images/en-us_image_0000001212611256.png b/umn/source/_static/images/en-us_image_0000001400783488.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001212611256.png rename to umn/source/_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/_static/images/en-us_image_0000001352379056.png b/umn/source/_static/images/en-us_image_0000001400783516.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352379056.png rename to umn/source/_static/images/en-us_image_0000001400783516.png diff --git a/umn/source/_static/images/en-us_image_0000001352379004.png b/umn/source/_static/images/en-us_image_0000001400943256.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352379004.png rename to umn/source/_static/images/en-us_image_0000001400943256.png diff --git a/umn/source/_static/images/en-us_image_0000001403218685.png b/umn/source/_static/images/en-us_image_0000001400943280.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403218685.png rename to umn/source/_static/images/en-us_image_0000001400943280.png diff --git a/umn/source/_static/images/en-us_image_0000001403138685.png b/umn/source/_static/images/en-us_image_0000001400943340.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403138685.png rename to umn/source/_static/images/en-us_image_0000001400943340.png diff --git a/umn/source/_static/images/en-us_image_0000001352538904.png b/umn/source/_static/images/en-us_image_0000001401103224.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352538904.png rename to umn/source/_static/images/en-us_image_0000001401103224.png diff --git a/umn/source/_static/images/en-us_image_0000001352219096.png b/umn/source/_static/images/en-us_image_0000001401103264.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352219096.png rename to umn/source/_static/images/en-us_image_0000001401103264.png diff --git a/umn/source/_static/images/en-us_image_0000001352379000.png b/umn/source/_static/images/en-us_image_0000001401103272.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352379000.png rename to umn/source/_static/images/en-us_image_0000001401103272.png diff --git a/umn/source/_static/images/en-us_image_0000001402858853.png b/umn/source/_static/images/en-us_image_0000001401103308.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402858853.png rename to umn/source/_static/images/en-us_image_0000001401103308.png diff --git a/umn/source/_static/images/en-us_image_0000001405262769.png b/umn/source/_static/images/en-us_image_0000001405262769.png deleted file mode 100644 index f41f913..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001405262769.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001405277053.png b/umn/source/_static/images/en-us_image_0000001405277053.png deleted file mode 100644 index 5c8bef8..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001405277053.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001420606766.png b/umn/source/_static/images/en-us_image_0000001420606766.png deleted file mode 100644 index bcf7a6b..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001420606766.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001423775818.png b/umn/source/_static/images/en-us_image_0000001423775818.png deleted file mode 100644 index 5cc171e..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001423775818.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001446730040.png b/umn/source/_static/images/en-us_image_0000001446730040.png deleted file mode 100644 index adf11de..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001446730040.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001403218753.png b/umn/source/_static/images/en-us_image_0000001451023269.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403218753.png rename to umn/source/_static/images/en-us_image_0000001451023269.png diff --git a/umn/source/_static/images/en-us_image_0000001403138693.png b/umn/source/_static/images/en-us_image_0000001451023297.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403138693.png rename to umn/source/_static/images/en-us_image_0000001451023297.png diff --git a/umn/source/_static/images/en-us_image_0000001352379048.png b/umn/source/_static/images/en-us_image_0000001451103469.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352379048.png rename to umn/source/_static/images/en-us_image_0000001451103469.png diff --git a/umn/source/_static/images/en-us_image_0000001403138681.png b/umn/source/_static/images/en-us_image_0000001451103505.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403138681.png rename to umn/source/_static/images/en-us_image_0000001451103505.png diff --git a/umn/source/_static/images/en-us_image_0000001352379040.png b/umn/source/_static/images/en-us_image_0000001451103529.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352379040.png rename to umn/source/_static/images/en-us_image_0000001451103529.png diff --git a/umn/source/_static/images/en-us_image_0000001402858869.png b/umn/source/_static/images/en-us_image_0000001451103533.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402858869.png rename to umn/source/_static/images/en-us_image_0000001451103533.png diff --git a/umn/source/_static/images/en-us_image_0000001403138737.png b/umn/source/_static/images/en-us_image_0000001451183121.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403138737.png rename to umn/source/_static/images/en-us_image_0000001451183121.png diff --git a/umn/source/_static/images/en-us_image_0000001402858817.png b/umn/source/_static/images/en-us_image_0000001451183145.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402858817.png rename to umn/source/_static/images/en-us_image_0000001451183145.png diff --git a/umn/source/_static/images/en-us_image_0000001402979141.png b/umn/source/_static/images/en-us_image_0000001451183161.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402979141.png rename to umn/source/_static/images/en-us_image_0000001451183161.png diff --git a/umn/source/_static/images/en-us_image_0000001352538844.png b/umn/source/_static/images/en-us_image_0000001451183173.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352538844.png rename to umn/source/_static/images/en-us_image_0000001451183173.png diff --git a/umn/source/_static/images/en-us_image_0000001402858861.png b/umn/source/_static/images/en-us_image_0000001451183185.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402858861.png rename to umn/source/_static/images/en-us_image_0000001451183185.png diff --git a/umn/source/_static/images/en-us_image_0000001403218681.png b/umn/source/_static/images/en-us_image_0000001451183189.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403218681.png rename to umn/source/_static/images/en-us_image_0000001451183189.png diff --git a/umn/source/_static/images/en-us_image_0000001403138721.png b/umn/source/_static/images/en-us_image_0000001451183233.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001403138721.png rename to umn/source/_static/images/en-us_image_0000001451183233.png diff --git a/umn/source/_static/images/en-us_image_0000001352219136.png b/umn/source/_static/images/en-us_image_0000001451343129.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001352219136.png rename to umn/source/_static/images/en-us_image_0000001451343129.png diff --git a/umn/source/_static/images/en-us_image_0000001402979157.png b/umn/source/_static/images/en-us_image_0000001451343169.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001402979157.png rename to umn/source/_static/images/en-us_image_0000001451343169.png diff --git a/umn/source/_static/images/en-us_image_0000001480810240.png b/umn/source/_static/images/en-us_image_0000001480810240.png deleted file mode 100644 index 168c349..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001480810240.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001496610421.png b/umn/source/_static/images/en-us_image_0000001496610421.png deleted file mode 100644 index ad79b27..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001496610421.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001496889725.png b/umn/source/_static/images/en-us_image_0000001496889725.png deleted file mode 100644 index ceebf4a..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001496889725.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001497009921.png b/umn/source/_static/images/en-us_image_0000001497009921.png deleted file mode 100644 index ceebf4a..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001497009921.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001497009925.png b/umn/source/_static/images/en-us_image_0000001497009925.png deleted file mode 100644 index ad79b27..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001497009925.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001512768946.png b/umn/source/_static/images/en-us_image_0000001512768946.png deleted file mode 100644 index 62ddb8e..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001512768946.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001513008494.png b/umn/source/_static/images/en-us_image_0000001513008494.png deleted file mode 100644 index 4b159e1..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001513008494.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001525318837.png b/umn/source/_static/images/en-us_image_0000001525318837.png deleted file mode 100644 index c8d49ac..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001525318837.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001563528757.png b/umn/source/_static/images/en-us_image_0000001563528757.png deleted file mode 100644 index 1267615..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001563528757.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001563934877.png b/umn/source/_static/images/en-us_image_0000001563934877.png deleted file mode 100644 index 168c349..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001563934877.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001472729081.png b/umn/source/_static/images/en-us_image_0192953998.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001472729081.png rename to umn/source/_static/images/en-us_image_0192953998.png diff --git a/umn/source/_static/images/en-us_image_0218527002.png b/umn/source/_static/images/en-us_image_0218527002.png deleted file mode 100644 index 1909444..0000000 Binary files a/umn/source/_static/images/en-us_image_0218527002.png and /dev/null differ diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst index 94eab2a..b22931d 100644 --- a/umn/source/change_history.rst +++ b/umn/source/change_history.rst @@ -5,40 +5,20 @@ Change History ============== -+-----------------------------------+----------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+==================================================================================+ -| 2023-04-06 | Added :ref:`Changing an Instance Description `. | -+-----------------------------------+----------------------------------------------------------------------------------+ -| 2022-11-30 | Modified the following content: | -| | | -| | - Added :ref:`Introducing Read/Write Splitting `. | -| | - Added :ref:`Enabling Read/Write Splitting `. | -| | - Added :ref:`Changing the Read/Write Splitting Address `. | -| | - Added :ref:`Disabling Read/Write Splitting `. | -| | - Added :ref:`Enabling or Disabling Access Control `. | -| | - Added :ref:`Enabling or Disabling Access Control `. | -| | - Added :ref:`Testing Read/Write Splitting Performance `. | -+-----------------------------------+----------------------------------------------------------------------------------+ -| 2021-12-09 | Modified the following content: | -| | | -| | - Modified instance specifications. | -| | - 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 `. | -+-----------------------------------+----------------------------------------------------------------------------------+ -| 2021-08-31 | Added :ref:`Enabling or Disabling SQL Explorer `. | -+-----------------------------------+----------------------------------------------------------------------------------+ -| 2020-10-31 | Optimized the content in :ref:`Configuring Displayed Metrics `. | -+-----------------------------------+----------------------------------------------------------------------------------+ -| 2020-07-31 | Modified the following content: | -| | | -| | - Product description in :ref:`What Is GaussDB(for MySQL)? ` | -| | | -| | - Optimized DB instance specifications. | -+-----------------------------------+----------------------------------------------------------------------------------+ -| 2020-07-14 | This issue is the first official release. | -+-----------------------------------+----------------------------------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+====================================================================================+ +| 2022-10-30 | This is the third official release. | +| | | +| | Optimized the content in :ref:`Step 1: Create a DB Instance `. | ++-----------------------------------+------------------------------------------------------------------------------------+ +| 2020-07-31 | This is the second official release. | +| | | +| | Modified the following content: | +| | | +| | - Product description in :ref:`What Is GaussDB(for MySQL)? ` | +| | | +| | - Instance specifications in :ref:`Table 1 `. | ++-----------------------------------+------------------------------------------------------------------------------------+ +| 2020-07-14 | This issue is the first official release. | ++-----------------------------------+------------------------------------------------------------------------------------+ diff --git a/umn/source/conf.py b/umn/source/conf.py index 7d350de..e1e64d6 100644 --- a/umn/source/conf.py +++ b/umn/source/conf.py @@ -30,17 +30,6 @@ otcdocs_repo_name = 'docs/gaussdb-mysql' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_type = 'gitea' -# Those variables are needed for indexing into OpenSearch -otcdocs_doc_environment = 'internal' -otcdocs_doc_link = '/gaussdb-mysql/umn/' -otcdocs_doc_title = 'User Guide' -otcdocs_doc_type = 'umn' -otcdocs_service_category = 'database' -otcdocs_service_title = 'GaussDB (for MySQL)' -otcdocs_service_type = 'gaussdb_mysql' -otcdocs_search_environment = 'hc_de' -otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. diff --git a/umn/source/faqs/how_can_i_install_the_mysql_client.rst b/umn/source/faqs/how_can_i_install_the_mysql_client.rst index 554bab2..179aa71 100644 --- a/umn/source/faqs/how_can_i_install_the_mysql_client.rst +++ b/umn/source/faqs/how_can_i_install_the_mysql_client.rst @@ -15,7 +15,7 @@ Procedure Find the `link `__ to the required version on the download page. The mysql-community-client-8.0.21-1.el6.x86_64 is used as an example in the following. - .. figure:: /_static/images/en-us_image_0000001352379056.png + .. figure:: /_static/images/en-us_image_0000001400783516.png :alt: **Figure 1** Download **Figure 1** Download diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/overview.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/overview.rst index eb95b5b..f73dcc1 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/overview.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/overview.rst @@ -19,7 +19,7 @@ Process .. _gaussdb_02_0006__fig138110377499: -.. figure:: /_static/images/en-us_image_0000001402979149.png +.. figure:: /_static/images/en-us_image_0000001400783456.png :alt: **Figure 1** Connecting to a DB instance over a private network **Figure 1** Connecting to a DB instance over a private network @@ -30,7 +30,7 @@ Process - If the ECS and DB instance are in the same security group, they can communicate with each other by default. No security group rule needs to be configured. Go to :ref:`Step 3: Connect to a DB Instance Over a Private Network `. - If the ECS and DB instance are in different security groups, you need to configure security group rules for the ECS and DB instance, respectively. - - DB instance: Configure an inbound rule for the security group to which the DB instance is associated. - - ECS: The default security group rule allows all outgoing data packets. In this scenario, you do not need to configure a security group rule for the ECS. If not all outbound traffic is allowed in the security group, you need to configure an outbound rule for the ECS. + - DB instance: Configure an inbound rule for the security group with which the DB instance is associated. + - ECS: The default security group rule allows all outgoing data packets. In this scenario, you do not need to configure a security rule for the ECS. If not all outbound traffic is allowed in the security group, you need to configure an outbound rule for the ECS. - :ref:`Step 3: Connect to a DB instance over a private network. ` You can connect to the DB instance through a common connection, or an SSL connection for enhanced security. SSL connections are encrypted. diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_1_create_a_db_instance.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_1_create_a_db_instance.rst index acfeca1..f0572f5 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_1_create_a_db_instance.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_1_create_a_db_instance.rst @@ -50,11 +50,11 @@ Procedure +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Description | +===================================+=========================================================================================================================================================================+ - | Instance Specifications | Refers to the CPU and memory of a DB instance. Different instance specifications support different numbers of database connections and maximum IOPS. | + | Instance Class | Refers to the CPU and memory of a DB instance. Different instance classes support different numbers of database connections and maximum IOPS. | | | | - | | After a DB instance is created, you can change its CPU and memory. For details, see :ref:`Changing vCPUs and Memory of an Instance `. | + | | After a DB instance is created, you can change its CPU and memory. For details, see :ref:`Changing a DB Instance Class `. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Nodes | GaussDB(for MySQL) supports one primary node and up to 15 read replicas. When you are creating a DB instance, a maximum of nine read replicas can be created at a time. | + | Read Replicas | GaussDB(for MySQL) supports one primary node and up to 15 read replicas. When you are creating a DB instance, a maximum of nine read replicas can be created at a time. | | | | | | After the DB instance is created, you can also create read replicas based on service requirements by referring to :ref:`Creating a Read Replica `. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ Procedure +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Subnet | Improves network security by providing dedicated network resources that are logically isolated from other networks. Subnets are only valid for a given AZ. The Dynamic Host Configuration Protocol (DHCP) function must be enabled by default for subnets in which you plan to create DB instances. It cannot be disabled. You can select or search for a desired subnet from the drop-down list. | | | | - | | A private IP address is automatically assigned when you create an instance. You can also enter a free private IP address in the subnet CIDR block. | + | | A private IP address for write is automatically assigned when you are creating a DB instance. You can also enter an unused a private IP address for write in the subnet CIDR block. | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Security Group | Enhances security by controlling access to GaussDB(for MySQL) from other services. You need to add rules to a security group that enable you to connect to your DB instance. | | | | @@ -105,14 +105,6 @@ Procedure | | For details, see :ref:`Parameter Template Management `. | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. table:: **Table 6** Batch instance creation - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+=======================================================================================================================================================================================================================================================================================================================================================================================================+ - | Quantity | You can create instances in batches. The default value is **1**. The value ranges from **1** to **10**. If you create multiple instances at a time, a hyphen (-) followed by a number with four digits will be appended to the instance name, starting with -0001. For example, if you enter **instance**, the first instance will be named as instance-0001, the second as instance-0002, and so on. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - #. Confirm your specifications. - If you need to modify your settings, click **Previous**. @@ -128,4 +120,4 @@ Procedure For details, see :ref:`Changing a Database Port `. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_2_configure_security_group_rules.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_2_configure_security_group_rules.rst index d6c8e74..ba1aac0 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_2_configure_security_group_rules.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_2_configure_security_group_rules.rst @@ -15,7 +15,7 @@ Check whether the ECS and DB instance are in the same security group. - If they are in the same security group, they can communicate with each other by default. No security group rule needs to be configured. Go to :ref:`Step 3: Connect to a DB Instance Over a Private Network `. - If they are in different security groups, you need to configure security group rules for the ECS and DB instance, respectively. - - DB instance: Configure an inbound rule for the security group to which the DB instance is associated. + - DB instance: Configure an inbound rule for the security group with which the DB instance is associated. - ECS: The default security group rule allows all outgoing data packets. In this scenario, you do not need to configure a security rule for the ECS. If not all outbound traffic is allowed in the security group, you need to configure an outbound rule for the ECS. Precautions @@ -54,33 +54,24 @@ Procedure .. table:: **Table 1** Inbound rule parameter description - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Description | Example Value | - +=======================+=================================================================================================================================================================+============================================================================================+ - | Protocol & Port | Network protocol for which the security group rule takes effect. | TCP | - | | | | - | | - Currently, the value can be **All**, **TCP (All ports)**, **TCP (Custom ports)**, **UDP (All ports)**, **UDP (Custom ports)**, **ICMP**, **GRE**, or others. | | - | | - **All**: indicates all protocol ports are supported. | | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | | **Port**: Port or port range over which the traffic can reach your ECS. | When connecting to the instance through a private network, enter the port of the instance. | - | | | | - | | | - Individual port: Enter a port, such as **22**. | - | | | - Consecutive ports: Enter a port range, such as **22-30**. | - | | | - All ports: Leave it blank or enter **1-65535**. | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Source | **Source**: specifies the source of the security group rule. The value can be another security group, a CIDR block, or an IP address. | 0.0.0.0/0 | - | | | | - | | xxx.xxx.xxx.xxx/32 (IPv4 address) | | - | | | | - | | xxx.xxx.xxx.0/24 (subnet) | | - | | | | - | | 0.0.0.0/0 (any IP address) | | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Description | Provides supplementary information about the security group rule. This parameter is optional. | ``-`` | - | | | | - | | The description can contain a maximum of 255 characters and cannot contain angle brackets (<>). | | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Operation | You can copy or delete a security group rule. If there is only one security group rule, the security group rule cannot be deleted. | ``-`` | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | Example Value | + +=======================+=====================================================================================================================================================================================================================================================================+=================================================================================================================================+ + | Protocol | Specifies the network protocol. | TCP | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Port & Source | - **Port**: specifies the port or port range over which the traffic can reach your ECS. The value ranges from 1025 to 65534, excluding the followings which are occupied by the system and cannot be used: 5342, 5343, 5344, 5345, 12017, 20000, 20201, and 20202. | - When connecting to the DB instance over a private network, enter the ECS's IP address and target DB instance's port. | + | | | - When connecting to the DB instance over a public network, enter the local device's IP address and target DB instance's port. | + | | - **Source**: specifies the source of the security group rule. The value can be another security group, a CIDR block, or an IP address. | | + | | | | + | | xxx.xxx.xxx.xxx/32 (IPv4 address) | | + | | | | + | | xxx.xxx.xxx.0/24 (subnet) | | + | | | | + | | 0.0.0.0/0 (any IP address) | | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Description | Provides supplementary information about the security group rule. This parameter is optional. | N/A | + | | | | + | | The description can contain a maximum of 255 characters and cannot contain angle brackets (<>). | | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_3_connect_to_a_db_instance_over_a_private_network.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_3_connect_to_a_db_instance_over_a_private_network.rst index ae0e79d..6b5c715 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_3_connect_to_a_db_instance_over_a_private_network.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_3_connect_to_a_db_instance_over_a_private_network.rst @@ -49,7 +49,7 @@ Using MySQL-Front to Connect to a DB Instance #. In the displayed dialog box, click **New**. - .. figure:: /_static/images/en-us_image_0000001352219096.png + .. figure:: /_static/images/en-us_image_0000001401103264.png :alt: **Figure 1** Connection management **Figure 1** Connection management @@ -58,7 +58,7 @@ Using MySQL-Front to Connect to a DB Instance .. _gaussdb_02_0009__en-us_topic_0171122303_fig4664143131112: - .. figure:: /_static/images/en-us_image_0000001352379004.png + .. figure:: /_static/images/en-us_image_0000001451103529.png :alt: **Figure 2** Adding an account **Figure 2** Adding an account @@ -87,7 +87,7 @@ Using MySQL-Front to Connect to a DB Instance #. In the displayed window, select the connection that you have created and click **Open**. If the connection information is correct, the DB instance is successfully connected. - .. figure:: /_static/images/en-us_image_0000001402858817.png + .. figure:: /_static/images/en-us_image_0000001451183185.png :alt: **Figure 3** Opening a session **Figure 3** Opening a session @@ -139,5 +139,5 @@ SSL Connection Enter password: -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001402979157.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001451343169.png diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/overview.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/overview.rst index d7eaf18..eacf981 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/overview.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/overview.rst @@ -19,7 +19,7 @@ Process .. _gaussdb_02_0016__fig138110377499: -.. figure:: /_static/images/en-us_image_0000001352379000.png +.. figure:: /_static/images/en-us_image_0000001401103272.png :alt: **Figure 1** Connecting to a DB instance over a public network **Figure 1** Connecting to a DB instance over a public network diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_1_create_a_db_instance.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_1_create_a_db_instance.rst index 4a310de..6b9763f 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_1_create_a_db_instance.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_1_create_a_db_instance.rst @@ -50,11 +50,11 @@ Procedure +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Description | +===================================+=========================================================================================================================================================================+ - | Instance Specifications | Refers to the CPU and memory of a DB instance. Different instance specifications support different numbers of database connections and maximum IOPS. | + | Instance Class | Refers to the CPU and memory of a DB instance. Different instance classes support different numbers of database connections and maximum IOPS. | | | | - | | After a DB instance is created, you can change its CPU and memory. For details, see :ref:`Changing vCPUs and Memory of an Instance `. | + | | After a DB instance is created, you can change its CPU and memory. For details, see :ref:`Changing a DB Instance Class `. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Nodes | GaussDB(for MySQL) supports one primary node and up to 15 read replicas. When you are creating a DB instance, a maximum of nine read replicas can be created at a time. | + | Read Replicas | GaussDB(for MySQL) supports one primary node and up to 15 read replicas. When you are creating a DB instance, a maximum of nine read replicas can be created at a time. | | | | | | After the DB instance is created, you can also create read replicas based on service requirements by referring to :ref:`Creating a Read Replica `. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ Procedure +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Subnet | Improves network security by providing dedicated network resources that are logically isolated from other networks. Subnets are only valid for a given AZ. The Dynamic Host Configuration Protocol (DHCP) function must be enabled by default for subnets in which you plan to create DB instances. It cannot be disabled. You can select or search for a desired subnet from the drop-down list. | | | | - | | A private IP address is automatically assigned when you create an instance. You can also enter a free private IP address in the subnet CIDR block. | + | | A private IP address for write is automatically assigned when you are creating a DB instance. You can also enter an unused a private IP address for write in the subnet CIDR block. | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Security Group | Enhances security by controlling access to GaussDB(for MySQL) from other services. You need to add rules to a security group that enable you to connect to your DB instance. | | | | @@ -105,14 +105,6 @@ Procedure | | For details, see :ref:`Parameter Template Management `. | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. table:: **Table 6** Batch instance creation - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+=======================================================================================================================================================================================================================================================================================================================================================================================================+ - | Quantity | You can create instances in batches. The default value is **1**. The value ranges from **1** to **10**. If you create multiple instances at a time, a hyphen (-) followed by a number with four digits will be appended to the instance name, starting with -0001. For example, if you enter **instance**, the first instance will be named as instance-0001, the second as instance-0002, and so on. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - #. Confirm your specifications. - If you need to modify your settings, click **Previous**. @@ -128,4 +120,4 @@ Procedure For details, see :ref:`Changing a Database Port `. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_2_bind_an_eip.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_2_bind_an_eip.rst index 2f49352..9fd839f 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_2_bind_an_eip.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_2_bind_an_eip.rst @@ -26,7 +26,7 @@ Procedure #. 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 for Write field. #. In the displayed dialog box, select an EIP and click **OK**. @@ -38,4 +38,4 @@ Procedure #. On the **EIPs** page, view the EIP that has been bound to the DB instance. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_3_configure_security_group_rules.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_3_configure_security_group_rules.rst index 0734407..ff36c51 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_3_configure_security_group_rules.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_3_configure_security_group_rules.rst @@ -70,4 +70,4 @@ Procedure | | The description can contain a maximum of 255 characters and cannot contain angle brackets (<>). | | +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_4_connect_to_a_db_instance_over_a_public_network.rst b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_4_connect_to_a_db_instance_over_a_public_network.rst index bdef8ce..ebbf30d 100644 --- a/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_4_connect_to_a_db_instance_over_a_public_network.rst +++ b/umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_4_connect_to_a_db_instance_over_a_public_network.rst @@ -52,7 +52,7 @@ Using MySQL-Front to Connect to a DB Instance #. In the displayed dialog box, click **New**. - .. figure:: /_static/images/en-us_image_0000001352219136.png + .. figure:: /_static/images/en-us_image_0000001451343129.png :alt: **Figure 1** Connection management **Figure 1** Connection management @@ -61,26 +61,26 @@ Using MySQL-Front to Connect to a DB Instance .. _gaussdb_02_0014__en-us_topic_0172523144_en-us_topic_0154555358_fig4664143131112: - .. figure:: /_static/images/en-us_image_0000001352379040.png + .. figure:: /_static/images/en-us_image_0000001400943256.png :alt: **Figure 2** Adding an account **Figure 2** Adding an account .. table:: **Table 1** Parameter description - +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+============================================================================================================================================================================================================================+ - | Name | Database connection task name. If you do not set this parameter, it will be the same as that configured for **Host** by default. | - +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Host | EIP bound to the target DB instance. To obtain this parameter, go to the **Basic Information** page of the DB instance. The EIP can be found in the **Public IP Address (EIP)** field in the **Network Information** area. | - +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Port | Private network port of the DB instance. | - +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | User | Name of the user who accesses the DB instance. The default user is **root**. | - +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Password | Password of the DB instance account. | - +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===========+=============================================================================================================================================================================================================================+ + | Name | Database connection task name. If you do not set this parameter, it will be the same as that configured for **Host** by default. | + +-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Host | EIP bound the target DB instance. To obtain this parameter, go to the **Basic Information** page of the DB instance. The EIP can be found in the **Public IP Address for Write** field in the **Network Information** area. | + +-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Port | Private network port of the DB instance. | + +-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | User | Name of the user who accesses the DB instance. The default user is **root**. | + +-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Password | Password of the DB instance account. | + +-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ #. In the displayed window, select the connection that you have created in :ref:`Figure 3 ` and click **Open**. @@ -88,7 +88,7 @@ Using MySQL-Front to Connect to a DB Instance .. _gaussdb_02_0014__en-us_topic_0172523144_en-us_topic_0154555358_fig3870144665113: - .. figure:: /_static/images/en-us_image_0000001402858861.png + .. figure:: /_static/images/en-us_image_0000001451183145.png :alt: **Figure 3** Opening a session **Figure 3** Opening a session @@ -118,17 +118,17 @@ Using SSL to Connect to a DB Instance .. table:: **Table 2** Parameter description - +--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +==============+==================================================================================================================================================================================================================================================+ - | <*hostName*> | Host IP address of the target DB instance to be connected. To obtain this parameter, go to the **Basic Information** page of the DB instance. The EIP can be found in the **Public IP Address (EIP)** field in the **Network Information** area. | - +--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ** | Database port. To obtain this parameter, go to the **Basic Information** page of the DB instance. The database port can be found in the **Database Port** field in the **Network Information** area. | - +--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | <*userName*> | Username of the GaussDB(for MySQL) database administrator account. The default username is **root**. | - +--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | <*caName*> | SSL certificate file name, which should be stored in the same directory where the command is executed. | - +--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +==============+======================================================================================================================================================================================================================================================+ + | <*hostName*> | Host IP address of the target DB instance to be connected. To obtain this parameter, go to the **Basic Information** page of the DB instance. The EIP can be found in the **Public IP Address for Write** field in the **Network Information** area. | + +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ** | Database port. To obtain this parameter, go to the **Basic Information** page of the DB instance. The database port can be found in the **Database Port** field in the **Network Information** area. | + +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | <*userName*> | Username of the GaussDB(for MySQL) database administrator account. The default username is **root**. | + +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | <*caName*> | SSL certificate file name, which should be stored in the same directory where the command is executed. | + +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ For example, to connect to a DB instance through an SSL connection as user **root**, run the following command: @@ -144,5 +144,5 @@ Using SSL to Connect to a DB Instance If the connection fails, ensure that preparations have been correctly made in :ref:`Prerequisites ` and try again. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352538904.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001401103224.png diff --git a/umn/source/introduction/basic_concepts.rst b/umn/source/introduction/basic_concepts.rst index 44802a7..7dc89bd 100644 --- a/umn/source/introduction/basic_concepts.rst +++ b/umn/source/introduction/basic_concepts.rst @@ -13,6 +13,6 @@ Understanding the following concepts helps you better use GaussDB(for MySQL): - Availability zone (AZ): An AZ contains one or multiple physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple instances. An AZ is a geographic location with independent power supply and network facilities in a region. - AZs are physically isolated but interconnected over an intranet. Each AZ provides cost-effective and low-latency network connections that are unaffected by faults that may occur in other AZs. As a result, provisioning GaussDB(for MySQL) DB instances in separate AZs protects your applications against local faults that occur in a single location. AZs within the same region have no functional differences. + AZs are physically isolated but interconnected over an intranet. Each AZ provides cost-effective and low-latency network connections that are unaffected by faults that may occur in other AZs. As a result, provisioning GaussDB(for MySQL) DB instances in separate AZs protect your applications against local faults that occur in a single location. AZs within the same region have no functional differences. - Instance class: resource configuration of each node, for example, 16 vCPUs and 64 GB. diff --git a/umn/source/introduction/constraints.rst b/umn/source/introduction/constraints.rst index 40c6aec..63ccb74 100644 --- a/umn/source/introduction/constraints.rst +++ b/umn/source/introduction/constraints.rst @@ -24,7 +24,7 @@ Constraints +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Deployment | ECSs in which GaussDB(for MySQL) DB instances are deployed are not visible to users. You can access GaussDB(for MySQL) DB instances only over an IP address and a port. | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Administrator root permission | Only the **root** user permissions are available on the instance creation page. | + | Database root permissions | Only the **root** user permissions are available on the instance creation page. | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Database parameter modification | Most parameters can be modified on the GaussDB(for MySQL) console. | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/db_instance_description/db_instance_classes.rst b/umn/source/introduction/db_instance_description/db_instance_classes.rst new file mode 100644 index 0000000..f2d9bb0 --- /dev/null +++ b/umn/source/introduction/db_instance_description/db_instance_classes.rst @@ -0,0 +1,20 @@ +:original_name: gaussdb_01_0004.html + +.. _gaussdb_01_0004: + +DB Instance Classes +=================== + +GaussDB(for MySQL) instance classes are listed in the following table and vary according to actual situations. + +.. _gaussdb_01_0004__table184840323593: + +.. table:: **Table 1** Instance classes + + ================ ===== =========== + Instance Class vCPUs Memory (GB) + ================ ===== =========== + General-enhanced 16 64 + \ 32 128 + \ 60 256 + ================ ===== =========== diff --git a/umn/source/introduction/db_instance_description/db_instance_specifications.rst b/umn/source/introduction/db_instance_description/db_instance_specifications.rst deleted file mode 100644 index 26e3e58..0000000 --- a/umn/source/introduction/db_instance_description/db_instance_specifications.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: gaussdb_01_0004.html - -.. _gaussdb_01_0004: - -DB Instance Specifications -========================== - -GaussDB(for MySQL) instance specifications are listed in the following table and vary according to actual situations. - -.. table:: **Table 1** x86 instance specifications - - ======================= ===== =========== - Instance Specifications vCPUs Memory (GB) - ======================= ===== =========== - Dedicated Edition 4 32 - \ 8 64 - \ 16 128 - \ 32 256 - \ 64 512 - ======================= ===== =========== - -.. table:: **Table 2** Kunpeng instance specifications - - ======================= ===== =========== - Instance Specifications vCPUs Memory (GB) - ======================= ===== =========== - Dedicated Edition 4 32 - \ 8 64 - \ 16 128 - \ 32 256 - \ 48 384 - \ 60 480 - ======================= ===== =========== diff --git a/umn/source/introduction/db_instance_description/db_instance_statuses.rst b/umn/source/introduction/db_instance_description/db_instance_statuses.rst index b21b030..2ce7928 100644 --- a/umn/source/introduction/db_instance_description/db_instance_statuses.rst +++ b/umn/source/introduction/db_instance_description/db_instance_statuses.rst @@ -13,26 +13,24 @@ The status of a DB instance indicates the health of the instance. You can view t .. table:: **Table 1** DB instance statuses - +----------------------------------+------------------------------------------------------------------------------+ - | Status | Description | - +==================================+==============================================================================+ - | Available | DB instance is available. | - +----------------------------------+------------------------------------------------------------------------------+ - | Abnormal | DB instance is abnormal. | - +----------------------------------+------------------------------------------------------------------------------+ - | Creating | DB instance is being created. | - +----------------------------------+------------------------------------------------------------------------------+ - | Creation failed | DB instance failed to be created. | - +----------------------------------+------------------------------------------------------------------------------+ - | Rebooting | DB instance is being rebooted. | - +----------------------------------+------------------------------------------------------------------------------+ - | Changing a DB instance name | The instance name is being changed. | - +----------------------------------+------------------------------------------------------------------------------+ - | Changing port | DB instance port is being changed. | - +----------------------------------+------------------------------------------------------------------------------+ - | Changing instance specifications | CPU or memory of a DB instance is being changed. | - +----------------------------------+------------------------------------------------------------------------------+ - | Promoting to primary | A read replica is being promoted to the primary node. | - +----------------------------------+------------------------------------------------------------------------------+ - | Deleted | DB instance has been deleted and will not be displayed in the instance list. | - +----------------------------------+------------------------------------------------------------------------------+ + +-------------------------+------------------------------------------------------------------------------+ + | Status | Description | + +=========================+==============================================================================+ + | Available | DB instance is available. | + +-------------------------+------------------------------------------------------------------------------+ + | Abnormal | DB instance is abnormal. | + +-------------------------+------------------------------------------------------------------------------+ + | Creating | DB instance is being created. | + +-------------------------+------------------------------------------------------------------------------+ + | Creation failed | DB instance failed to be created. | + +-------------------------+------------------------------------------------------------------------------+ + | Rebooting | DB instance is being rebooted. | + +-------------------------+------------------------------------------------------------------------------+ + | Changing port | DB instance port is being changed. | + +-------------------------+------------------------------------------------------------------------------+ + | Changing instance class | CPU or memory of a DB instance is being changed. | + +-------------------------+------------------------------------------------------------------------------+ + | Promoting to primary | A read replica is being promoted to the primary node. | + +-------------------------+------------------------------------------------------------------------------+ + | Deleted | DB instance has been deleted and will not be displayed in the instance list. | + +-------------------------+------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/db_instance_description/index.rst b/umn/source/introduction/db_instance_description/index.rst index 28a10cb..9a44b2c 100644 --- a/umn/source/introduction/db_instance_description/index.rst +++ b/umn/source/introduction/db_instance_description/index.rst @@ -5,7 +5,7 @@ DB Instance Description ======================= -- :ref:`DB Instance Specifications ` +- :ref:`DB Instance Classes ` - :ref:`DB Engines and Versions ` - :ref:`DB Instance Statuses ` @@ -13,6 +13,6 @@ DB Instance Description :maxdepth: 1 :hidden: - db_instance_specifications + db_instance_classes db_engines_and_versions db_instance_statuses diff --git a/umn/source/introduction/product_benefits.rst b/umn/source/introduction/product_benefits.rst index a5c677e..641e289 100644 --- a/umn/source/introduction/product_benefits.rst +++ b/umn/source/introduction/product_benefits.rst @@ -7,13 +7,13 @@ Product Benefits GaussDB(for MySQL) is an enterprise-class cloud database that uses a decoupled compute and storage architecture. -Requirements ------------- +Requirements and Pain Points +---------------------------- -.. table:: **Table 1** Requirements +.. table:: **Table 1** Requirements and pain points +---------------------------------+---------------------------------------------------------------+ - | Requirements | Description | + | Requirements and Pain Points | Description | +=================================+===============================================================+ | MySQL compatibility | No need to reconstruct original MySQL applications | +---------------------------------+---------------------------------------------------------------+ diff --git a/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/creating_a_manual_backup.rst b/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/creating_a_manual_backup.rst index 20625bd..9dd53f8 100644 --- a/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/creating_a_manual_backup.rst +++ b/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/creating_a_manual_backup.rst @@ -16,9 +16,13 @@ Method 1 -------- #. 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 **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**. - 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 (_). @@ -27,13 +31,19 @@ Method 1 #. After a manual backup has been created, you can view and manage it on the **Backup Management** page. + Alternatively, click the target DB instance. On the **Backups & Restorations** page, you can view and manage the manual backups. + Method 2 -------- #. Log in to the management console. + #. Click |image2| in the upper left corner and select a region and a project. + #. Click **Service List**. Under **Database**, click **GaussDB**. + #. On the **Instance Management** page, click the target DB instance. + #. 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 (_). @@ -42,5 +52,7 @@ Method 2 #. 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 -.. |image2| image:: /_static/images/en-us_image_0000001352219100.png + Alternatively, click the target DB instance. On the **Backups & Restorations** page, you can view and manage the manual backups. + +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/deleting_a_manual_backup.rst b/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/deleting_a_manual_backup.rst index 94b27fb..c51ea42 100644 --- a/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/deleting_a_manual_backup.rst +++ b/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/deleting_a_manual_backup.rst @@ -32,4 +32,4 @@ Procedure #. Click **Yes**. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/restoring_data_from_a_backup.rst b/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/restoring_data_from_a_backup.rst index f943762..fcc2cf4 100644 --- a/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/restoring_data_from_a_backup.rst +++ b/umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/restoring_data_from_a_backup.rst @@ -37,4 +37,4 @@ Procedure A full backup is triggered after the new DB instance is created. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/data_migration/migrating_data_to_gaussdbfor_mysql_using_mysqldump.rst b/umn/source/working_with_gaussdbfor_mysql/data_migration/migrating_data_to_gaussdbfor_mysql_using_mysqldump.rst index a7fb640..75a6e54 100644 --- a/umn/source/working_with_gaussdbfor_mysql/data_migration/migrating_data_to_gaussdbfor_mysql_using_mysqldump.rst +++ b/umn/source/working_with_gaussdbfor_mysql/data_migration/migrating_data_to_gaussdbfor_mysql_using_mysqldump.rst @@ -8,7 +8,7 @@ Migrating Data to GaussDB(for MySQL) Using mysqldump Preparing for Data Migration ---------------------------- -GaussDB(for MySQL) supports public accessibility. You can access GaussDB(for MySQL) through a private network or EIP. +GaussDB(for MySQL) supports public accessibility. You can access GaussDB(for MySQL) through an ECS or EIP. #. Prepare an ECS in the same VPC subnet as GaussDB(for MySQL) or prepare a device for accessing GaussDB(for MySQL) over a public network. @@ -27,7 +27,7 @@ GaussDB(for MySQL) supports public accessibility. You can access GaussDB(for MyS .. note:: - The version of the GaussDB(for MySQL) client must be the same as or later than that of the GaussDB(for MySQL) server. The MySQL database or client provides the mysqldump and mysql tools by default. + The MySQL client version must be the same as that installed on the GaussDB(for MySQL) DB instance. The MySQL database or client provides the mysqldump and mysql tools by default. Exporting Data -------------- diff --git a/umn/source/working_with_gaussdbfor_mysql/data_security/changing_a_security_group.rst b/umn/source/working_with_gaussdbfor_mysql/data_security/changing_a_security_group.rst index 40d245e..72649fb 100644 --- a/umn/source/working_with_gaussdbfor_mysql/data_security/changing_a_security_group.rst +++ b/umn/source/working_with_gaussdbfor_mysql/data_security/changing_a_security_group.rst @@ -24,8 +24,8 @@ Procedure #. Click |image5| in the upper right corner on the **Basic Information** page to view the result of the change. This process takes about 1 to 3 minutes. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001403138685.png -.. |image3| image:: /_static/images/en-us_image_0000001403138681.png -.. |image4| image:: /_static/images/en-us_image_0000001403218681.png -.. |image5| image:: /_static/images/en-us_image_0000001402979141.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400783432.png +.. |image3| image:: /_static/images/en-us_image_0000001451103505.png +.. |image4| image:: /_static/images/en-us_image_0000001451023297.png +.. |image5| image:: /_static/images/en-us_image_0000001451183161.png diff --git a/umn/source/working_with_gaussdbfor_mysql/data_security/resetting_the_administrator_password.rst b/umn/source/working_with_gaussdbfor_mysql/data_security/resetting_the_administrator_password.rst index d321311..c431838 100644 --- a/umn/source/working_with_gaussdbfor_mysql/data_security/resetting_the_administrator_password.rst +++ b/umn/source/working_with_gaussdbfor_mysql/data_security/resetting_the_administrator_password.rst @@ -68,5 +68,5 @@ Method 2 - To submit the new password, click **OK**. - To cancel the reset, click **Cancel**. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/connection_management/binding_and_unbinding_an_eip.rst b/umn/source/working_with_gaussdbfor_mysql/database_connections/binding_and_unbinding_an_eip.rst similarity index 94% rename from umn/source/working_with_gaussdbfor_mysql/connection_management/binding_and_unbinding_an_eip.rst rename to umn/source/working_with_gaussdbfor_mysql/database_connections/binding_and_unbinding_an_eip.rst index c7698a2..db0fe85 100644 --- a/umn/source/working_with_gaussdbfor_mysql/connection_management/binding_and_unbinding_an_eip.rst +++ b/umn/source/working_with_gaussdbfor_mysql/database_connections/binding_and_unbinding_an_eip.rst @@ -33,7 +33,7 @@ Binding an EIP #. 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 for Write** field. #. In the displayed dialog box, select an EIP and click **OK**. @@ -53,8 +53,8 @@ Unbinding an EIP ---------------- #. On the **Instance Management** page, click the DB instance that has been bound with an EIP. The **Basic Information** page is displayed. -#. In the **Network Information** area, click **Unbind** in the **Public IP Address (EIP)** field. +#. In the **Network Information** area, click **Unbind** in the **Public IP Address for Write** field. #. In the displayed dialog box, click **Yes**. #. To bind an EIP to the DB instance again, see :ref:`Binding an EIP `. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/connection_management/changing_a_database_port.rst b/umn/source/working_with_gaussdbfor_mysql/database_connections/changing_a_database_port.rst similarity index 64% rename from umn/source/working_with_gaussdbfor_mysql/connection_management/changing_a_database_port.rst rename to umn/source/working_with_gaussdbfor_mysql/database_connections/changing_a_database_port.rst index a5dea2b..1d6813f 100644 --- a/umn/source/working_with_gaussdbfor_mysql/connection_management/changing_a_database_port.rst +++ b/umn/source/working_with_gaussdbfor_mysql/database_connections/changing_a_database_port.rst @@ -8,12 +8,7 @@ Changing a Database Port Scenarios --------- -You can change the database port of a GaussDB(for MySQL) instance. The change applies to the ports of the primary node and read replicas, and may affect services intermittently. - -Constraints ------------ - -The port number of the proxy instance is independent of that of the instance. Changing the port number of the DB instance does not change the port number of the proxy instance. +You can change the database port of a GaussDB(for MySQL) DB instance. The change applies to the ports of the primary node and read replicas, and may affect services intermittently. Procedure --------- @@ -41,7 +36,7 @@ Procedure #. View the result of the change on the **Basic Information** page. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352378996.png -.. |image3| image:: /_static/images/en-us_image_0000001352538852.png -.. |image4| image:: /_static/images/en-us_image_0000001403138693.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001451103533.png +.. |image3| image:: /_static/images/en-us_image_0000001400623556.png +.. |image4| image:: /_static/images/en-us_image_0000001451183189.png diff --git a/umn/source/working_with_gaussdbfor_mysql/connection_management/index.rst b/umn/source/working_with_gaussdbfor_mysql/database_connections/index.rst similarity index 86% rename from umn/source/working_with_gaussdbfor_mysql/connection_management/index.rst rename to umn/source/working_with_gaussdbfor_mysql/database_connections/index.rst index a6499bc..ad33ee5 100644 --- a/umn/source/working_with_gaussdbfor_mysql/connection_management/index.rst +++ b/umn/source/working_with_gaussdbfor_mysql/database_connections/index.rst @@ -2,8 +2,8 @@ .. _gaussdb_03_0010: -Connection Management -===================== +Database Connections +==================== - :ref:`Binding and Unbinding an EIP ` - :ref:`Changing a Database Port ` diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/assigning_read_weights.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/assigning_read_weights.rst deleted file mode 100644 index 5afccc5..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/assigning_read_weights.rst +++ /dev/null @@ -1,70 +0,0 @@ -:original_name: gaussdb_11_0018.html - -.. _gaussdb_11_0018: - -Assigning Read Weights -====================== - -After read/write splitting is enabled, you can assign read weights as required. - -Description ------------ - -- 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. -- 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. -- For details about how to assign read weights, see :ref:`Weight Assignment Rules `. - -.. _gaussdb_11_0018__en-us_topic_0200110324_section18253121664211: - -Weight Assignment Rules ------------------------ - -When the system automatically assigns read weights to read replicas, the weight values are fixed. - -.. note:: - - The default weight equals to the number of vCPUs multiplied by 50. The weight ranges from 100 to 1000. - - For example: - - - If the number of CPUs is 8, the weight is 400 (8 x 50 = 400). - - If the number of CPUs is 16, the weight is 800 (16 x 50 = 800). - - If the number of vCPUs is 32, the weight is 1000 (32 x 50 = 1600, rounded down to the maximum value within the range). - -Procedure ---------- - -#. Log in to the console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. Under **Database**, click **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**. - -#. 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 displayed dialog box, select read replicas for which you want to assign weights on the left and assign the weights on the right. - - - Different applications can connect to the instance through the read/write splitting addresses of different proxy instances. Read requests are routed to the proxy instances that applications connect to. You can also add nodes to or remove nodes from proxy instances. - - - In the read/write mode, all write requests are routed to the primary node, and read requests are routed to each node based on the read weights. - - In the read-only mode, only read requests can be routed to read replicas based on the read weights. Even if the primary node is assigned with a read weight, the weight does not take effect. - - For example, a DB instance contains one primary node and two read replicas, and two proxy instances have been enabled. Proxy instance 1 is in the read/write mode. The primary node and read replica 1 are connected to proxy instance 1 and assigned with a read weight of 100 and 200, respectively. They process read requests in the ratio of 1:2, that is, the primary node processes 1/3 read requests and read replica 1 processes 2/3 read requests. Write requests are automatically routed to the primary node. Proxy instance 2 is in read-only mode. The primary node and read replica 2 are associated with proxy instance 2 and assigned with a read weight of 100 and 200, respectively. In this case, the weight of the primary node does not take effect, and read replica 2 processes all read requests. - - - .. figure:: /_static/images/en-us_image_0000001423775818.png - :alt: **Figure 1** Ratio of read requests processed by each node in multiple proxy instances - - **Figure 1** Ratio of read requests processed by each node in multiple proxy instances - - .. note:: - - - When there are multiple proxy instances, newly created read replicas are automatically associated with proxy instances and their read weights are 0 by default. - - If you want to associate a read replica with a proxy instance, go to the **Basic Information** page, locate the read replica in the **Node List** area, and click **Associate with proxy instance**. On the displayed page, select a proxy instance and click **Assign Weight**. - - After a read replica is deleted, its weight is automatically removed while the weights of other read replicas remain unchanged. - -.. |image1| image:: /_static/images/en-us_image_0000001212611256.png diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/changing_the_read_write_splitting_address.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/changing_the_read_write_splitting_address.rst deleted file mode 100644 index 11b9aee..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/changing_the_read_write_splitting_address.rst +++ /dev/null @@ -1,44 +0,0 @@ -:original_name: gaussdb_11_0031.html - -.. _gaussdb_11_0031: - -Changing the Read/Write Splitting Address -========================================= - -Scenarios ---------- - -After read/write splitting is enabled, you can change the read/write splitting address. - -Precautions ------------ - -Changing the read/write splitting address will interrupt database connections and services. Therefore, change the read/write splitting address during off-peak hours or when services are stopped. - -Constraints ------------ - -The new IP address is not in use and must be in the same subnet as the GaussDB(for MySQL) instance. - -Procedure ---------- - -You can change the read/write splitting address for instances with read/write splitting enabled. - -#. Log in to the console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. 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. - -#. In the navigation pane on the left, click **Database Proxy**. - - Click the desired proxy instance name. In the **DB Instance Information** area, click **Change** next to the **Read/Write Splitting Address** field. - -#. In the displayed dialog box, enter a new IP address and click **OK**. - - In-use IP addresses cannot be used. - -.. |image1| image:: /_static/images/en-us_image_0000001400391461.png diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/disabling_read_write_splitting.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/disabling_read_write_splitting.rst deleted file mode 100644 index 266f9bc..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/disabling_read_write_splitting.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: gaussdb_11_0019.html - -.. _gaussdb_11_0019: - -Disabling Read/Write Splitting -============================== - -You can disable read/write splitting as required. - -Procedure ---------- - -#. 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 **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed. -#. 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**. - - .. note:: - - If database proxy is disabled, read/write splitting is also disabled and services using the read/write splitting address are interrupted. You need to switch your applications to the DB instance address. - -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_or_disabling_access_control.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_or_disabling_access_control.rst deleted file mode 100644 index 5622280..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_or_disabling_access_control.rst +++ /dev/null @@ -1,52 +0,0 @@ -:original_name: gaussdb_11_0025.html - -.. _gaussdb_11_0025: - -Enabling or Disabling Access Control -==================================== - -If load balancing is enabled for a database proxy instance, the security group associated with the proxy instance does not apply. You need to use access control to grant access from specific IP addresses. - -Enabling Access Control ------------------------ - -#. Log in to the console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. 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 **Database Proxy** page, enable access control. - - Locate the target proxy instance and click |image2| next to the **Access Control** area. - -#. Click **Configure**. In the displayed dialog box, configure the access control mode and IP addresses or CIDR blocks. - - - **Access Control**: The blacklist and whitelist cannot be configured at the same time. If you switch between lists, your previously entered settings will be lost. IP addresses or CIDR blocks in the blacklist are not allowed to access proxy instances. - - **IP Address or CIDR Block**: Enter valid IP addresses or CIDR blocks that meet the following requirements: - - - Each line contains an IP address or a CIDR block and ends with a line break. - - Each IP address or CIDR block can include a description separated by a vertical bar symbol (|), for example, 192.168.10.10|GaussDB01. The description can include up to 50 characters but cannot contain angle brackets (<>). - - Up to 300 IP addresses or CIDR blocks can be added. - -Disabling Access Control ------------------------- - -#. Log in to the console. - -#. Click |image3| in the upper left corner and select a region and a project. - -#. 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 **Database Proxy** page, disable access control. - - Locate the target proxy instance and click |image4| next to the **Access Control** area. - -.. |image1| image:: /_static/images/en-us_image_0000001400391461.png -.. |image2| image:: /_static/images/en-us_image_0000001405277053.png -.. |image3| image:: /_static/images/en-us_image_0000001400391461.png -.. |image4| image:: /_static/images/en-us_image_0000001405262769.png diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_read_write_splitting.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_read_write_splitting.rst deleted file mode 100644 index e4d087c..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/enabling_read_write_splitting.rst +++ /dev/null @@ -1,50 +0,0 @@ -:original_name: gaussdb_11_0017.html - -.. _gaussdb_11_0017: - -Enabling Read/Write Splitting -============================= - -Read/write splitting enables read and write requests to be automatically routed through a read/write splitting address. This section describes how to enable read/write splitting. - -Procedure ---------- - -#. Log in to the console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. Under **Database**, click **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**. - -#. 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**. - - - .. figure:: /_static/images/en-us_image_0000001352059444.png - :alt: **Figure 1** Enabling read/write splitting - - **Figure 1** Enabling read/write splitting - -#. Click **Create Proxy Instance**. - -#. In the displayed dialog box, configure required parameters and click **OK**. After a proxy instance has been created, you can click **Create Proxy Instance** in the **Database Proxy** page to add a new proxy instance. - - - **Proxy Instance Name**: Enter 4 to 64 characters starting with a letter. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed. - - **Proxy Mode**: Select **Read/Write** or **Read-only**. - - .. note:: - - - **Read/Write**: All write requests are forwarded only to the primary node, and all read requests are forwarded to the selected nodes based on the read weights. The default read weight of the primary node is **0**. - - **Read-only**: All read requests are forwarded to the selected read replicas based on read weights. Even if the primary node is assigned with a read weight, the weight does not take effect. - - - It supports only read requests. If write requests are forwarded to the selected nodes, an error message is displayed. - - This mode offloads the pressure of the primary node by routing all read requests to read replicas. - - DDL, DML, and temporary table operations are not supported in the read-only mode. - - - Proxy instance specifications: 2 vCPUs \| 4 GB (general-enhanced), 4 vCPUs \| 8 GB (general-enhanced), and 8 vCPUs \| 16 GB (general-enhanced). - - **Proxy Instance Nodes**: The default value is **2**. Enter an integer from 2 to 32. Number of recommended proxy instance nodes = (Number of vCPUs of the primary node + Total number of vCPUs of all read replicas)/(4 x Number of vCPUs of the proxy instance), rounded up. - - - **Read Weight**: For instances with read/write splitting enabled, you can add or delete nodes and assign weights for the primary node and read replicas. Requests are assigned to the nodes based on the read weights you specify. For example, read weights assigned to one primary node and two read replicas are 100, 200, and 200, respectively. In the read/write mode, the primary node and two read replicas process read requests in the ratio of 1:2:2. The primary node processes 20% of read requests, and each read replica processes 40% of read requests. Write requests are automatically routed to the primary node. In the read-only mode, the read weight of the primary node does not take effect, and the two read replicas process 50% of read requests, respectively. For details, see :ref:`Assigning Read Weights `. - -.. |image1| image:: /_static/images/en-us_image_0000001400391461.png diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/index.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/index.rst deleted file mode 100644 index 38084c7..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -:original_name: gaussdb_11_0050.html - -.. _gaussdb_11_0050: - -Database Proxy (Read/Write Splitting) -===================================== - -- :ref:`Introducing Read/Write Splitting ` -- :ref:`Enabling Read/Write Splitting ` -- :ref:`Changing the Read/Write Splitting Address ` -- :ref:`Assigning Read Weights ` -- :ref:`Enabling or Disabling Access Control ` -- :ref:`Disabling Read/Write Splitting ` -- :ref:`Testing Read/Write Splitting Performance ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - introducing_read_write_splitting - enabling_read_write_splitting - changing_the_read_write_splitting_address - assigning_read_weights - enabling_or_disabling_access_control - disabling_read_write_splitting - testing_read_write_splitting_performance diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/introducing_read_write_splitting.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/introducing_read_write_splitting.rst deleted file mode 100644 index 7d5d3f0..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/introducing_read_write_splitting.rst +++ /dev/null @@ -1,41 +0,0 @@ -:original_name: gaussdb_02_0011.html - -.. _gaussdb_02_0011: - -Introducing Read/Write Splitting -================================ - -Read/write splitting enables read and write requests to be automatically routed through a read/write splitting address. You can enable read/write splitting after read replicas are created by referring to :ref:`Enabling Read/Write Splitting `. Write requests are automatically routed to the primary node and read requests are routed to read replicas or the primary node by user-defined weights. - -Constraints ------------ - -- Read/write splitting can be enabled only when at least one read replica is created. -- After read/write splitting is enabled, the database port, private IP address, and security group cannot be changed. -- Proxy does not support READ-UNCOMMITTED transaction isolation. -- A maximum of four proxy instances can be created for a GaussDB(for MySQL) instance. -- To use database proxy instances, ensure that the data in a single row of a table cannot exceed 16 MB. - -- After read/write splitting is enabled, both the database port and the security group of the primary node and read replicas are changed. -- Read/write splitting does not support SSL encryption. -- Read/write splitting does not support the compression protocol. -- If multi-statements are executed, all subsequent requests will be routed to the primary node. To restore the read/write splitting function, you need to disconnect the connection between applications and the read/write splitting address and establish a connection again. -- The port number of the proxy instance is independent of that of the DB instance. Changing the port number of the DB instance does not change the port number of the proxy instance. - -Scenarios ---------- - -When enabling read/write splitting for an instance, you need to select the nodes (including the primary node and read replicas) to be associated to the proxy instances. - -- Different applications can connect to the instance through the read/write splitting addresses of different proxy instances. Read requests are routed to the proxy instances that applications connect to. You can also add nodes to or remove nodes from proxy instances. - -- A primary node or read replica can be added to multiple proxy instances at the same time, and then is assigned different read weights. For details about how to assign weights, :ref:`Assigning Read Weights `. - -- In the read/write mode, all write requests are routed to the primary node, and read requests are routed to each node based on the read weights. -- In the read-only mode, only read requests can be routed to read replicas based on the read weights. Even if the primary node is assigned with a read weight, the weight does not take effect. - - -.. figure:: /_static/images/en-us_image_0000001400271265.png - :alt: **Figure 1** Multiple proxy instances - - **Figure 1** Multiple proxy instances diff --git a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/testing_read_write_splitting_performance.rst b/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/testing_read_write_splitting_performance.rst deleted file mode 100644 index f0c29b1..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/database_proxy_read_write_splitting/testing_read_write_splitting_performance.rst +++ /dev/null @@ -1,25 +0,0 @@ -:original_name: gaussdb_11_0021.html - -.. _gaussdb_11_0021: - -Testing Read/Write Splitting Performance -======================================== - -After read/write splitting is enabled, databases can be connected through a read/write splitting address. You can use internal SQL commands to verify the read/write splitting performance. - -Procedure ---------- - -#. Use a read/write splitting address to connect to the database. For details, see :ref:`Enabling Read/Write Splitting `. - -#. Run the following command to view the routing result of the previous SQL statement. The result is the private IP address of the DB instance. - - .. code-block:: text - - show last route; - - - .. figure:: /_static/images/en-us_image_0000001420606766.png - :alt: **Figure 1** Query result - - **Figure 1** Query result diff --git a/umn/source/working_with_gaussdbfor_mysql/database_security.rst b/umn/source/working_with_gaussdbfor_mysql/database_security.rst index 850db1d..d619eec 100644 --- a/umn/source/working_with_gaussdbfor_mysql/database_security.rst +++ b/umn/source/working_with_gaussdbfor_mysql/database_security.rst @@ -11,7 +11,7 @@ Password Strength Requirements GaussDB(for MySQL) has a password security policy for newly created database users. Passwords must: - Consist of at least eight characters. -- Contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters. +- Contain at least one uppercase letter, one lowercase letter, one digit, and one special character. When you create DB instances, your password strength is checked. You can modify the password strength as user **root**. For security reasons, you are advised to use a password that is at least as strong as the default one. diff --git a/umn/source/working_with_gaussdbfor_mysql/db_instance_management/changing_a_db_instance_class.rst b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/changing_a_db_instance_class.rst new file mode 100644 index 0000000..0ddeca2 --- /dev/null +++ b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/changing_a_db_instance_class.rst @@ -0,0 +1,55 @@ +:original_name: gaussdb_03_0092.html + +.. _gaussdb_03_0092: + +Changing a DB Instance Class +============================ + +Scenarios +--------- + +You can change the CPU or memory (instance class) of a DB instance as required. If the status of a DB instance changes from **Changing instance class** to **Available**, the change is successful. + +- A DB instance cannot be deleted while its instance class is being changed. +- The instance class can be changed only at the DB instance level. The instance class of the primary node or read replicas cannot be changed separately for a GaussDB(for MySQL) DB instance. + +.. important:: + + - Changing the DB instance class will cause the instance to reboot. To prevent service interruptions, change the instance class during off-peak hours. + - To prevent traffic congestion during peak hours, you are advised to reboot the DB instance during off-peak hours. + +Procedure +--------- + +#. 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**. + +#. You can change the instance class in either of the following ways: + + - On the **Instance Management** page, locate the target DB instance and choose **More** > **Change Instance Class** 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 Class** field. + +#. On the displayed page, specify the new instance class and scheduled time, and click **Next**. + + Choose either of the following scheduled time: + + - **Upon submission**: The instance class will be changed upon the task submission. + - **In maintenance window**: The instance class will be changed in your specified maintenance window. + +#. On the displayed page, confirm the instance class. + + - If you need to modify your settings, click **Previous** to go back to the page where you specify details. + - If you do not need to modify your settings, click **Submit**. + +#. View the DB instance class change result. + + Changing the instance class takes 5-15 minutes. During this period, the status of the DB instance on the **Instance Management** page is **Changing instance class**. After a few minutes, click the instance and view the instance class on the displayed **Basic Information** page to check that the change is successful. + + .. important:: + + After the DB instance class is changed, the system will change the values of the following parameters accordingly: **innodb_buffer_pool_size**, **innodb_log_buffer_size**, **max_connections**, **innodb_buffer_pool_instances**, **innodb_page_cleaners**, **innodb_parallel_read_threads**, **innodb_read_io_threads**, **innodb_write_io_threads**, **threadpool_size** and **query_cache_size**. + +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_a_db_instance_name.rst b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/changing_a_db_instance_name.rst similarity index 87% rename from umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_a_db_instance_name.rst rename to umn/source/working_with_gaussdbfor_mysql/db_instance_management/changing_a_db_instance_name.rst index 3df5610..cbabbc0 100644 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_a_db_instance_name.rst +++ b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/changing_a_db_instance_name.rst @@ -28,5 +28,5 @@ Procedure #. View the result of the change on the **Basic Information** page. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001402858869.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400623516.png diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/deleting_a_db_instance.rst b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/deleting_a_db_instance.rst similarity index 95% rename from umn/source/working_with_gaussdbfor_mysql/instance_modifications/deleting_a_db_instance.rst rename to umn/source/working_with_gaussdbfor_mysql/db_instance_management/deleting_a_db_instance.rst index 98b9ff0..421eccb 100644 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/deleting_a_db_instance.rst +++ b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/deleting_a_db_instance.rst @@ -30,4 +30,4 @@ Procedure #. 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 **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_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/exporting_db_instance_information.rst b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/exporting_db_instance_information.rst similarity index 84% rename from umn/source/working_with_gaussdbfor_mysql/instance_modifications/exporting_db_instance_information.rst rename to umn/source/working_with_gaussdbfor_mysql/db_instance_management/exporting_db_instance_information.rst index 6e5a281..4b2d4c9 100644 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/exporting_db_instance_information.rst +++ b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/exporting_db_instance_information.rst @@ -28,7 +28,7 @@ Exporting Information About Selected DB Instances #. 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. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001403138737.png -.. |image3| image:: /_static/images/en-us_image_0000001352219100.png -.. |image4| image:: /_static/images/en-us_image_0000001352379048.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001451103469.png +.. |image3| image:: /_static/images/en-us_image_0000001400783488.png +.. |image4| image:: /_static/images/en-us_image_0000001451183121.png diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/index.rst b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/index.rst similarity index 57% rename from umn/source/working_with_gaussdbfor_mysql/instance_modifications/index.rst rename to umn/source/working_with_gaussdbfor_mysql/db_instance_management/index.rst index 3648187..741076b 100644 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/index.rst +++ b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/index.rst @@ -2,25 +2,21 @@ .. _gaussdb_03_0029: -Instance Modifications +DB Instance Management ====================== - :ref:`Changing a DB Instance Name ` -- :ref:`Changing an Instance Description ` -- :ref:`Changing vCPUs and Memory of an Instance ` +- :ref:`Changing a DB Instance Class ` - :ref:`Rebooting a DB Instance ` - :ref:`Exporting DB Instance Information ` - :ref:`Deleting a DB Instance ` -- :ref:`Upgrading the Minor Version of a DB Instance ` .. toctree:: :maxdepth: 1 :hidden: changing_a_db_instance_name - changing_an_instance_description - changing_vcpus_and_memory_of_an_instance + changing_a_db_instance_class rebooting_a_db_instance exporting_db_instance_information deleting_a_db_instance - upgrading_the_minor_version_of_a_db_instance diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/rebooting_a_db_instance.rst b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/rebooting_a_db_instance.rst similarity index 77% rename from umn/source/working_with_gaussdbfor_mysql/instance_modifications/rebooting_a_db_instance.rst rename to umn/source/working_with_gaussdbfor_mysql/db_instance_management/rebooting_a_db_instance.rst index 342de2b..14568f9 100644 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/rebooting_a_db_instance.rst +++ b/umn/source/working_with_gaussdbfor_mysql/db_instance_management/rebooting_a_db_instance.rst @@ -8,13 +8,13 @@ Rebooting a DB Instance Scenarios --------- -You may need to reboot a DB instance during maintenance. For example, after modifying some parameters, you must reboot the DB instance for the modifications to take effect. Instances cannot be rebooted when backups or read replicas are being created for them. +You may need to reboot a DB instance during maintenance. For example, after modifying some parameters, you must reboot the DB instance for the modifications to take effect. DB instances can be rebooted only when they are in the available state. They cannot be rebooted when backups or read replicas are being created for them. The time required for rebooting a DB instance depends on the crash recovery process of the DB engine. To shorten the reboot time, you are advised to reduce database activities during the reboot to reduce rollback activities of transit transactions. .. important:: - - Your database may be unavailable if, for example, data is being backed up or there are modifications being made. + - You can reboot a DB instance only when its status is **Available**. Your database may be unavailable in some cases such as data is being backed up or some modifications are being made. - Rebooting a DB instance will cause service interruption. During this period, the DB instance status is **Rebooting**. - DB instances are not available when being rebooted. After the reboot completes, the cached memory will be automatically cleared. The DB instance needs to be warmed up to prevent congestion during peak hours. @@ -37,4 +37,4 @@ Procedure #. Refresh the DB instance list and view the status of the DB instance. If its status is **Available**, it has rebooted successfully. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/index.rst b/umn/source/working_with_gaussdbfor_mysql/index.rst index b072b99..ad06fd4 100644 --- a/umn/source/working_with_gaussdbfor_mysql/index.rst +++ b/umn/source/working_with_gaussdbfor_mysql/index.rst @@ -6,9 +6,8 @@ Working with GaussDB(for MySQL) =============================== - :ref:`Data Migration ` -- :ref:`Connection Management ` -- :ref:`Database Proxy (Read/Write Splitting) ` -- :ref:`Instance Modifications ` +- :ref:`Database Connections ` +- :ref:`DB Instance Management ` - :ref:`Read Replicas ` - :ref:`Data Security ` - :ref:`Backups and Restorations ` @@ -17,16 +16,14 @@ Working with GaussDB(for MySQL) - :ref:`Monitoring ` - :ref:`Interconnection with CTS ` - :ref:`Logs ` -- :ref:`Task Center ` .. toctree:: :maxdepth: 1 :hidden: data_migration/index - connection_management/index - database_proxy_read_write_splitting/index - instance_modifications/index + database_connections/index + db_instance_management/index read_replicas/index data_security/index backups_and_restorations/index @@ -35,4 +32,3 @@ Working with GaussDB(for MySQL) monitoring/index interconnection_with_cts/index logs/index - task_center/index diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_an_instance_description.rst b/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_an_instance_description.rst deleted file mode 100644 index f775746..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_an_instance_description.rst +++ /dev/null @@ -1,42 +0,0 @@ -:original_name: gaussdb_03_0132.html - -.. _gaussdb_03_0132: - -Changing an Instance Description -================================ - -Scenarios ---------- - -After an instance is created, you can add a description. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. Click |image2| in the upper left corner of the page and choose **Databases** > **GaussDB**. In the navigation pane on the left, click **GaussDB(for MySQL)**. - -#. On the **Instances** page, locate the instance that you want to edit the description for and click |image3| in the **Description** column to edit the instance description. Then, click **OK**. - - Alternatively, click the instance name to go to the **Basic Information** page. In the **DB Instance Information** area, click |image4| in the **Description** field to edit the instance description. - - .. note:: - - The instance description can contain up to 64 characters, and cannot start with and end with a space. Only letters, digits, hyphens (-), underscores (_), periods (.), and spaces are allowed. - - - To submit the change, click |image5|. - - To cancel the change, click |image6|. - -#. View the results on the **Basic Information** page. - - Alternatively, view the results on the **Instances** page. - -.. |image1| image:: /_static/images/en-us_image_0218527002.png -.. |image2| image:: /_static/images/en-us_image_0000001563934877.png -.. |image3| image:: /_static/images/en-us_image_0000001513008494.png -.. |image4| image:: /_static/images/en-us_image_0000001513008494.png -.. |image5| image:: /_static/images/en-us_image_0000001563528757.png -.. |image6| image:: /_static/images/en-us_image_0000001512768946.png diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_vcpus_and_memory_of_an_instance.rst b/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_vcpus_and_memory_of_an_instance.rst deleted file mode 100644 index efadcd2..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/changing_vcpus_and_memory_of_an_instance.rst +++ /dev/null @@ -1,50 +0,0 @@ -:original_name: gaussdb_03_0092.html - -.. _gaussdb_03_0092: - -Changing vCPUs and Memory of an Instance -======================================== - -Scenarios ---------- - -You can change the vCPUs or memory of a DB instance as required. If the status of a DB instance changes from **Changing instance specifications** to **Available**, the change is successful. - -- An instance cannot be deleted when its specifications are being changed. -- The vCPUs and memory can be changed only at the instance level. The specifications of the primary node or read replicas cannot be changed separately for a given instance. - -.. important:: - - - Changing the CPU and memory specifications will cause the instance to reboot. To prevent service interruptions, change the instance specifications during off-peak hours. - - To prevent traffic congestion during peak hours, you are advised to reboot the DB instance during off-peak hours. - -Procedure ---------- - -#. 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**. - -#. You can change the instance specifications in either of the following ways: - - - 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. - -#. On the displayed page, specify the new instance specifications, and click **Next**. - -#. On the displayed page, confirm the instance specifications. - - - If you need to modify your settings, click **Previous** to go back to the page where you specify details. - - If you do not need to modify your settings, click **Submit**. - -#. 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 **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:: - - After the specifications of DB instances 8.0 are changed, the system will change the values of the following parameters accordingly: **innodb_buffer_pool_size**, **innodb_log_buffer_size**, **max_connections**, **innodb_buffer_pool_instances**, **innodb_page_cleaners**, **innodb_parallel_read_threads**, **innodb_read_io_threads**, **innodb_write_io_threads**, **threadpool_size** and **query_cache_size**. - -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png diff --git a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/upgrading_the_minor_version_of_a_db_instance.rst b/umn/source/working_with_gaussdbfor_mysql/instance_modifications/upgrading_the_minor_version_of_a_db_instance.rst deleted file mode 100644 index 41cdc7a..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/instance_modifications/upgrading_the_minor_version_of_a_db_instance.rst +++ /dev/null @@ -1,40 +0,0 @@ -:original_name: gaussdb_05_2265.html - -.. _gaussdb_05_2265: - -Upgrading the Minor Version of a DB Instance -============================================ - -Scenario --------- - -GaussDB(for MySQL) supports manual minor version upgrades, which can improve performance, add new functions, and fix bugs. - -Precautions ------------ - -- The upgrade will cause the instance to reboot and briefly interrupt services. To limit the impact of the upgrade, perform the upgrade during off-peak hours, or ensure that your applications support automatic reconnection. -- If an instance contains a large number of table partitions (more than 1 million), it may take more than 2 hours to reboot the instance. -- If the primary node and read replicas of an instance are deployed in the same AZ, a minor version upgrade will trigger a failover. If they are in different AZs, a minor version upgrade will trigger two failovers. A failover means that the system fails over to a read replica in case the primary node is unavailable. -- When you upgrade a minor version of an instance, minor versions of read replicas (if any) will also be upgraded automatically. Minor versions of read replicas cannot be upgraded separately. A minor version upgrade cannot be rolled back after the upgrade is complete. -- DDL operations, such as CREATE EVENT, DROP EVENT, and ALTER EVENT, are not allowed during a minor version upgrade. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. Click |image2| in the upper left corner of the page and choose **Database** > **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. - -#. In the **DB Instance Information** area, click **Upgrade** in the **DB Engine Version** field. - -#. In the displayed dialog box, select a scheduled time and click **OK**. - - Upon submission: The system upgrades the minor version immediately after your submission of the upgrade request. After the operation is complete, in the **Task Center** page, click **Instant Tasks** and view the information about the upgrade task. - -.. |image1| image:: /_static/images/en-us_image_0218527002.png -.. |image2| image:: /_static/images/en-us_image_0000001480810240.png diff --git a/umn/source/working_with_gaussdbfor_mysql/interconnection_with_cts/viewing_tracing_events.rst b/umn/source/working_with_gaussdbfor_mysql/interconnection_with_cts/viewing_tracing_events.rst index ab2a947..4c957ef 100644 --- a/umn/source/working_with_gaussdbfor_mysql/interconnection_with_cts/viewing_tracing_events.rst +++ b/umn/source/working_with_gaussdbfor_mysql/interconnection_with_cts/viewing_tracing_events.rst @@ -17,7 +17,7 @@ Procedure #. Log in to the management console. -#. Choose **Management & Deployment** > **Cloud Trace Service**. +#. Choose **Management & Governance** > **Cloud Trace Service**. #. Choose **Trace List** in the navigation pane on the left. @@ -43,4 +43,4 @@ Procedure For details about key fields in the trace structure, see sections "Trace Structure" and "Trace Examples" in the *Cloud Trace Service User Guide*. -.. |image1| image:: /_static/images/en-us_image_0000001472729081.png +.. |image1| image:: /_static/images/en-us_image_0192953998.png diff --git a/umn/source/working_with_gaussdbfor_mysql/logs/enabling_or_disabling_sql_explorer.rst b/umn/source/working_with_gaussdbfor_mysql/logs/enabling_or_disabling_sql_explorer.rst deleted file mode 100644 index de84cbe..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/logs/enabling_or_disabling_sql_explorer.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: gaussdb_03_0152.html - -.. _gaussdb_03_0152: - -Enabling or Disabling SQL Explorer -================================== - -Enabling SQL Explorer will allow GaussDB(for MySQL) to store all SQL statement logs for analysis. - -By default, SQL Explorer is disabled for GaussDB(for MySQL). This section describes how to enable and disable SQL Explorer. - -Enabling SQL Explorer ---------------------- - -#. Log in to the console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. 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. - -#. In the navigation pane on the left, choose **Advanced O&M**. - -#. In the **SQL Explorer** tab, set |image2| to |image3|. In the displayed dialog box, select **I have read the agreement and agree to having my data stored**, and click **OK**. - - - .. figure:: /_static/images/en-us_image_0000001446730040.png - :alt: **Figure 1** Enabling SQL Explorer - - **Figure 1** Enabling SQL Explorer - - .. note:: - - SQL data is stored for 1 day by default and will be automatically deleted after that time expires. - -Disabling SQL Explorer ----------------------- - -#. Log in to the console. -#. Click |image4| in the upper left corner and select a region and a project. -#. 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. -#. In the navigation pane on the left, choose **Advanced O&M**. Click **SQL Explorer** and set |image5| to |image6|. - -.. |image1| image:: /_static/images/en-us_image_0000001400391461.png -.. |image2| image:: /_static/images/en-us_image_0000001496610421.png -.. |image3| image:: /_static/images/en-us_image_0000001497009921.png -.. |image4| image:: /_static/images/en-us_image_0000001400391461.png -.. |image5| image:: /_static/images/en-us_image_0000001496889725.png -.. |image6| image:: /_static/images/en-us_image_0000001497009925.png diff --git a/umn/source/working_with_gaussdbfor_mysql/logs/index.rst b/umn/source/working_with_gaussdbfor_mysql/logs/index.rst index cbfefe5..99d62f5 100644 --- a/umn/source/working_with_gaussdbfor_mysql/logs/index.rst +++ b/umn/source/working_with_gaussdbfor_mysql/logs/index.rst @@ -8,7 +8,6 @@ Logs - :ref:`Viewing Logs ` - :ref:`Viewing Error Logs ` - :ref:`Viewing Slow Query Logs ` -- :ref:`Enabling or Disabling SQL Explorer ` .. toctree:: :maxdepth: 1 @@ -17,4 +16,3 @@ Logs viewing_logs viewing_error_logs viewing_slow_query_logs - enabling_or_disabling_sql_explorer diff --git a/umn/source/working_with_gaussdbfor_mysql/logs/viewing_error_logs.rst b/umn/source/working_with_gaussdbfor_mysql/logs/viewing_error_logs.rst index 44ceccd..b535a53 100644 --- a/umn/source/working_with_gaussdbfor_mysql/logs/viewing_error_logs.rst +++ b/umn/source/working_with_gaussdbfor_mysql/logs/viewing_error_logs.rst @@ -27,4 +27,4 @@ Viewing Log Details - FATAL - NOTE -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/logs/viewing_slow_query_logs.rst b/umn/source/working_with_gaussdbfor_mysql/logs/viewing_slow_query_logs.rst index 8664334..984ff64 100644 --- a/umn/source/working_with_gaussdbfor_mysql/logs/viewing_slow_query_logs.rst +++ b/umn/source/working_with_gaussdbfor_mysql/logs/viewing_slow_query_logs.rst @@ -37,4 +37,4 @@ Viewing Log Details You can view the slow query log records of a specified execution statement type or a specific time period. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/monitoring/setting_alarm_rules.rst b/umn/source/working_with_gaussdbfor_mysql/monitoring/setting_alarm_rules.rst index c6b35c9..b7f5ba2 100644 --- a/umn/source/working_with_gaussdbfor_mysql/monitoring/setting_alarm_rules.rst +++ b/umn/source/working_with_gaussdbfor_mysql/monitoring/setting_alarm_rules.rst @@ -37,5 +37,5 @@ Procedure For operation details, see the *Cloud Eye User Guide*. -.. |image1| image:: /_static/images/en-us_image_0000001403218685.png -.. |image2| image:: /_static/images/en-us_image_0000001352538844.png +.. |image1| image:: /_static/images/en-us_image_0000001400943280.png +.. |image2| image:: /_static/images/en-us_image_0000001451183173.png diff --git a/umn/source/working_with_gaussdbfor_mysql/monitoring/viewing_monitoring_metrics.rst b/umn/source/working_with_gaussdbfor_mysql/monitoring/viewing_monitoring_metrics.rst index a4a5c88..ad78d30 100644 --- a/umn/source/working_with_gaussdbfor_mysql/monitoring/viewing_monitoring_metrics.rst +++ b/umn/source/working_with_gaussdbfor_mysql/monitoring/viewing_monitoring_metrics.rst @@ -49,4 +49,4 @@ Procedure Cloud Eye can monitor performance metrics from the last 1 hour, last 3 hours, last 12 hours, last 24 hours or last 7 days. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/applying_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/applying_a_parameter_template.rst index dd4c2bf..219889a 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/applying_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/applying_a_parameter_template.rst @@ -33,4 +33,4 @@ Procedure After the parameter template applies to DB instances successfully, you can view the application records by referring to :ref:`Viewing Application Records of a Parameter Template `. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/comparing_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/comparing_a_parameter_template.rst index 126e104..504ed70 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/comparing_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/comparing_a_parameter_template.rst @@ -8,9 +8,9 @@ Comparing a Parameter Template Scenarios --------- -You can compare DB instance parameters with a parameter template that uses the same DB engine to inspect the differences of parameter settings. +You can compare DB instance parameters with a parameter template that uses the same DB engine to understand the differences of parameter settings. -You can also compare default parameter templates that use the same DB engine to inspect the differences of parameter settings. +You can also compare default parameter templates that use the same DB engine to understand the differences of parameter settings. Comparing Instance Parameters with a Parameter Template ------------------------------------------------------- @@ -37,5 +37,5 @@ Comparing Parameter Templates - If their settings are different, the parameter names and values of both parameter templates are displayed. - If their settings are the same, no data is displayed. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/creating_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/creating_a_parameter_template.rst index 88e4d7b..a77c576 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/creating_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/creating_a_parameter_template.rst @@ -33,4 +33,4 @@ Procedure - The template name must consist of 1 to 64 characters. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.). - The description consists of a maximum of 256 characters and cannot contain the carriage return character or the following special characters: >!<"&'= -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/deleting_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/deleting_a_parameter_template.rst index f9073e4..e1d8d9f 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/deleting_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/deleting_a_parameter_template.rst @@ -8,7 +8,7 @@ Deleting a Parameter Template Scenarios --------- -You can delete a custom parameter template that is no longer needed. +You can delete a custom parameter template that is no longer in use. .. important:: @@ -24,4 +24,4 @@ Procedure #. 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**. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/exporting_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/exporting_a_parameter_template.rst new file mode 100644 index 0000000..b959734 --- /dev/null +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/exporting_a_parameter_template.rst @@ -0,0 +1,42 @@ +:original_name: gaussdb_08_0042.html + +.. _gaussdb_08_0042: + +Exporting a Parameter Template +============================== + +Scenarios +--------- + +- You can export a parameter template of a DB instance for future use. You can apply the exported parameter template to DB instances by referring to :ref:`Applying a Parameter Template `. +- You can export the parameter template details (parameter names, values, and descriptions) of a DB instance to a CSV file for review and analysis. + +Procedure +--------- + +#. 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 **Instance Management** page, click the target DB instance. +#. In the navigation pane on the left, choose **Parameters**. On the displayed page, click **Export** above the parameter list. + + - Exporting to a custom template + + In the displayed dialog box, configure required details and click **OK**. + + .. note:: + + - The template name consists of 1 to 64 characters. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.). + - The template description consists of a maximum of 256 characters and cannot include carriage returns or the following special characters: >!<"&'= + + After the parameter template is exported, a new template is generated in the list on the **Parameter Template Management** page. + + - Exporting to a file + + The parameter template information (parameter names, values, and descriptions) of a DB instance is exported to a CSV file. In the displayed dialog box, enter the file name and click **OK**. + + .. note:: + + The file name must start with a letter and consist of 4 to 64 characters. It can contain only letters, digits, hyphens (-), and underscores (_). + +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/exporting_parameters.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/exporting_parameters.rst deleted file mode 100644 index d117bb7..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/exporting_parameters.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: gaussdb_08_0042.html - -.. _gaussdb_08_0042: - -Exporting Parameters -==================== - -Scenarios ---------- - -- You can export a parameter template of a DB instance for future use. You can apply the exported parameter template to DB instances by referring to :ref:`Applying a Parameter Template `. -- You can export the parameter template details (parameter names, values, and descriptions) of a DB instance to a CSV file for review and analysis. - -Procedure ---------- - -#. 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 **Instance Management** page, click the target DB instance. - -#. In the navigation pane on the left, choose **Parameters**. On the displayed page, click **Export** above the parameter list. - - The parameter template information (parameter names, values, and descriptions) of a DB instance is exported to a CSV file. In the displayed dialog box, enter the file name and click **OK**. You can export parameter template details (parameter names, values, and descriptions) of an instance to a CSV file for review and analysis. - - .. note:: - - The file name contains 4 to 81 characters and must start with a letter. It can contain only letters, digits, hyphens (-), and underscores (_). - -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/index.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/index.rst index d9c846a..e99f0f8 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/index.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/index.rst @@ -7,7 +7,7 @@ Parameter Template Management - :ref:`Creating a Parameter Template ` - :ref:`Modifying a Parameter Template ` -- :ref:`Exporting Parameters ` +- :ref:`Exporting a Parameter Template ` - :ref:`Comparing a Parameter Template ` - :ref:`Viewing Parameter Change History ` - :ref:`Replicating a Parameter Template ` @@ -23,7 +23,7 @@ Parameter Template Management creating_a_parameter_template modifying_a_parameter_template - exporting_parameters + exporting_a_parameter_template comparing_a_parameter_template viewing_parameter_change_history replicating_a_parameter_template diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template.rst index 33c3dd7..7db5324 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template.rst @@ -36,7 +36,7 @@ Modifying Parameter Template Parameters - To cancel the modifications, click **Cancel**. - To preview the modifications, click **Preview**. -#. After the parameters have been modified, you can click **Change History** to view the modification details. +#. After the parameters are modified, you can click **Change History** to view the modification details. .. important:: @@ -62,10 +62,12 @@ Modifying Instance Parameters .. important:: + After you modify instance parameters, the modifications immediately take effect for the DB instance. + Check the value in the **Effective upon Reboot** column. - - If the value is **Yes** and the DB instance status on the **Instance Management** page is **Pending reboot**, you must reboot the DB instance for the modifications of this parameter to take effect. - - If the value is **No**, the modification of this parameter takes effect immediately. + - If the value is **Yes** and the DB instance status on the **Instance Management** page is **Pending reboot**, you must reboot the DB instance for the modifications to take effect. + - If the value is **No**, the modifications take effect immediately. - To save the modifications, click **Save**. - To cancel the modifications, click **Cancel**. @@ -73,5 +75,5 @@ Modifying Instance Parameters After parameters are modified, you can click **Change History** to view parameter modification details. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template_description.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template_description.rst index eb8e84a..d1c33e3 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template_description.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/modifying_a_parameter_template_description.rst @@ -26,7 +26,7 @@ Procedure - After you submit the modification, you can view the new description in the **Description** column. - The description consists of 256 characters but cannot contain the following special characters: >!<"&'= -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352379036.png -.. |image3| image:: /_static/images/en-us_image_0000001402858853.png -.. |image4| image:: /_static/images/en-us_image_0000001403138721.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400943340.png +.. |image3| image:: /_static/images/en-us_image_0000001401103308.png +.. |image4| image:: /_static/images/en-us_image_0000001451183233.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/replicating_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/replicating_a_parameter_template.rst index a2f1beb..15676df 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/replicating_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/replicating_a_parameter_template.rst @@ -34,4 +34,4 @@ Procedure After the parameter template is replicated, a new template is generated in the list in the **Customer Templates** tab of the **Parameter Template Management** page. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/resetting_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/resetting_a_parameter_template.rst index e5d04c8..0ca0d69 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/resetting_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/resetting_a_parameter_template.rst @@ -19,4 +19,8 @@ Procedure #. On the **Parameter Template Management** page, click **Custom Templates**. Locate the target parameter template and choose **More** > **Reset** in the **Operation** column. #. Click **Yes**. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png + .. note:: + + After you reset a parameter template, click the DB instance to which the parameter template is applied to view the status of the parameter template. On the displayed **Basic Information** page, if the status of the parameter template is **Pending reboot**, you must reboot the DB instance for the reset to take effect. + +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_application_records_of_a_parameter_template.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_application_records_of_a_parameter_template.rst index f2082d3..10715fc 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_application_records_of_a_parameter_template.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_application_records_of_a_parameter_template.rst @@ -19,8 +19,8 @@ Procedure #. Click **Service List**. Under **Database**, click **GaussDB**. -#. Choose **Parameter Template Management** in the navigation pane on the left, locate the target parameter template, and click **View Application Record** in the **Operation** column on the **Default Templates** page or choose **More** > **View Application Record** on the **Custom Templates** page. +#. After a parameter template applies to a DB instance successfully, choose **Parameter Template Management** in the navigation pane on the left, locate the target parameter template, and click **View Application Record** in the **Operation** column on the **Default Templates** page or choose **More** > **View Application Record** on the **Custom Templates** page. You can view the name or ID of the DB instance to which the parameter template applies, as well as the application status, application time, and failure cause. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_parameter_change_history.rst b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_parameter_change_history.rst index ddbf6af..477a2cb 100644 --- a/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_parameter_change_history.rst +++ b/umn/source/working_with_gaussdbfor_mysql/parameter_template_management/viewing_parameter_change_history.rst @@ -46,5 +46,5 @@ Viewing Change History of a Parameter Template You can view the parameter name, original parameter value, new parameter value, modification status, and modification time. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/read_replicas/creating_a_read_replica.rst b/umn/source/working_with_gaussdbfor_mysql/read_replicas/creating_a_read_replica.rst index aaeb7af..4fc9d51 100644 --- a/umn/source/working_with_gaussdbfor_mysql/read_replicas/creating_a_read_replica.rst +++ b/umn/source/working_with_gaussdbfor_mysql/read_replicas/creating_a_read_replica.rst @@ -26,11 +26,11 @@ Procedure #. On the **Instance Management** page, locate the target DB instance and choose **More** > **Create Read Replica** in the **Operation** column. - Alternatively, click the target DB instance. In the **DB Instance Topology** area on the **Basic Information** page, click |image2| to create read replicas. + Alternatively, click the target DB instance. In the topology on the **Basic Information** page, click |image2| to create read replicas. #. On the displayed page, specify **Failover Priority** and **Quantity** and then click **Create Now**. #. After read replicas are created, you can manage them following the instructions provided in :ref:`Managing a Read Replica `. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001403218753.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png +.. |image2| image:: /_static/images/en-us_image_0000001451023269.png diff --git a/umn/source/working_with_gaussdbfor_mysql/read_replicas/deleting_a_read_replica.rst b/umn/source/working_with_gaussdbfor_mysql/read_replicas/deleting_a_read_replica.rst index d9ac289..26bd762 100644 --- a/umn/source/working_with_gaussdbfor_mysql/read_replicas/deleting_a_read_replica.rst +++ b/umn/source/working_with_gaussdbfor_mysql/read_replicas/deleting_a_read_replica.rst @@ -37,4 +37,4 @@ Procedure #. 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_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/read_replicas/introducing_read_replicas.rst b/umn/source/working_with_gaussdbfor_mysql/read_replicas/introducing_read_replicas.rst index 58ba135..9180011 100644 --- a/umn/source/working_with_gaussdbfor_mysql/read_replicas/introducing_read_replicas.rst +++ b/umn/source/working_with_gaussdbfor_mysql/read_replicas/introducing_read_replicas.rst @@ -28,7 +28,7 @@ Constraints - A DB instance contains up to 15 read replicas. - Read replicas do not support backup settings or temporary backups. -- Read replicas do not support instance creation at any point of time or restoration from backup files to the original instance to overwrite data. +- Read replicas do not support instance creation at any time point or restoration from backup files to the original instance to overwrite data. - Data cannot be migrated to read replicas. - Read replicas do not support database creation and deletion. - Read replicas do not support account creation. You can create accounts only on the primary node. diff --git a/umn/source/working_with_gaussdbfor_mysql/read_replicas/managing_a_read_replica.rst b/umn/source/working_with_gaussdbfor_mysql/read_replicas/managing_a_read_replica.rst index 7b57cd8..4efe112 100644 --- a/umn/source/working_with_gaussdbfor_mysql/read_replicas/managing_a_read_replica.rst +++ b/umn/source/working_with_gaussdbfor_mysql/read_replicas/managing_a_read_replica.rst @@ -16,4 +16,4 @@ Procedure #. Click the target DB instance to go to the **Basic Information** page. #. At the bottom of the **Basic Information** page, you can view and manage all read replicas associated with the DB instance. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/read_replicas/promoting_a_read_replica_to_the_primary_node.rst b/umn/source/working_with_gaussdbfor_mysql/read_replicas/promoting_a_read_replica_to_the_primary_node.rst index 77cd45b..55f529c 100644 --- a/umn/source/working_with_gaussdbfor_mysql/read_replicas/promoting_a_read_replica_to_the_primary_node.rst +++ b/umn/source/working_with_gaussdbfor_mysql/read_replicas/promoting_a_read_replica_to_the_primary_node.rst @@ -42,7 +42,7 @@ Each read replica has a failover priority that determines the order in which it GaussDB(for MySQL) selects a read replica and promotes it to the new primary node as follows: #. Find all read replicas that are available for a promotion. -#. Find one or more read replicas with the highest priority. -#. If the promotion fails due to network faults or abnormal replication status, GaussDB(for MySQL) attempts to promote another read replica by priority until the promotion is successful. +#. Fine one or more read replicas with the highest priority. +#. Promote an arbitrary read replica with the highest priority. If the promotion fails due to network faults or abnormal replication status, GaussDB(for MySQL) attempts to promote another read replica by priority until the promotion is successful. -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png +.. |image1| image:: /_static/images/en-us_image_0000001400783488.png diff --git a/umn/source/working_with_gaussdbfor_mysql/task_center/deleting_a_task_record.rst b/umn/source/working_with_gaussdbfor_mysql/task_center/deleting_a_task_record.rst deleted file mode 100644 index 51bf3bb..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/task_center/deleting_a_task_record.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: gaussdb_task_0002.html - -.. _gaussdb_task_0002: - -Deleting a Task Record -====================== - -You can delete the task records no longer need to be displayed. The deletion only deletes the task records, and does not delete the DB instances or terminate the tasks that are being executed. - -.. important:: - - Deleted task records cannot be recovered. Exercise caution when performing this operation. - -Procedure ---------- - -#. 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**. - -#. Choose **Task Center** in the navigation pane on the left. On the displayed page, locate the task record to be deleted and click **Delete** in the **Operation** column. In the displayed dialog box, click **Yes**. - - You can delete instant task records in the following statuses: - - - Running - - Completed - - Failed - -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png diff --git a/umn/source/working_with_gaussdbfor_mysql/task_center/index.rst b/umn/source/working_with_gaussdbfor_mysql/task_center/index.rst deleted file mode 100644 index c3b2ee8..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/task_center/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: gaussdb_05_0007.html - -.. _gaussdb_05_0007: - -Task Center -=========== - -- :ref:`Viewing a Task ` -- :ref:`Deleting a Task Record ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - viewing_a_task - deleting_a_task_record diff --git a/umn/source/working_with_gaussdbfor_mysql/task_center/viewing_a_task.rst b/umn/source/working_with_gaussdbfor_mysql/task_center/viewing_a_task.rst deleted file mode 100644 index 020a5b4..0000000 --- a/umn/source/working_with_gaussdbfor_mysql/task_center/viewing_a_task.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: gaussdb_task_0001.html - -.. _gaussdb_task_0001: - -Viewing a Task -============== - -You can view the progresses and results of tasks on the **Task Center** page. - -.. note:: - - You can view and manage the following tasks: - - - Creating a DB instance - - Rebooting a DB instance - - Deleting a DB Instance - - Binding an EIP to a DB Instance - - Unbinding an EIP from a DB instance - - Changing instance specifications - - Promoting a read replica to the new primary node - - Changing a database port - - Changing a security group - - Creating a read replica - - Deleting a read replica - - Restoring data to a new DB instance - -Procedure ---------- - -#. 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**. -#. In the navigation pane on the left, choose **Task Center**. Locate the task and view its details. - - - To identify the task, you can use the task name/ID or instance name/ID. Alternatively, click the drop-down list of **All task types** in the upper right corner and enter or select the task name. - - - You can click |image2| in the right corner to view the progress and status of tasks in a specific period. The default period is seven days. - - The task list can only show up to 30 days of past tasks. - - - You can view tasks with the following statuses: - - - Running - - Completed - - Failed - -.. |image1| image:: /_static/images/en-us_image_0000001352219100.png -.. |image2| image:: /_static/images/en-us_image_0000001525318837.png