lboka/document-database-service
1
0
Fork 0
forked from docs/document-database-service
Code Pull Requests Activity

Compare commits

base: lboka:main
Branches Tags
lboka:main
lboka:DDS-compatibility-fix
lboka:propose-dds_umn-1042
lboka:propose-dds_api-ref-1036
lboka:propose-dds_api-ref-1032
lboka:propose-dds_api-ref-1027
lboka:zuul-tox-update
lboka:update_config_pdf
lboka:propose-dds_umn-1004
lboka:propose-dds_api-ref-1003
lboka:propose-dds_api-ref-997
lboka:minify_sphinx_gitea
lboka:minify_sphinx_internal
lboka:propose-dds_api-ref-936
lboka:propose-dds_best-practice-920
lboka:confpy
lboka:propose-dds_best-practice-928
lboka:propose-dds_api-ref-858
lboka:propose-dds_umn-859
lboka:propose-dds_umn-834
lboka:propose-dds_api-ref-834
lboka:propose-dds_umn-833
lboka:propose-dds_api-ref-833
lboka:constraints
lboka:propose-dds_api-ref-698
lboka:propose-dds_umn-769
lboka:propose-dds_api-ref-769
lboka:propose-dds_umn-773
lboka:propose-dds_api-ref-773
lboka:service_based_view
lboka:propose-dds_umn-731
lboka:propose-dds_api-ref-502
..
compare: lboka:propose-dds_api-ref-858
Branches Tags
lboka:DDS-compatibility-fix
lboka:propose-dds_umn-1042
lboka:main
lboka:propose-dds_api-ref-1036
lboka:propose-dds_api-ref-1032
lboka:propose-dds_api-ref-1027
lboka:zuul-tox-update
lboka:update_config_pdf
lboka:propose-dds_umn-1004
lboka:propose-dds_api-ref-1003
lboka:propose-dds_api-ref-997
lboka:minify_sphinx_gitea
lboka:minify_sphinx_internal
lboka:propose-dds_api-ref-936
lboka:propose-dds_best-practice-920
lboka:confpy
lboka:propose-dds_best-practice-928
lboka:propose-dds_api-ref-858
lboka:propose-dds_umn-859
lboka:propose-dds_umn-834
lboka:propose-dds_api-ref-834
lboka:propose-dds_umn-833
lboka:propose-dds_api-ref-833
lboka:constraints
lboka:propose-dds_api-ref-698
lboka:propose-dds_umn-769
lboka:propose-dds_api-ref-769
lboka:propose-dds_umn-773
lboka:propose-dds_api-ref-773
lboka:service_based_view
lboka:propose-dds_umn-731
lboka:propose-dds_api-ref-502

2 Commits
main ... propose-dd

Author SHA1 Message Date
OpenTelekomCloud Proposal Bot
a4e296535b Update content 2023-09-19 07:40:10 +00:00
OpenTelekomCloud Proposal Bot
61b5355d41 Update content 2023-09-05 06:35:14 +00:00
22 changed files with 213 additions and 495 deletions
Show Stats Expand all files Collapse all files

8
api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst
View File

@ -71,7 +71,7 @@ Requests
| | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| disk_encryption_id | No | String | Specifies 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. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -479,7 +479,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Sharding",
"flavor": [
{
@ -528,7 +528,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "ReplicaSet",
"flavor": [
{
@ -566,7 +566,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Single",
"flavor": [
{

8
api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst
View File

@ -78,7 +78,7 @@ Requests
| | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| disk_encryption_id | No | String | Specifies 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. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -583,7 +583,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Sharding",
"flavor": [
{
@ -637,7 +637,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "ReplicaSet",
"flavor": [
{
@ -680,7 +680,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"disk_encryption_id": "",
"mode": "Single",
"flavor": [
{

2
api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst
View File

@ -16,7 +16,7 @@ Constraints
- Frozen instances 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.
- Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported.
- Cluster instances of Community Edition 3.4, 4.0 and 4.2 are supported.
- This function cannot be disabled after being enabled.
URI

22
api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst
View File

@ -102,17 +102,17 @@ Responses
.. table:: **Table 5** RecycleDatastore
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+======================================================================================================================+
| type | String | Database type. The value is **DDS-Community**. |
| | | |
| | | Enumerated values: |
| | | |
| | | - DDS-Community |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| 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**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+========================================================================================================+
| type | String | Database type. The value is **DDS-Community**. |
| | | |
| | | Enumerated values: |
| | | |
| | | - 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**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
- Response Example

2
api-ref/source/apis_v3.0_recommended/db_instance_management/querying_instances_and_details.rst
View File

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

0
doc/best-practice/source/_static/.placeholder
View File

117
doc/best-practice/source/conf.py
View File

File diff suppressed because it is too large Load Diff

2
doc/best-practice/source/docutils.conf
View File

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

4
doc/best-practice/source/index.rst
View File

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

6
doc/requirements.txt
View File

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

11
doc/source/conf.py
View File

@ -31,17 +31,6 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = ''
otcdocs_doc_link = ''
otcdocs_doc_title = ''
otcdocs_doc_type = ''
otcdocs_service_category = 'database'
otcdocs_service_title = '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,
# 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.

3
doc/source/index.rst
View File

@ -8,7 +8,6 @@ Document Database Service (DDS) is a cloud computing-based NoSQL database featur
.. service_card::
: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.
: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.

99
tox.ini
View File

File diff suppressed because it is too large Load Diff

2
umn/source/connection_management/enabling_ip_addresses_of_shard_and_config_nodes.rst
View File

@ -15,7 +15,7 @@ This section describes how to obtain the IP addresses of the shard and config no
Before You Start
----------------
- DDS supports cluster instances of Community Edition 3.2, 3.4, 4.0, 4.2, and 4.4.
- DDS supports cluster instances of Community Edition 3.2, 3.4, 4.0, and 4.2.
- 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.
- The connection address is accessible from private networks only.

91
umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/creating_a_cluster_instance.rst
View File

@ -21,55 +21,48 @@ Procedure
.. table:: **Table 1** Basic information
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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

91
umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/creating_a_cluster_instance.rst
View File

@ -21,55 +21,48 @@ Procedure
.. table:: **Table 1** Basic information
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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

11
umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/creating_a_replica_set_instance.rst
View File

@ -40,21 +40,14 @@ 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. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| Compatible MongoDB Version | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
| 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>`. |
| | |

11
umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/creating_a_replica_set_instance.rst
View File

@ -40,21 +40,14 @@ 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. |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| Compatible MongoDB Version | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
| 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>`. |
| | |

91
umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/creating_a_single_node_instance.rst
View File

@ -21,55 +21,48 @@ Procedure
.. table:: **Table 1** Basic information
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Single Node**. |
| | |
| | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Single Node**. |
| | |
| | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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

91
umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/creating_a_single_node_instance.rst
View File

@ -21,55 +21,48 @@ Procedure
.. table:: **Table 1** Basic information
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Single Node**. |
| | |
| | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.4 |
| | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | |
| | .. 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 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>`. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Database Type | Community Edition |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DB Instance Type | Select **Single Node**. |
| | |
| | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Compatible MongoDB Version | - 4.2 |
| | - 4.0 |
| | - 3.4 |
| | - 3.2 |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Storage Type | Ultra-high I/O |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | |
| | **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

28
umn/source/introduction/dds_db_instance/database_engine_and_version.rst
View File

@ -5,30 +5,4 @@
Database Engine and Version
===========================
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 | |
+-----------------------+-----------------------+-----------------------+
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.

8
zuul.yaml
View File

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