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_umn-1004
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

1 Commits
main ... propose-dd

Author SHA1 Message Date
OpenTelekomCloud Proposal Bot
7471987d01 Update content 2024-01-04 12:58:26 +00:00
14 changed files with 97 additions and 73 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. |
| | | |

3
doc/requirements.txt
View File

@ -7,5 +7,4 @@ 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

21
tox.ini
View File

@ -45,19 +45,15 @@ commands =
{[testenv:json-best-practice]commands}
[testenv:docs-pdf]
deps =
{[testenv:docs]deps}
{[testenv:bindeps]deps}
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir
wget
make
bash
cp
commands =
mkdir -p doc/build/pdf
{[testenv:bindeps]commands}
{[testenv:umn-pdf-docs]commands}
{[testenv:best-practice-pdf-docs]commands}
@ -184,21 +180,6 @@ commands =
[testenv:bindeps]
deps =
bindep
allowlist_externals =
wget
rm
bash
commands =
rm -rf {toxinidir}/bindep.txt
rm -rf {toxinidir}/packages.txt
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
[doc8]
ignore = D001
extensions = .rst, .yaml

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

@ -60,15 +60,23 @@ Procedure
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - **Enabled**: Enable encryption. 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:: |
| | .. 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*. |
| | - After an instance is created, the disk encryption status and the key cannot be changed. Disk encryption will not encrypt backup data stored in OBS. |
| | |
| | - To check whether the disk is encrypted, you can view **Disk Encrypted** in the DB instance list. |
| | |
| | - If disk encryption or backup data encryption is enabled, keep the key properly. Once the key is disabled, deleted, or frozen, the database will be unavailable and data may not be restored. |
| | |
| | If disk encryption is enabled but backup data encryption is not enabled, you can :ref:`restore data to a new instance from backups <dds_03_0042>`. |
| | |
| | If both disk encryption and backup data encryption are enabled, data cannot be restored. |
| | |
| | - 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

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

@ -60,15 +60,23 @@ Procedure
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - **Enabled**: Enable encryption. 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:: |
| | .. 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*. |
| | - After an instance is created, the disk encryption status and the key cannot be changed. Disk encryption will not encrypt backup data stored in OBS. |
| | |
| | - To check whether the disk is encrypted, you can view **Disk Encrypted** in the DB instance list. |
| | |
| | - If disk encryption or backup data encryption is enabled, keep the key properly. Once the key is disabled, deleted, or frozen, the database will be unavailable and data may not be restored. |
| | |
| | If disk encryption is enabled but backup data encryption is not enabled, you can :ref:`restore data to a new instance from backups <dds_03_0042>`. |
| | |
| | If both disk encryption and backup data encryption are enabled, data cannot be restored. |
| | |
| | - 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

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

@ -62,15 +62,23 @@ You can use your account to create up to 50 replica set instances. To create mor
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - **Enabled**: Enable encryption. 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:: |
| | .. 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*. |
| | - After an instance is created, the disk encryption status and the key cannot be changed. Disk encryption will not encrypt backup data stored in OBS. |
| | |
| | - To check whether the disk is encrypted, you can view **Disk Encrypted** in the DB instance list. |
| | |
| | - If disk encryption or backup data encryption is enabled, keep the key properly. Once the key is disabled, deleted, or frozen, the database will be unavailable and data may not be restored. |
| | |
| | If disk encryption is enabled but backup data encryption is not enabled, you can :ref:`restore data to a new instance from backups <dds_03_0043>`. |
| | |
| | If both disk encryption and backup data encryption are enabled, data cannot be restored. |
| | |
| | - 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

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

@ -62,15 +62,23 @@ You can use your account to create up to 50 replica set instances. To create mor
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Disk Encryption | - **Disabled**: Disable the encryption function. |
| | |
| | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. |
| | - **Enabled**: Enable encryption. 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:: |
| | .. 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*. |
| | - After an instance is created, the disk encryption status and the key cannot be changed. Disk encryption will not encrypt backup data stored in OBS. |
| | |
| | - To check whether the disk is encrypted, you can view **Disk Encrypted** in the DB instance list. |
| | |
| | - If disk encryption or backup data encryption is enabled, keep the key properly. Once the key is disabled, deleted, or frozen, the database will be unavailable and data may not be restored. |
| | |
| | If disk encryption is enabled but backup data encryption is not enabled, you can :ref:`restore data to a new instance from backups <dds_03_0043>`. |
| | |
| | If both disk encryption and backup data encryption are enabled, data cannot be restored. |
| | |
| | - 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

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

@ -66,8 +66,16 @@ Procedure
| | |
| | .. 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. |
| | - After an instance is created, the disk encryption status and the key cannot be changed. Disk encryption will not encrypt backup data stored in OBS. |
| | |
| | - To check whether the disk is encrypted, you can view **Disk Encrypted** in the DB instance list. |
| | |
| | - If disk encryption or backup data encryption is enabled, keep the key properly. Once the key is disabled, deleted, or frozen, the database will be unavailable and data may not be restored. |
| | |
| | If disk encryption is enabled but backup data encryption is not enabled, you can :ref:`restore data to a new instance from backups <dds_03_0042>`. |
| | |
| | If both disk encryption and backup data encryption are enabled, data cannot be restored. |
| | |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -66,8 +66,16 @@ Procedure
| | |
| | .. 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. |
| | - After an instance is created, the disk encryption status and the key cannot be changed. Disk encryption will not encrypt backup data stored in OBS. |
| | |
| | - To check whether the disk is encrypted, you can view **Disk Encrypted** in the DB instance list. |
| | |
| | - If disk encryption or backup data encryption is enabled, keep the key properly. Once the key is disabled, deleted, or frozen, the database will be unavailable and data may not be restored. |
| | |
| | If disk encryption is enabled but backup data encryption is not enabled, you can :ref:`restore data to a new instance from backups <dds_03_0042>`. |
| | |
| | If both disk encryption and backup data encryption are enabled, data cannot be restored. |
| | |
| | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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