Update content

umn/source/change_history.rst

@@ -0,0 +1,24 @@
+:original_name: change_history.html
+
+.. _change_history:
+
+Change History
+==============
+
++-----------------------------------+------------------------------------------------------------------------------------+
+| Released On                       | Description                                                                        |
++===================================+====================================================================================+
+| 2022-10-30                        | This is the third official release.                                                |
+|                                   |                                                                                    |
+|                                   | Optimized the content in :ref:`Step 1: Create a DB Instance <gaussdb_02_0012>`.    |
++-----------------------------------+------------------------------------------------------------------------------------+
+| 2020-07-31                        | This is the second official release.                                               |
+|                                   |                                                                                    |
+|                                   | Modified the following content:                                                    |
+|                                   |                                                                                    |
+|                                   | -  Product description in :ref:`What Is GaussDB(for MySQL)? <introduction>`        |
+|                                   |                                                                                    |
+|                                   | -  Instance specifications in :ref:`Table 1 <gaussdb_01_0004__table184840323593>`. |
++-----------------------------------+------------------------------------------------------------------------------------+
+| 2020-07-14                        | This issue is the first official release.                                          |
++-----------------------------------+------------------------------------------------------------------------------------+

umn/source/conf.py

@@ -24,8 +24,11 @@ extensions = [
 otcdocs_auto_name = False
 otcdocs_auto_version = False
 
-project = 'GaussDB Enterprise-class Distributed Database compatible with MySQL'
+project = 'GaussDB (for MySQL)'
 otcdocs_repo_name = 'docs/gaussdb-mysql'
+# Those variables are required for edit/bug links
+otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
+otcdocs_git_type = 'gitea'
 
 # 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
@@ -35,6 +38,9 @@ sys.path.insert(0, os.path.abspath('../'))
 sys.path.insert(0, os.path.abspath('./'))
 
 # -- General configuration ----------------------------------------------------
+# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not
+# what it is expected
+smartquotes = False
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -72,14 +78,15 @@ html_theme = 'otcdocs'
 # further. For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'disable_search': True,
-    'site_name': 'Internal Documentation Portal'
+    "disable_search": True,
+    "site_name": "Internal Documentation Portal",
+    "logo_url": "https://docs-int.otc-service.com",
 }
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 
-html_title = "GaussDB Enterprise-class Distributed Database compatible with MySQL - User Guide"
+html_title = "GaussDB (for MySQL) - User Guide"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -89,8 +96,8 @@ html_static_path = ['_static']
 
 # -- Options for PDF output --------------------------------------------------
 latex_documents = [
-('index',
+    ('index',
      'gaussdb_mysql-umn.tex',
-     u'GaussDB Enterprise-class Distributed Database compatible with MySQL - User Guide',
+     u'GaussDB (for MySQL) - User Guide',
      u'OpenTelekomCloud', 'manual'),
 ]

umn/source/faqs/does_gaussdbfor_mysql_support_automatic_failover.rst

@@ -0,0 +1,8 @@
+:original_name: gaussdb_faq_0005.html
+
+.. _gaussdb_faq_0005:
+
+Does GaussDB(for MySQL) Support Automatic Failover?
+===================================================
+
+During the creation of a GaussDB(for MySQL) DB instance, a read replica is created by default in addition to a primary node. If the primary node fails, the system automatically fails over to a read replica with the highest priority and the original primary node is restored in the background.

umn/source/faqs/does_gaussdbfor_mysql_support_compute_and_storage_decoupling.rst

@@ -0,0 +1,8 @@
+:original_name: gaussdb_faq_0002.html
+
+.. _gaussdb_faq_0002:
+
+Does GaussDB(for MySQL) Support Compute and Storage Decoupling?
+===============================================================
+
+GaussDB(for MySQL) supports the decoupling of compute and storage, improving your experience in terms of high availability, backup and restoration, upgrade and capacity expansion.

umn/source/faqs/how_can_i_import_the_root_certificate_to_a_windows_or_linux_os.rst

@@ -0,0 +1,34 @@
+:original_name: gaussdb_faq_0010.html
+
+.. _gaussdb_faq_0010:
+
+How Can I Import the Root Certificate to a Windows or Linux OS?
+===============================================================
+
+Importing the Root Certificate to the Windows OS
+------------------------------------------------
+
+#. Click **Start** and choose **Run**. In the displayed **Run** dialog box, enter **MMC** and press **Enter**.
+#. On the displayed console, choose **File** > **Add/Remove Snap-in**.
+#. In the left **Available snap-ins** pane of the displayed **Add or Remove Snap-ins** dialog box, select **Certificates** and click **Add**.
+#. In the displayed **Certificates snap-in** dialog box, select **Computer account** and click **Next**.
+#. In the displayed **Select Computer** dialog box, click **Finish**.
+#. In the **Add or Remove Snap-ins** dialog box, click **OK**.
+#. On the console, double-click **Certificates**.
+#. Right-click **Trusted Root Certification Authorities** and choose **All Tasks** > **Import**.
+#. In the displayed **Certificate Import Wizard** dialog box, click **Next**.
+#. Click **Browse** to change the file type to **All Files (*.*)**.
+#. Locate the downloaded root certificate ca.pem file and click **Open**. Then, click **Next**.
+
+   .. important::
+
+      You must change the file type to **All Files (*.*)** because **.pem** is not a standard certificate extension name.
+
+#. Click **Next**.
+#. Click **Finish**.
+#. Click **OK** to complete the import of the root certificate.
+
+Importing the Root Certificate to the Linux OS
+----------------------------------------------
+
+You can use a connection tool (such as WinSCP or PuTTY) to upload the certificate to any directory on a Linux OS.

umn/source/faqs/how_can_i_install_the_mysql_client.rst

@@ -0,0 +1,51 @@
+:original_name: gaussdb_faq_0011.html
+
+.. _gaussdb_faq_0011:
+
+How Can I Install the MySQL Client?
+===================================
+
+MySQL provides client installation packages for different OSs on its official website. Click `here <https://dev.mysql.com/downloads/mysql/8.0.html#downloads>`__ to download the MySQL 8.0 client installation package or click `here <http://downloads.mysql.com/archives/community/>`__ to download the packages of other versions. The following uses Red Hat Linux as an example to show how to obtain the required installation package and install it.
+
+Procedure
+---------
+
+#. Obtain the installation package.
+
+   Find the `link <https://dev.mysql.com/downloads/file/?id=496982>`__ 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_0000001400783516.png
+      :alt: **Figure 1** Download
+
+      **Figure 1** Download
+
+   .. note::
+
+      Click `No thanks, just start my download. <http://dev.mysql.com/get/Downloads/MySQL-8.0/mysql-community-client-8.0.21-1.el6.x86_64.rpm>`__ to download the installation package.
+
+#. Upload the installation package to the ECS.
+
+   .. note::
+
+      When you create an ECS, select an OS, such as Red Hat 6.6, and bind an EIP to it. Then, upload the installation package to the ECS using a remote connection tool, and use PuTTY to connect to the ECS.
+
+#. Run the following command to install the MySQL client:
+
+   .. code-block::
+
+      sudo rpm -ivh mysql-community-client-8.0.21-1.el6.x86_64.rpm
+
+   .. note::
+
+      -  If any conflicts occur during the installation, add the **replacefiles** parameter to the command and try to install the client again. Example:
+
+         .. code-block::
+
+            rpm -ivh --replacefiles mysql-community-client-8.0.21-1.el6.x86_64.rpm
+
+      -  If a message is displayed prompting you to install a dependency package, you can add the **nodeps** parameter to the command and install the client again. Example:
+
+         .. code-block::
+
+            rpm -ivh --nodeps mysql-community-client-8.0.21-1.el6.x86_64.rpm

umn/source/faqs/how_many_read_replicas_can_i_create_for_a_gaussdbfor_mysql_db_instance.rst

@@ -0,0 +1,8 @@
+:original_name: gaussdb_faq_0007.html
+
+.. _gaussdb_faq_0007:
+
+How Many Read Replicas Can I Create for a GaussDB(for MySQL) DB Instance?
+=========================================================================
+
+You can create a maximum of 15 read replicas for a GaussDB(for MySQL) DB instance.

umn/source/faqs/index.rst

@@ -0,0 +1,28 @@
+:original_name: gaussdb_faq.html
+
+.. _gaussdb_faq:
+
+FAQs
+====
+
+-  :ref:`Does GaussDB(for MySQL) Support Compute and Storage Decoupling? <gaussdb_faq_0002>`
+-  :ref:`What's the Maximum Data Volume Supported by GaussDB(for MySQL)? <gaussdb_faq_0003>`
+-  :ref:`Does GaussDB(for MySQL) Support Automatic Failover? <gaussdb_faq_0005>`
+-  :ref:`What Should I Do When Modifications to GaussDB(for MySQL) Instance Parameters Does Not Take Effect? <gaussdb_faq_0006>`
+-  :ref:`How Many Read Replicas Can I Create for a GaussDB(for MySQL) DB Instance? <gaussdb_faq_0007>`
+-  :ref:`How Can I Install the MySQL Client? <gaussdb_faq_0011>`
+-  :ref:`How Can I Import the Root Certificate to a Windows or Linux OS? <gaussdb_faq_0010>`
+-  :ref:`What Should I Do If an ECS Cannot Connect to a GaussDB(for MySQL) DB Instance? <gaussdb_faq_0009>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   does_gaussdbfor_mysql_support_compute_and_storage_decoupling
+   whats_the_maximum_data_volume_supported_by_gaussdbfor_mysql
+   does_gaussdbfor_mysql_support_automatic_failover
+   what_should_i_do_when_modifications_to_gaussdbfor_mysql_instance_parameters_does_not_take_effect
+   how_many_read_replicas_can_i_create_for_a_gaussdbfor_mysql_db_instance
+   how_can_i_install_the_mysql_client
+   how_can_i_import_the_root_certificate_to_a_windows_or_linux_os
+   what_should_i_do_if_an_ecs_cannot_connect_to_a_gaussdbfor_mysql_db_instance

umn/source/faqs/what_should_i_do_if_an_ecs_cannot_connect_to_a_gaussdbfor_mysql_db_instance.rst

@@ -0,0 +1,36 @@
+:original_name: gaussdb_faq_0009.html
+
+.. _gaussdb_faq_0009:
+
+What Should I Do If an ECS Cannot Connect to a GaussDB(for MySQL) DB Instance?
+==============================================================================
+
+Perform the following steps to identify the problem:
+
+#. Check whether the ECS and GaussDB(for MySQL) DB instance are located in the same VPC.
+
+   -  If they are in the same VPC, go to :ref:`2 <gaussdb_faq_0009__en-us_topic_0192953749_l76760374fb794a8d9b961321c13f386d>`.
+   -  If they are in different VPCs, create an ECS in the VPC where the DB instance is located.
+
+#. .. _gaussdb_faq_0009__en-us_topic_0192953749_l76760374fb794a8d9b961321c13f386d:
+
+   Check whether a security group has been created for the ECS.
+
+   -  If a security group has been created, check whether its configuration rules are suitable.
+
+      For details, see security group description in :ref:`Step 1: Create a DB Instance <gaussdb_02_0004>`. Then, go to :ref:`3 <gaussdb_faq_0009__en-us_topic_0192953749_lbdf6c75fe0be4c37879e3354bc192d36>`.
+
+   -  If no security group has been created, go to the VPC console from the ECS details page and create a security group.
+
+#. .. _gaussdb_faq_0009__en-us_topic_0192953749_lbdf6c75fe0be4c37879e3354bc192d36:
+
+   Check whether the ECS can connect to the DB instance over the instance port.
+
+   The default port of the DB instance is **3306**.
+
+   .. code-block::
+
+      telnet <IP address> {Port number}
+
+   -  If the ECS can connect to the DB instance port, the network between the ECS and the DB instance is normal.
+   -  If the ECS cannot connect to the DB instance port, contact technical support.

umn/source/faqs/what_should_i_do_when_modifications_to_gaussdbfor_mysql_instance_parameters_does_not_take_effect.rst

@@ -0,0 +1,8 @@
+:original_name: gaussdb_faq_0006.html
+
+.. _gaussdb_faq_0006:
+
+What Should I Do When Modifications to GaussDB(for MySQL) Instance Parameters Does Not Take Effect?
+===================================================================================================
+
+If you modify the parameters in a parameter template, but the modifications do not take effect, you may need to reboot the DB instance associated with the parameter template on the management console. The modifications to dynamic parameters take effect immediately. The modifications to static parameters take effect only after you reboot the DB instance associated with the parameter template.

umn/source/faqs/whats_the_maximum_data_volume_supported_by_gaussdbfor_mysql.rst

@@ -0,0 +1,8 @@
+:original_name: gaussdb_faq_0003.html
+
+.. _gaussdb_faq_0003:
+
+What's the Maximum Data Volume Supported by GaussDB(for MySQL)?
+===============================================================
+
+GaussDB(for MySQL) supports up to 128 TB of data and can easily handle large amounts of data requests.

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance.rst

@@ -0,0 +1,27 @@
+:original_name: quick_start.html
+
+.. _quick_start:
+
+Connecting to a DB Instance
+===========================
+
+You can connect a DB instance over a private or a public network.
+
+.. table:: **Table 1** Connection methods
+
+   +-----------------+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | Connect Through | Connection Address | Scenarios                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     |
+   +=================+====================+==================================================================================================================================================================================================================+=================================================================================================================================================================================================================================================+
+   | Private network | Private IP address | The system provides a private IP address by default.                                                                                                                                                             | -  Secure and excellent performance                                                                                                                                                                                                             |
+   |                 |                    |                                                                                                                                                                                                                  | -  Recommended                                                                                                                                                                                                                                  |
+   |                 |                    | When your applications are deployed on an ECS that is in the same region and VPC as the GaussDB(for MySQL) DB instance, you are advised to connect to the DB instance through the ECS over a private IP address. |                                                                                                                                                                                                                                                 |
+   +-----------------+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | Public network  | EIP                | If you cannot access the GaussDB(for MySQL) DB instance over a private IP address, bind an EIP to the DB instance and connect it to an ECS (or a public network host) over the EIP.                              | -  A relatively Low lower level of security compared to the other two connection modes.                                                                                                                                                         |
+   |                 |                    |                                                                                                                                                                                                                  | -  To achieve a higher data transmission rate and security level, you are advised to migrate your applications to an ECS that is in the same VPC as your GaussDB(for MySQL) DB instance and use a private IP address to access the DB instance. |
+   +-----------------+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. note::
+
+   -  VPC: indicates the Virtual Private Cloud.
+   -  ECS: indicates the Elastic Cloud Server.
+   -  If the ECS is in the same VPC as the GaussDB(for MySQL) DB instance, you do not need to apply for an EIP.

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/index.rst

@@ -0,0 +1,20 @@
+:original_name: gaussdb_02_0005.html
+
+.. _gaussdb_02_0005:
+
+Connecting to a DB instance Over a Private Network
+==================================================
+
+-  :ref:`Overview <gaussdb_02_0006>`
+-  :ref:`Step 1: Create a DB Instance <gaussdb_02_0004>`
+-  :ref:`Step 2: Configure Security Group Rules <gaussdb_02_0008>`
+-  :ref:`Step 3: Connect to a DB Instance Over a Private Network <gaussdb_02_0009>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   overview
+   step_1_create_a_db_instance
+   step_2_configure_security_group_rules
+   step_3_connect_to_a_db_instance_over_a_private_network

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/overview.rst

@@ -0,0 +1,36 @@
+:original_name: gaussdb_02_0006.html
+
+.. _gaussdb_02_0006:
+
+Overview
+========
+
+Scenarios
+---------
+
+This section describes how to create a DB instance on the management console and then connect to that instance through an ECS over a private network.
+
+If you are using GaussDB(for MySQL) for the first time, see :ref:`Constraints <gaussdb_01_0008>`.
+
+Process
+-------
+
+:ref:`Figure 1 <gaussdb_02_0006__fig138110377499>` illustrates the process of connecting to a DB instance over a private network.
+
+.. _gaussdb_02_0006__fig138110377499:
+
+.. 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
+
+-  :ref:`Step 1: Create a DB instance. <gaussdb_02_0004>` Confirm the specifications, storage, network, and database account configurations of the DB instance based on service requirements.
+-  :ref:`Step 2: Configure security group rules. <gaussdb_02_0008>`
+
+   -  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 <gaussdb_02_0009>`.
+   -  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 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. <gaussdb_02_0009>` You can connect to the DB instance through a common connection, or an SSL connection for enhanced security. SSL connections are encrypted.

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_private_network/step_2_configure_security_group_rules.rst

@@ -0,0 +1,77 @@
+:original_name: gaussdb_02_0008.html
+
+.. _gaussdb_02_0008:
+
+Step 2: Configure Security Group Rules
+======================================
+
+Scenarios
+---------
+
+A security group is a collection of access control rules for ECSs and DB instances that have the same security requirements and are mutually trusted in a VPC. To ensure database security and reliability, you need to configure security group rules to allow specific IP addresses and ports to access DB instances.
+
+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 <gaussdb_02_0009>`.
+-  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 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
+-----------
+
+The default security group rule allows all outgoing data packets. If an ECS and a DB instance are in the same security group, they can access each other. When a security group is created, you can configure security group rules to control access to and from DB instances in that security group.
+
+-  By default, you can create a maximum of 500 security group rules.
+-  To prevent high network latency for the first packet, you are advised to create a maximum of 50 rules for each security group.
+-  To access a DB instance from resources outside the security group, you need to configure an inbound rule for the security group associated with the DB instance.
+
+.. note::
+
+   To ensure the security of your data and DB instances, you are advised to use the principle of least privilege for database access. Change the database port (default value: **3306**), and set the IP address to the remote server's address or an IP address on the remote server's smallest subnet so that access to the remote server is limited.
+
+   If you use **0.0.0.0/0**, all IP addresses are enabled to access DB instances in the security group.
+
+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.
+
+#. Configure security group rules.
+
+   In the **Network Information** area on the **Basic Information** page, click the security group.
+
+#. On the **Inbound Rules** tab, click **Add Rule**. In the displayed dialog box, set required parameters and click **OK**.
+
+   You can click **+** to add more inbound rules.
+
+   .. table:: **Table 1** Inbound rule parameter description
+
+      +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+      | 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_0000001400783488.png

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/index.rst

@@ -0,0 +1,22 @@
+:original_name: gaussdb_02_0010.html
+
+.. _gaussdb_02_0010:
+
+Connecting to a DB Instance Over a Public Network
+=================================================
+
+-  :ref:`Overview <gaussdb_02_0016>`
+-  :ref:`Step 1: Create a DB Instance <gaussdb_02_0012>`
+-  :ref:`Step 2: Bind an EIP <gaussdb_02_0015>`
+-  :ref:`Step 3: Configure Security Group Rules <gaussdb_02_0013>`
+-  :ref:`Step 4: Connect to a DB Instance Over a Public Network <gaussdb_02_0014>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   overview
+   step_1_create_a_db_instance
+   step_2_bind_an_eip
+   step_3_configure_security_group_rules
+   step_4_connect_to_a_db_instance_over_a_public_network

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/overview.rst

@@ -0,0 +1,30 @@
+:original_name: gaussdb_02_0016.html
+
+.. _gaussdb_02_0016:
+
+Overview
+========
+
+Scenarios
+---------
+
+This section describes how to create a DB instance on the management console and bind an EIP to the DB instance to make the instance publicly accessible.
+
+If you are using GaussDB(for MySQL) for the first time, see :ref:`Constraints <gaussdb_01_0008>`.
+
+Process
+-------
+
+:ref:`Figure 1 <gaussdb_02_0016__fig138110377499>` illustrates the process of connecting to a DB instance over a public network.
+
+.. _gaussdb_02_0016__fig138110377499:
+
+.. 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
+
+-  :ref:`Step 1: Create a DB instance. <gaussdb_02_0012>` Confirm the specifications, storage, network, and database account configurations of the DB instance based on service requirements.
+-  :ref:`Step 2: Bind an EIP. <gaussdb_02_0015>` The Elastic IP service provides independent public IP addresses and bandwidth for public access. You can apply for an EIP on the VPC console and bind the EIP to the DB instance.
+-  :ref:`Step 3: Configure security group rules. <gaussdb_02_0013>` To access a DB instance from resources outside the security group, you need to configure an inbound rule for the security group associated with the DB instance.
+-  :ref:`Step 4: Connect to a DB instance over a public network. <gaussdb_02_0014>` You can connect to a DB instance through a common connection, or an SSL connection for enhanced security. SSL connections are encrypted.

umn/source/getting_started_with_gaussdbfor_mysql/connecting_to_a_db_instance_over_a_public_network/step_2_bind_an_eip.rst

@@ -0,0 +1,41 @@
+:original_name: gaussdb_02_0015.html
+
+.. _gaussdb_02_0015:
+
+Step 2: Bind an EIP
+===================
+
+Scenarios
+---------
+
+You can bind an EIP to a DB instance for public access and can unbind the EIP from the DB instance if needed.
+
+Precautions
+-----------
+
+-  Public accessibility reduces the security of DB instances. Therefore, exercise caution when enabling this function. To achieve a higher transmission rate and security level, you are advised to migrate your applications to the ECS that is in the same region as the GaussDB(for MySQL) 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**.
+
+#. On the **Instance Management** page, click the target DB instance.
+
+#. 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**.
+
+   If no available EIPs are displayed, click **View EIP** and obtain an EIP.
+
+   .. important::
+
+      You need to configure security group rules and enable specific IP addresses and ports to access the target DB instance. For details, see :ref:`Step 3: Configure Security Group Rules <gaussdb_02_0013>`.
+
+#. On the **EIPs** page, view the EIP that has been bound to the DB instance.
+
+.. |image1| image:: /_static/images/en-us_image_0000001400783488.png