From eac9ecf677144e5f85a6c97a25ea13d842371ae1 Mon Sep 17 00:00:00 2001 From: Derek Date: Sun, 15 Nov 2026 08:30:29 +1100 Subject: [PATCH] docs(architecture): correct database and add three opening details The architecture page still named FerretDB as MongoDB's replacement. ADR 0006 replaced FerretDB with DocumentDB. The opening now names DocumentDB. The opening also adds: - The DFE 2.1 discovery tool's ported enhancements. - Rule generation from the current query. - Native JSON with the ClickHouse JSON type. --- docs/architecture/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/architecture/README.md b/docs/architecture/README.md index ce36858b..77b68f64 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -4,14 +4,19 @@ HyperDX is DFE's **visualisation and search layer**: engineers use it to search logs, view traces, build dashboards and replay sessions. Detection, alerting and response are the DFE platform's job, not HyperDX's. -Three things make our deployment different from stock HyperDX, and everything +Five things make our deployment different from stock HyperDX, and everything else follows from them: -- **Authentication is external.** Envoy terminates OIDC and passes identity - headers; HyperDX never sees a password. -- **Authorization is the DFE engine's.** It is the policy decision point, and +- Authentication is external: Envoy terminates OIDC and passes identity + headers, and HyperDX never sees a password. +- Authorization is the DFE engine's: it is the policy decision point, and ClickHouse GRANTs enforce data access. -- **MongoDB is replaced** by FerretDB over PostgreSQL. +- MongoDB is replaced by DocumentDB, PostgreSQL with the DocumentDB + extensions and its Mongo wire-protocol gateway in one container + ([ADR 0006](../decisions/0006-documentdb-replaces-ferretdb.md)). +- The DFE 2.1 discovery tool's enhancements are ported in. +- Rules are generated from the query you are iterating in front of you. +- JSON is native throughout, the ClickHouse JSON type included. What we changed to achieve that, and how we keep it working across upstream releases, is [the fork documentation](../fork/README.md).