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

Compare commits

merge into: lboka:confpy
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
...
pull from: lboka:main
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

7 Commits
confpy ... main

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

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

Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-01-11 12:49:38 +00:00
proposalbot
da6cbcc3a5 Changes to dds_api-ref from docs/doc-exports#997 (WIP: Update Metadata) 
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-01-02 13:48:02 +00:00
Gode, Sebastian
40e37c8637 Update tox.ini && conf.py file 
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
 2023-11-14 13:35:47 +00:00
proposalbot
45c9ba0e77 Changes to dds_api-ref from docs/doc-exports#936 (adding drs best-practice metad 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-10-25 13:04:14 +00:00
Hasko, Vladimir
8951b1eb57 adding best-practice to sbv 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-10-24 22:16:22 +00:00
10 changed files with 130 additions and 39 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. | | | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. | | disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
| | | | | | | | | |
| | | | If this parameter is not transferred, disk encryption is not performed. | | | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -479,7 +479,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Sharding", "mode": "Sharding",
"flavor": [ "flavor": [
{ {
@ -528,7 +528,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "ReplicaSet", "mode": "ReplicaSet",
"flavor": [ "flavor": [
{ {
@ -566,7 +566,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
"mode": "Single", "mode": "Single",
"flavor": [ "flavor": [
{ {

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

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

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 .. table:: **Table 5** RecycleDatastore
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+========================================================================================================+ +=======================+=======================+======================================================================================================================+
| type | String | Database type. The value is **DDS-Community**. | | type | String | Database type. The value is **DDS-Community**. |
| | | | | | | |
| | | Enumerated values: | | | | Enumerated values: |
| | | | | | | |
| | | - DDS-Community | | | | - DDS-Community |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
| version | String | Database version. Versions 3.4, 4.0, and 4.2 are supported. The value can be **3.4, 4.0,** or **4.2**. | | version | String | Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be **3.4, 4.0,** **4.2,** or **4.4**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
- Response Example - Response Example

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

6
doc/requirements.txt
View File

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

11
doc/source/conf.py
View File

@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = ''
otcdocs_doc_link = ''
otcdocs_doc_title = ''
otcdocs_doc_type = ''
otcdocs_service_category = 'database'
otcdocs_service_title = 'Document Database Service'
otcdocs_service_type = 'dds'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.

3
doc/source/index.rst
View File

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

99
tox.ini
View File

File diff suppressed because it is too large Load Diff

8
zuul.yaml
View File

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