Compare commits

...

12 Commits

Author SHA1 Message Date
b3ecf9fc5b Changes to dds_api-ref from docs/doc-exports#1036 (dds_api
Enabling Shard or Co

Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-01-31 18:53:15 +00:00
bab39dfb01 Update tox.ini && conf.py file
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-01-17 13:29:14 +00:00
08efb2938c Changes to dds_api-ref from docs/doc-exports#1003 (dds_api
Supported disk encry

Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-01-11 12:49:38 +00:00
da6cbcc3a5 Changes to dds_api-ref from docs/doc-exports#997 (WIP: Update Metadata)
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-01-02 13:48:02 +00:00
40e37c8637 Update tox.ini && conf.py file
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2023-11-14 13:35:47 +00:00
45c9ba0e77 Changes to dds_api-ref from docs/doc-exports#936 (adding drs best-practice metad
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-10-25 13:04:14 +00:00
8951b1eb57 adding best-practice to sbv
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-10-24 22:16:22 +00:00
0283a84ece Changes to dds_best-practice from docs/doc-exports#928 (adding best practice doc
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-10-23 23:08:08 +00:00
cd8423fd25 Changes to dds_api-ref from docs/doc-exports#858 (DDS API DOC
DDS API DOC 0905)

Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-09-19 07:57:08 +00:00
6422890d45 Changes to dds_umn from docs/doc-exports#859 (DDS UMN DOC
DDS UMN DOC 0905)

Reviewed-by: Székely, Ond <ond.szekely@t-systems.com>
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
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>
2023-09-11 13:01:27 +00:00
b773d784ea Changes to dds_api-ref from docs/doc-exports#834 (updating run.yaml for paramete
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-08-15 06:58:03 +00:00
66e5d4252c fix sphinx problems with constraints
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-10 14:43:28 +00:00
32 changed files with 674 additions and 264 deletions

View File

@ -128,15 +128,15 @@ Responses
.. table:: **Table 4** datastore field data structure description .. table:: **Table 4** datastore field data structure description
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==============================================================================================================+ +=======================+=======================+============================================================================================================================+
| type | String | Indicates the DB engine. | | type | String | Indicates the DB engine. |
| | | | | | | |
| | | Valid value: **DDS-Community**. | | | | Valid value: **DDS-Community**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
| version | String | Indicates the database of version 3.2, 3.4, 4.0, or 4.2. The value is **3.2**, **3.4**, **4.0**, or **4.2**. | | version | String | Indicates the database of version 3.2, 3.4, 4.0, 4.2, or 4.4. The value is **3.2**, **3.4**, **4.0**, **4.2**, or **4.4**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
- Response example - Response example

View File

