From ba6599f4155da21d2b356847b0d85fdfb5431d33 Mon Sep 17 00:00:00 2001
From: Nour AL KOTOB <nour.alkotob@hyland.com>
Date: Mon, 8 Jul 2024 18:56:21 +0200
Subject: [PATCH] NXDOC-2686: Document Amazon DocumentDB support

---
 .../administration/database-configuration.md  |  1 +
 .../database-configuration/documentdb.md      | 55 +++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md

diff --git a/src/nxdoc/nuxeo-server/administration/database-configuration.md b/src/nxdoc/nuxeo-server/administration/database-configuration.md
index 0b5e606ba3..d3856aed54 100644
--- a/src/nxdoc/nuxeo-server/administration/database-configuration.md
+++ b/src/nxdoc/nuxeo-server/administration/database-configuration.md
@@ -163,6 +163,7 @@ This takes two steps:
     *   [MySQL]({{page page='mysql'}})
     *   [MariaDB]({{page page='mariadb'}})
     *   [MongoDB]({{page page='mongodb'}})
+    *   [DocumentDB]({{page page='documentdb'}})
 2.  [Connect Nuxeo to the database]({{page page='connecting-nuxeo-to-the-database'}}).
 
 &nbsp;
diff --git a/src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md b/src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md
new file mode 100644
index 0000000000..0682fb4df6
--- /dev/null
+++ b/src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md
@@ -0,0 +1,55 @@
+---
+title: Amazon DocumentDB
+labels:
+    - database
+    - documentdb
+tree_item_index: 700
+
+---
+`DocumentDB` is compatible with `MongoDB`, therefore, it can be used by `Nuxeo` like a `MongoDB` backend,
+but there are limitations.
+
+{{#> callout type='warning' heading='elastic clusters are not supported'}}
+Only DocumentDB "instance cluster" has been successfully tested with Nuxeo.
+The DocumentDB "elastic cluster" behaves differently from MongoDB regarding index initialization. At the moment it cannot be used by Nuxeo.
+{{/callout}}
+
+{{#> callout type='info' heading='about cluster types'}}
+Instance clusters come in various sizes, see [quotas and limits](https://docs.aws.amazon.com/documentdb/latest/developerguide/limits.html#limits.instance)
+While their limitations can also be found in the previous link, elastic clusters are designed to handle much bigger loads, see [Using elastic clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-using-elastic-clusters.html)
+{{/callout}}
+
+## Limitations
+
+- fulltext search at repository level using `DocumentDB` is not supported due to `DocumentDB` limitations. You need to rely on `Elasticsearch` or `OpenSearch`. This requires to disable repository fulltext search. See the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section.
+- retryable writes are not supported. You need to disable this. See the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section.
+- the `DocumentDB` instance type chosen affects the number of open cursor at any given time.
+
+Note there are also other differences that should not affect Nuxeo. Please refer to `DocumentDB`:
+- [Differences With MongoDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/text-search.html#text-index-mongo-diff)
+- [Functional Differences](https://docs.aws.amazon.com/documentdb/latest/developerguide/functional-differences.html#functional-differences.with-mongodb)
+
+## Configuration
+
+To use `DocumentDB` you need the following options:
+
+```properties
+nuxeo.templates=<MY_TEMPLATES>,mongodb
+nuxeo.vcs.fulltext.search.disabled=true
+nuxeo.mongodb.server=<MONGO_URL>?retryWrites=false
+```
+
+For all other configuration information, please refer to the [MongoDB configuration page]({{page page='mongodb'}}).
+
+* * *
+
+<div class="row" data-equalizer data-equalize-on="medium"><div class="column medium-6">{{#> panel heading='Related topics'}}
+
+- [Connecting Nuxeo to the Database]({{page page='connecting-nuxeo-to-the-database'}})
+- [How to Estimate Volume Usage]({{page page='how-to-estimate-volume-usage'}})
+
+{{/panel}}</div><div class="column medium-6">
+
+&nbsp;
+
+</div></div>