databases(documentdb): document the MongoDB-compatible option by sebartyr · Pull Request #1018 · CleverCloud/documentation

sebartyr · 2026-09-15T16:52:09Z

Summary

New page doc/deploy/databases/documentdb: create a PostgreSQL add-on with --option documentdb=true, environment variables, connection examples (mongosh, Node.js, Python), MongoDB compatibility level (MongoDB 7.0 / wire protocol 21, verified and unavailable features), clustering and high availability, SQL access to documents, backups and restore
New guide guides/node-js-documentdb deploying the sticky notes demo (Express + mongodb driver, per-visitor sandbox, reset button)
Cross-links from the PostgreSQL and MongoDB pages
Side fixes: clever addon link → clever service link-addon in the Node.js & MongoDB guide, corrupted mongo icon markup in data/icons.yaml, Vale vocabulary

Verification

Every documented command and behaviour was run against a real PostgreSQL 18 add-on created with the option: TLS requirement, environment variables, mongosh 2.11, Node.js driver 7.6, PyMongo 4.18, feature matrix (transactions with rollback, GridFS, TTL, vector search, unsupported change streams…), SQL queries on documentdb_api.collection(), pg_dump --exclude-schema=cron. The demo was deployed on Clever Cloud and data persisted across clever restart.

hugo, markdownlint-cli2 and vale pass; tabs, callout, cards and internal links were checked in the generated HTML.

Open points

The demo repository CleverCloud/demo-documentdb still needs to be published before merge
DOCUMENTDB_ADDON_URI doesn't carry the TLS parameters yet (tracked on the API side); the page keeps a callout and explicit driver options until then
To confirm with DBaaS: the option on PostgreSQL 18 (works in production)
Read replicas: the page states they aren't available for the MongoDB-compatible endpoint (PostgreSQL replicas only serve the SQL endpoint, and the gateway offers no secondary routing)

Co-Authored-By: Gilles BIANNIC <github@gillesbiannic.fr>

## 📝 What does this PR do? _Briefly describe your changes and why they are needed_ ## 🔗 Related Issue (if applicable) - Closes # - Related to # --- ## 🧪 Type of Change - [ ] ⚠️ Bug fix - [ ] 📅 Changelog update - [ ] 📚 Documentation update - [ ] ✨ New content/feature - [ ] 🔧 Technical/maintenance --- ## ✅ Quick Checklist - [ ] I have read the [contributing guidelines](https://github.com/CleverCloud/documentation/blob/main/CONTRIBUTING.md) - [ ] The content is accurate and links work - [ ] The site builds without errors --- ## 👥 Reviewers @CleverCloud/reviewers --- <details> <summary>📋 <strong>For major changes</strong> (click to expand)</summary> ### Additional testing performed _Describe any specific testing done for complex changes_ ### Screenshots _Add screenshots for visual/layout changes_ ### Breaking changes _List any breaking changes or migration notes_ </details> --------- Co-authored-by: Steven Le Roux <steven@le-roux.info> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

## 📝 What does this PR do? This PR introduces a new "API update" style of changelog entry, starting with the new CC API endpoint that rotates the GitHub webhook secret of an application and its siblings. --- ## 🧪 Type of Change - [ ] ⚠️ Bug fix - [x] 📅 Changelog update - [x] 📚 Documentation update - [ ] ✨ New content/feature - [ ] 🔧 Technical/maintenance --- ## ✅ Quick Checklist - [x] I have read the [contributing guidelines](https://github.com/CleverCloud/documentation/blob/main/CONTRIBUTING.md) - [x] The content is accurate and links work - [x] The site builds without errors

… node group rules with the CLI

…geting

…iption

…nd webhooks examples

… updates

…omplete examples

…hort option

…ort column

…and Otoroshi examples

… command

…pass

… a Node.js guide

github-actions · 2026-09-15T16:52:24Z

✅ Review app deployed

Check how your changes look like!

ℹ️ Name	🔗 Infos & links
🌱 Latest deployed commit	`57ee9b3`
👁️ Preview	https://documentation-PR-1018.cleverapps.io/developers

…the endpoint

davlgd and others added 30 commits April 24, 2026 16:38

changelog: Kubernetes 1.36

0663bde

chore: update Hextra theme to 0.12.2

5acac29

kubernetes: update flavors and versions

cc72de7

kubernetes: more details, public beta

d96ac52

Co-Authored-By: Gilles BIANNIC <github@gillesbiannic.fr>