@ -71,7 +71,7 @@ Requests
| | | | | | | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. | | | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. | | disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| | | | | | | | | |
| | | | If this parameter is not transferred, disk encryption is not performed. | | | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -368,18 +368,18 @@ Responses
.. table:: **Table 7** datastore field data structure description .. table:: **Table 7** datastore field data structure description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+ +=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. | | type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.2, 4.0,** **3.4** or **3.2**. | | version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. | | storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | | | | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. | | | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | | | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0038__table119482048538: .. _dds_api_0038__table119482048538:
@ -479,7 +479,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Sharding", "mode": "Sharding",
"flavor": [ "flavor": [
{ {
@ -528,7 +528,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "ReplicaSet", "mode": "ReplicaSet",
"flavor": [ "flavor": [
{ {
@ -566,7 +566,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Single", "mode": "Single",
"flavor": [ "flavor": [
{ {

View File

@ -13,7 +13,7 @@ This API is used to kill sessions of an instance node.
Constraints Constraints
----------- -----------
- Community Edition 3.4, 4.0 and 4.2 instances are supported. - Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
- Inactive sessions cannot be terminated. - Inactive sessions cannot be terminated.
URI URI

View File

@ -13,7 +13,7 @@ This API is used to query sessions of instance nodes.
Constraints Constraints
----------- -----------
Community Edition 3.4, 4.0 and 4.2 instances are supported. Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
URI URI
--- ---

View File

@ -78,7 +78,7 @@ Requests
| | | | | | | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. | | | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. | | disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| | | | | | | | | |
| | | | If this parameter is not transferred, disk encryption is not performed. | | | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -120,18 +120,18 @@ Requests
.. table:: **Table 3** datastore field data structure description .. table:: **Table 3** datastore field data structure description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+ +=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. | | type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.2, 4.0,** **3.4** or **3.2**. | | version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. | | storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | | | | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. | | | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | | | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table94791241013: .. _dds_api_0020__table94791241013:
@ -453,18 +453,18 @@ Responses
.. table:: **Table 8** datastore field data structure description .. table:: **Table 8** datastore field data structure description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+ +=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. | | type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.2, 4.0,** **3.4** or **3.2**. | | version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. | | storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | | | | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. | | | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | | | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table119482048538: .. _dds_api_0020__table119482048538:
@ -583,7 +583,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365, "port": 8365,
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Sharding", "mode": "Sharding",
"flavor": [ "flavor": [
{ {
@ -637,7 +637,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365, "port": 8365,
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "ReplicaSet", "mode": "ReplicaSet",
"flavor": [ "flavor": [
{ {
@ -680,7 +680,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365, "port": 8365,
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Single", "mode": "Single",
"flavor": [ "flavor": [
{ {

View File

@ -16,7 +16,7 @@ Constraints
- Frozen instances do not support this operation. - Frozen instances do not support this operation.
- DB instances associated with the IPv6 subnet do not support this operation. - DB instances associated with the IPv6 subnet do not support this operation.
- If the IP address is enabled, restart the nodes for the setting to take effect. - If the IP address is enabled, restart the nodes for the setting to take effect.
- Cluster instances of Community Edition 3.4, 4.0 and 4.2 are supported. - Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported.
- This function cannot be disabled after being enabled. - This function cannot be disabled after being enabled.
URI URI

View File

@ -102,17 +102,17 @@ Responses
.. table:: **Table 5** RecycleDatastore .. table:: **Table 5** RecycleDatastore
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+========================================================================================================+ +=======================+=======================+======================================================================================================================+
| type | String | Database type. The value is **DDS-Community**. | | type | String | Database type. The value is **DDS-Community**. |
| | | | | | | |
| | | Enumerated values: | | | | Enumerated values: |
| | | | | | | |
| | | - DDS-Community | | | | - DDS-Community |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| version | String | Database version. Versions 3.4, 4.0, and 4.2 are supported. The value can be **3.4, 4.0,** or **4.2**. | | version | String | Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be **3.4, 4.0,** **4.2,** or **4.4**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
- Response Example - Response Example

View File

@ -168,7 +168,7 @@ Responses
| | | | | | | |
| | | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`. | | | | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | String | Indicates the disk encryption key ID. This parameter is returned only when the instance disk is encrypted. | | disk_encryption_id | String | The disk encryption key ID. This parameter is returned only when the instance disk is encrypted. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | Indicates the enterprise project ID. | | enterprise_project_id | String | Indicates the enterprise project ID. |
| | | | | | | |

View File

@ -14,6 +14,7 @@ APIs V3.0 (Recommended)
- :ref:`Backup and Restoration <dds_backup_restore>` - :ref:`Backup and Restoration <dds_backup_restore>`
- :ref:`Log Information Queries <dds_api_0092>` - :ref:`Log Information Queries <dds_api_0092>`
- :ref:`Tag Management <dds_tag_mgmt>` - :ref:`Tag Management <dds_tag_mgmt>`
- :ref:`Managing Databases and Users <dds_api_0070>`
- :ref:`Task Management <dds_api_0117>` - :ref:`Task Management <dds_api_0117>`
.. toctree:: .. toctree::
@ -29,4 +30,5 @@ APIs V3.0 (Recommended)
backup_and_restoration/index backup_and_restoration/index
log_information_queries/index log_information_queries/index
tag_management/index tag_management/index
managing_databases_and_users/index
task_management/index task_management/index

View File

@ -0,0 +1,87 @@
:original_name: dds_api_0075.html
.. _dds_api_0075:
Changing the Password of a Database User
========================================
Function
--------
This API is used to change the password of a database user
Constraints
-----------
This operation cannot be performed on frozen or abnormal instances.
URI
---
- URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reset-password
- Parameter description
.. table:: **Table 1** Parameter description
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Description |
+=============+===========+=================================================================================================================================================================================+
| project_id | Yes | Specifies the project ID of a tenant in a region. |
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Requests
--------
- Parameter description
.. table:: **Table 2** Parameter description
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+=========================================================================================================================================================================================+
| user_name | No | String | Specifies the database username. The default value is **"rwuser"**. |
| | | | |
| | | | The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.). |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user_pwd | Yes | String | Specifies the database password. |
| | | | |
| | | | - The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ``~!@#%^*-_=+?`` |
| | | | - Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| db_name | No | String | Specifies the database name. The default value is **"admin"**. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Request example
.. code-block:: text
{
"user_name": "rwuser",
"user_pwd": "******"
}
Responses
---------
- Response example
.. code-block:: text
{}
Status Code
-----------
Status Code:200.
For more information, see :ref:`Status Code <dds_status_code>`.
Error Code
----------
For more information, see :ref:`Error Code <dds_error_code>`.

View File

@ -0,0 +1,14 @@
:original_name: dds_api_0070.html
.. _dds_api_0070:
Managing Databases and Users
============================
- :ref:`Changing the Password of a Database User <dds_api_0075>`
.. toctree::
:maxdepth: 1
:hidden:
changing_the_password_of_a_database_user

View File

@ -107,7 +107,7 @@ Responses
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| engine_versions | Array of strings | Database versions | | engine_versions | Array of strings | Database versions |
| | | | | | | |
| | | For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2"} | | | | For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2", "4.4"} |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note:: .. note::

View File

@ -43,11 +43,11 @@ Responses
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+----------+------------------+-------------------------------------------------------------------------------------------+ +----------+------------------+------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+==========+==================+===========================================================================================+ +==========+==================+================================================================================================+
| versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, and 4.2 are supported. | | versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, 4.2, and 4.4 are supported. |
+----------+------------------+-------------------------------------------------------------------------------------------+ +----------+------------------+------------------------------------------------------------------------------------------------+
- Response example - Response example
@ -58,7 +58,8 @@ Responses
"3.2", "3.2",
"3.4", "3.4",
"4.0", "4.0",
"4.2" "4.2",
"4.4"
] ]
} }

View File

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/document-database-service/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'database'
otcdocs_service_title = 'Document Database Service'
otcdocs_service_type = 'dds'
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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,2 @@
[html writers]
table-style: table, caption-top

View File

@ -0,0 +1,4 @@
=========================================
Document Database Service - Best Practice
=========================================

View File

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

View File

@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' 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 = 'Document Database Service'
otcdocs_service_type = 'dds'
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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

View File

@ -8,6 +8,7 @@ Document Database Service (DDS) is a cloud computing-based NoSQL database featur
.. service_card:: .. service_card::
:service_type: dds :service_type: dds
:environment: internal
:umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS. :umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS.
:api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values. :api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values.
:best-practice: To use Document Database Service more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.

95
tox.ini

File diff suppressed because it is too large Load Diff

View File

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/document-database-service/umn/'
otcdocs_doc_title = 'User Guide'
otcdocs_doc_type = 'umn'
otcdocs_service_category = 'database'
otcdocs_service_title = 'Document Database Service'
otcdocs_service_type = 'dds'
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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

View File

@ -15,7 +15,7 @@ This section describes how to obtain the IP addresses of the shard and config no
Before You Start Before You Start
---------------- ----------------
- DDS supports cluster instances of Community Edition 3.2, 3.4, 4.0, and 4.2. - DDS supports cluster instances of Community Edition 3.2, 3.4, 4.0, 4.2, and 4.4.
- DDS creates two connection addresses for the primary node and secondary node in a shard respectively. - DDS creates two connection addresses for the primary node and secondary node in a shard respectively.
- Once the connection addresses are assigned to your nodes, they cannot be modified or deleted. - Once the connection addresses are assigned to your nodes, they cannot be modified or deleted.
- The connection address is accessible from private networks only. - The connection address is accessible from private networks only.

View File

@ -21,48 +21,55 @@ Procedure
.. table:: **Table 1** Basic information .. table:: **Table 1** Basic information
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+===================================+=============================================================================================================================================================================================================================+ +===================================+=====================================================================================================================================================================================================================================================================================+
| Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | | | | |
| | .. note:: | | | .. note:: |
| | | | | |
| | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. | | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). |
| | | | | |
| | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. | | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition | | Database Type | Community Edition |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Cluster**. | | DB Instance Type | Select **Cluster**. |
| | | | | |
| | A cluster instance includes three types of nodes: mongos, shard, and config. Each shard and config is a three-node replica set to ensure high availability. | | | A cluster instance includes three types of nodes: mongos, shard, and config. Each shard and config is a three-node replica set to ensure high availability. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 | | Compatible MongoDB Version | - 4.4 |
| | - 4.0 | | | - 4.2 |
| | - 3.4 | | | - 4.0 |
| | - 3.2 | | | - 3.4 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | - 3.2 |
| Storage Type | Ultra-high I/O | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Type | Ultra-high I/O |
| Storage Engine | WiredTiger | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Engine | - WiredTiger |
| AZ | An AZ is a part of a region with its own independent power supply and network. AZs are physically isolated but can communicate through an internal network. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | | |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | WiredTiger is the default storage engine of DDS 3.2, 3.4 and 4.0. WiredTiger provides different granularity concurrency control and compression mechanism for data management. It can provide the best performance and storage efficiency for different kinds of applications. |
| Disk Encryption | - **Disabled**: Disable the encryption function. | | | |
| | | | | - RocksDB |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | | | |
| | | | | RocksDB is the default storage engine of DDS 4.2 and 4.4. RocksDB supports efficient point lookup, range scan, and high-speed write. RocksDB can be used as the underlying data storage engine of MongoDB and is suitable for scenarios with a large number of write operations. |
| | **Key Name**: Select or create a private key, which is the tenant key. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | AZ | An AZ is a part of a region with its own independent power supply and network. AZs are physically isolated but can communicate through an internal network. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | .. note:: | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Disk Encryption | - **Disabled**: Disable the encryption function. |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | | | |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | | | |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | **Key Name**: Select or create a private key, which is the tenant key. |
| | |
| | .. note:: |
| | |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Specifications .. table:: **Table 2** Specifications

View File

@ -21,48 +21,55 @@ Procedure
.. table:: **Table 1** Basic information .. table:: **Table 1** Basic information
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+===================================+=============================================================================================================================================================================================================================+ +===================================+=====================================================================================================================================================================================================================================================================================+
| Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | | | | |
| | .. note:: | | | .. note:: |
| | | | | |
| | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. | | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). |
| | | | | |
| | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. | | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition | | Database Type | Community Edition |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Cluster**. | | DB Instance Type | Select **Cluster**. |
| | | | | |
| | A cluster instance includes three types of nodes: mongos, shard, and config. Each shard and config is a three-node replica set to ensure high availability. | | | A cluster instance includes three types of nodes: mongos, shard, and config. Each shard and config is a three-node replica set to ensure high availability. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 | | Compatible MongoDB Version | - 4.4 |
| | - 4.0 | | | - 4.2 |
| | - 3.4 | | | - 4.0 |
| | - 3.2 | | | - 3.4 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | - 3.2 |
| Storage Type | Ultra-high I/O | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Type | Ultra-high I/O |
| Storage Engine | WiredTiger | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Engine | - WiredTiger |
| AZ | An AZ is a part of a region with its own independent power supply and network. AZs are physically isolated but can communicate through an internal network. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | | |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | WiredTiger is the default storage engine of DDS 3.2, 3.4 and 4.0. WiredTiger provides different granularity concurrency control and compression mechanism for data management. It can provide the best performance and storage efficiency for different kinds of applications. |
| Disk Encryption | - **Disabled**: Disable the encryption function. | | | |
| | | | | - RocksDB |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | | | |
| | | | | RocksDB is the default storage engine of DDS 4.2 and 4.4. RocksDB supports efficient point lookup, range scan, and high-speed write. RocksDB can be used as the underlying data storage engine of MongoDB and is suitable for scenarios with a large number of write operations. |
| | **Key Name**: Select or create a private key, which is the tenant key. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | AZ | An AZ is a part of a region with its own independent power supply and network. AZs are physically isolated but can communicate through an internal network. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | .. note:: | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Disk Encryption | - **Disabled**: Disable the encryption function. |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | | | |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | | | |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | **Key Name**: Select or create a private key, which is the tenant key. |
| | |
| | .. note:: |
| | |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Specifications .. table:: **Table 2** Specifications

View File

@ -40,14 +40,21 @@ You can use your account to create up to 50 replica set instances. To create mor
| | | | | |
| | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. | | | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 | | Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| | - 4.0 | | | - 4.0 |
| | - 3.4 | | | - 3.4 |
| | - 3.2 | | | - 3.2 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O | | Storage Type | Ultra-high I/O |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Engine | WiredTiger | | Storage Engine | - WiredTiger |
| | |
| | WiredTiger is the default storage engine of DDS 3.2, 3.4 and 4.0. WiredTiger provides different granularity concurrency control and compression mechanism for data management. It can provide the best performance and storage efficiency for different kinds of applications. |
| | |
| | - RocksDB |
| | |
| | RocksDB is the default storage engine of DDS 4.2 and 4.4. RocksDB supports efficient point lookup, range scan, and high-speed write. RocksDB can be used as the underlying data storage engine of MongoDB and is suitable for scenarios with a large number of write operations. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | | | | |

View File

@ -40,14 +40,21 @@ You can use your account to create up to 50 replica set instances. To create mor
| | | | | |
| | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. | | | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 | | Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| | - 4.0 | | | - 4.0 |
| | - 3.4 | | | - 3.4 |
| | - 3.2 | | | - 3.2 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O | | Storage Type | Ultra-high I/O |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Engine | WiredTiger | | Storage Engine | - WiredTiger |
| | |
| | WiredTiger is the default storage engine of DDS 3.2, 3.4 and 4.0. WiredTiger provides different granularity concurrency control and compression mechanism for data management. It can provide the best performance and storage efficiency for different kinds of applications. |
| | |
| | - RocksDB |
| | |
| | RocksDB is the default storage engine of DDS 4.2 and 4.4. RocksDB supports efficient point lookup, range scan, and high-speed write. RocksDB can be used as the underlying data storage engine of MongoDB and is suitable for scenarios with a large number of write operations. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | | | | |

View File

@ -21,48 +21,55 @@ Procedure
.. table:: **Table 1** Basic information .. table:: **Table 1** Basic information
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+===================================+===================================================================================================================================================================================================================================================+ +===================================+=====================================================================================================================================================================================================================================================================================+
| Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | | | | |
| | .. note:: | | | .. note:: |
| | | | | |
| | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, you should exercise caution when selecting a region. | | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, you should exercise caution when selecting a region. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). |
| | | | | |
| | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. | | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition | | Database Type | Community Edition |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Single Node**. | | DB Instance Type | Select **Single Node**. |
| | | | | |
| | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. | | | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 | | Compatible MongoDB Version | - 4.4 |
| | - 4.0 | | | - 4.2 |
| | - 3.4 | | | - 4.0 |
| | - 3.2 | | | - 3.4 |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | - 3.2 |
| Storage Type | Ultra-high I/O | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Type | Ultra-high I/O |
| Storage Engine | WiredTiger | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Engine | - WiredTiger |
| AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | WiredTiger is the default storage engine of DDS 3.2, 3.4 and 4.0. WiredTiger provides different granularity concurrency control and compression mechanism for data management. It can provide the best performance and storage efficiency for different kinds of applications. |
| Disk Encryption | - **Disabled**: Disable the encryption function. | | | |
| | | | | - RocksDB |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | | | |
| | | | | RocksDB is the default storage engine of DDS 4.2 and 4.4. RocksDB supports efficient point lookup, range scan, and high-speed write. RocksDB can be used as the underlying data storage engine of MongoDB and is suitable for scenarios with a large number of write operations. |
| | **Key Name**: Select or create a private key, which is the tenant key. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | .. note:: | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Disk Encryption | - **Disabled**: Disable the encryption function. |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | | | |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | | | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | **Key Name**: Select or create a private key, which is the tenant key. |
| | |
| | .. note:: |
| | |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Specifications .. table:: **Table 2** Specifications

View File

@ -21,48 +21,55 @@ Procedure
.. table:: **Table 1** Basic information .. table:: **Table 1** Basic information
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Description | | Parameter | Description |
+===================================+===================================================================================================================================================================================================================================================+ +===================================+=====================================================================================================================================================================================================================================================================================+
| Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | | | | |
| | .. note:: | | | .. note:: |
| | | | | |
| | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, you should exercise caution when selecting a region. | | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, you should exercise caution when selecting a region. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). |
| | | | | |
| | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. | | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name <dds_03_0075>`. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition | | Database Type | Community Edition |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Single Node**. | | DB Instance Type | Select **Single Node**. |
| | | | | |
| | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. | | | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 | | Compatible MongoDB Version | - 4.4 |
| | - 4.0 | | | - 4.2 |
| | - 3.4 | | | - 4.0 |
| | - 3.2 | | | - 3.4 |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | - 3.2 |
| Storage Type | Ultra-high I/O | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Type | Ultra-high I/O |
| Storage Engine | WiredTiger | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Storage Engine | - WiredTiger |
| AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. | | | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | WiredTiger is the default storage engine of DDS 3.2, 3.4 and 4.0. WiredTiger provides different granularity concurrency control and compression mechanism for data management. It can provide the best performance and storage efficiency for different kinds of applications. |
| Disk Encryption | - **Disabled**: Disable the encryption function. | | | |
| | | | | - RocksDB |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | | | |
| | | | | RocksDB is the default storage engine of DDS 4.2 and 4.4. RocksDB supports efficient point lookup, range scan, and high-speed write. RocksDB can be used as the underlying data storage engine of MongoDB and is suitable for scenarios with a large number of write operations. |
| | **Key Name**: Select or create a private key, which is the tenant key. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs <dds_01_0027>`. |
| | .. note:: | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Disk Encryption | - **Disabled**: Disable the encryption function. |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | | | |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | | | |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | **Key Name**: Select or create a private key, which is the tenant key. |
| | |
| | .. note:: |
| | |
| | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. |
| | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Specifications .. table:: **Table 2** Specifications

View File

@ -5,4 +5,30 @@
Database Engine and Version Database Engine and Version
=========================== ===========================
DDS is compatible with MongoDB 3.2, 3.4, 4.0, and 4.2 Community Edition and supports the WiredTiger storage engine, so you need to use a driver compatible with MongoDB 3.0 or later to access DDS. DDS supports versions 3.2, 3.4, 4.0, 4.2, and 4.4, and you need to use a driver compatible with MongoDB 3.0 or later to access DDS. You can select the DB engine and version you need based on your service requirements.
.. table:: **Table 1** Supported DB engines and versions
+-----------------------+-----------------------+-----------------------+
| Compatibility | DB Instance Type | Storage Engine |
+=======================+=======================+=======================+
| 4.4 | - Cluster | RocksDB |
| | - Replica set | |
| | - Single | |
+-----------------------+-----------------------+-----------------------+
| 4.2 | - Cluster | RocksDB |
| | - Replica set | |
| | - Single | |
+-----------------------+-----------------------+-----------------------+
| 4.0 | - Cluster | WiredTiger |
| | - Replica set | |
| | - Single | |
+-----------------------+-----------------------+-----------------------+
| 3.4 | - Cluster | WiredTiger |
| | - Replica set | |
| | - Single | |
+-----------------------+-----------------------+-----------------------+
| 3.2 | - Cluster | WiredTiger |
| | - Replica set | |
| | - Single | |
+-----------------------+-----------------------+-----------------------+

View File

@ -4,5 +4,9 @@
default-branch: main default-branch: main
templates: templates:
- helpcenter-base-jobs - helpcenter-base-jobs
- api-ref-hc-int-jobs check:
- umn-hc-int-jobs jobs:
- noop
gate:
jobs:
- noop