Changes to gaussdb_mysql_umn from docs/doc-exports#1161 (gaussdbmysql_umn_202404

Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

api-ref/source/apis_recommended/backup_management/index.rst

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

api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst

@@ -12,7 +12,6 @@ This API is used to enable database proxy in ELB mode. Before using this API:
 
 -  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
 -  Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
--  Database proxy is unavailable for DB instances in a DeC.
 
 URI
 ---
@@ -62,6 +61,8 @@ Request Parameters
    |                   |                 |                                                                                  | -  **readonly**                                                                                                                                                                                                                                              |
    +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | nodes_read_weight | No              | Array of :ref:`NodesWeight <creategaussmysqlproxy__request_nodesweight>` objects | Read weight of the node.                                                                                                                                                                                                                                     |
+   |                   |                 |                                                                                  |                                                                                                                                                                                                                                                              |
+   |                   |                 |                                                                                  | If **proxy_mode** is set to **readonly**, you can assign weights only for read replicas.                                                                                                                                                                     |
    +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 .. _creategaussmysqlproxy__request_nodesweight:

api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst

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

api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst

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

api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst

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

api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst

@@ -132,7 +132,8 @@ Success.
        "availability_instance_quota" : 1,
        "availability_vcpus_quota" : 4,
        "availability_ram_quota" : 8
-     } ]
+     } ],
+     "total_count":1
    }
 
 Status Code

api-ref/source/appendix/obtaining_a_project_id.rst

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

api-ref/source/before_you_start/concepts.rst

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

doc/requirements.txt

@@ -1,7 +1,11 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
+
 otcdocstheme # Apache-2.0
+
 # releasenotes
 reno>=3.1.0 # Apache-2.0
 
 otc-sphinx-directives>=0.1.0
-git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+sphinx-minify>=0.0.1 # Apache-2.0
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools

doc/source/conf.py

@@ -31,6 +31,17 @@ 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 = ''
+otcdocs_doc_link = ''
+otcdocs_doc_title = ''
+otcdocs_doc_type = ''
+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.

tox.ini

@@ -34,23 +34,28 @@ allowlist_externals =
   rm
   sphinx-build
 commands =
-  rm -rf doc/build/html doc/build/doctrees
+  rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
-  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
+  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
+  sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
   {[testenv:umn]commands}
   {[testenv:json-umn]commands}
 
 [testenv:docs-pdf]
-deps = {[testenv:docs]deps}
+deps =
+  {[testenv:docs]deps}
+  {[testenv:bindeps]deps}
 allowlist_externals =
   rm
   mkdir
+  wget
   make
   bash
   cp
 commands =
   mkdir -p doc/build/pdf
+  {[testenv:bindeps]commands}
   {[testenv:api-ref-pdf-docs]commands}
   {[testenv:umn-pdf-docs]commands}
 
@@ -62,7 +67,8 @@ allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html api-ref/source doc/build/html/api-ref
+  sphinx-build -W --keep-going -b html api-ref/source doc/build/html_temp/api-ref
+  sphinx-minify --input-directory doc/build/html_temp/api-ref --output-directory doc/build/html/api-ref
   mkdir -p api-ref/build/html
   cp -av doc/build/html/api-ref api-ref/build/html
 
@@ -107,7 +113,8 @@ allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html umn/source doc/build/html/umn
+  sphinx-build -W --keep-going -b html umn/source doc/build/html_temp/umn
+  sphinx-minify --input-directory doc/build/html_temp/umn --output-directory doc/build/html/umn
   mkdir -p umn/build/html
   cp -av doc/build/html/umn umn/build/html
 
@@ -146,6 +153,21 @@ commands =
 
 
 
+[testenv:bindeps]
+deps =
+    bindep
+allowlist_externals =
+    wget
+    rm
+    bash
+commands =
+    rm -rf {toxinidir}/bindep.txt
+    rm -rf {toxinidir}/packages.txt
+    wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
+    bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
+    bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
+    bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
+
 [doc8]
 ignore = D001
 extensions = .rst, .yaml