kubernetes: Developers > Essential

dee2806

api(v4): update routes, payloads

6155ca7

changelog: Clever Tools 4.9

046b97e

fix: dead links

ebfdd23

changelog: images updates, 2026W18

32c4c33

administrate(ssl): update GPG public key for sending encrypted emails

5d4e12d

changelog: Otoroshi 17.15

f02de5f

reference(env vars): rename VPN add-on env vars to CC_VPN_*

8390eec

addons(elastic): add note about migrations

d6e2168

applications: add note about runtime extensions support

6c58dd5

applications: update options for unsupported runtimes

4d38f4f

chore(icons): add npm in new Package managers section

d1b1840

chore(icons): add pnpm

e3fea1b

chore(icons): add yarn

7d21e48

chore(icons): add github in new Brands and services section

d245ca4

chore(icons): add aws

354c86c

chore(icons): add minio

7730a03

chore(icons): add apple in new Operating systems section

ef5910a

chore(icons): add windows

d1d21ba

chore(icons): add json in new Data formats section

cf93339

chore(icons): add yaml

a220eef

chore(icons): add toml

2550a39

chore(icons): add envelope in new UI utility section

1021fd2

chore(icons): add mistral in new AI assisstants section

8db989d

davlgd and others added 20 commits September 11, 2026 16:23

manage(cli): align Kubernetes defaults, kubeconfig, version check and…

a287b34

… node group rules with the CLI

manage(cli): fix the kv COMMAND example and document organisation tar…

4b93ff2

…geting

manage(cli): fix the Network Group member domain and get-config descr…

7d4e60f

…iption

manage(cli): document notification scopes and complete notify-email a…

606f30d

…nd webhooks examples

manage(cli): add the Otoroshi Swagger UI and clarify operator version…

3c94bd7

… updates

manage(cli): show the active profile and JSON profile listing

c0d059d

manage(cli): replace published-config and service placeholders with c…

c86d612

…omplete examples

api: drop the obsolete tokens feature flag from the Clever Tools example

269dd89

tips-and-tricks: fix the ssh application option and the JSON output s…

93fcd7e

…hort option

develop(access-logs): document TCP and SSH access logs and the transp…

3c08370

…ort column

deploy(operators): pass the target version with --target in Metabase …

a1d55eb

…and Otoroshi examples

develop(logs): accept add-on real IDs and durations in logs examples

8c73539

find-help(faq): replace the database backups synopsis with a runnable…

5234971

… command

manage(cli): mark option lists as text instead of console commands

de8b109

changelog: Clever Tools 5.0

e84fb0b

fix(aliases): redirect URLs still hit with 404s since the last alias …

ecd3b72

…pass

fix(data): repair the mongo icon markup

094c2fd

chore(vale): accept DocumentDB vocabulary

bf25057

guides(node-js-mongo-db): fix the add-on link command

7f9e800

databases(documentdb): document the MongoDB-compatible option and add…

fcfb856

… a Node.js guide

sebartyr temporarily deployed to update doc September 15, 2026 16:52 — with GitHub Actions Inactive

sebartyr force-pushed the databases/documentdb branch from 6333be4 to fcfb856 Compare September 15, 2026 16:55

sebartyr temporarily deployed to update doc September 15, 2026 16:55 — with GitHub Actions Inactive

sebartyr marked this pull request as draft September 15, 2026 16:59

databases(documentdb): state that read replicas aren't available for …

57ee9b3

…the endpoint

sebartyr temporarily deployed to update doc September 15, 2026 17:31 — with GitHub Actions Inactive

davlgd force-pushed the main branch from c6994c3 to 3a3b342 Compare September 21, 2026 07:40

davlgd force-pushed the main branch from bab9f1c to efa8993 Compare October 2, 2026 17:01

davlgd force-pushed the main branch from b221a33 to 5d328d6 Compare October 14, 2026 20:47

Navigation Menu

Repository navigation

databases(documentdb): document the MongoDB-compatible option - #1018

databases(documentdb): document the MongoDB-compatible option#1018
sebartyr wants to merge 251 commits into
mainfrom
databases/documentdb

sebartyr commented Sep 15, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 15, 2026 •

edited

Loading

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

19 participants

Conversation

sebartyr commented Sep 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Open points

Uh oh!

github-actions Bot commented Sep 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Review app deployed

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

19 participants

sebartyr commented Sep 15, 2026 •

edited

Loading

github-actions Bot commented Sep 15, 2026 •

edited

Loading