From abed9ab20eb29d6f0b010772c3849be58158a054 Mon Sep 17 00:00:00 2001 From: David Leifker Date: Mon, 24 Jul 2023 14:49:58 -0500 Subject: [PATCH 1/2] docs(docker): document docker container dependency tree --- docs-website/sidebars.js | 1 + docs/architecture/docker-containers.md | 27 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/architecture/docker-containers.md diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js index 85fa61b88ab7e..a40e1348db7aa 100644 --- a/docs-website/sidebars.js +++ b/docs-website/sidebars.js @@ -445,6 +445,7 @@ module.exports = { "docs/components", "docs/architecture/metadata-ingestion", "docs/architecture/metadata-serving", + "docs/architecture/docker-containerrs", ], }, { diff --git a/docs/architecture/docker-containers.md b/docs/architecture/docker-containers.md new file mode 100644 index 0000000000000..099a4fe21597a --- /dev/null +++ b/docs/architecture/docker-containers.md @@ -0,0 +1,27 @@ +--- +title: "Docker Container Architecture" +--- + +# Docker Container Architecture + +When running DataHub via docker-compose. or helm, the following is a diagram of the containers involved +with running DataHub and their relationships with each other. The helm chart uses helm hooks to determine +the proper ordering of the components whereas docker-compose relies on a series of health checks. + +```text + datahub-frontend-react datahub-actions + \ / + | datahub-upgrade (NoCodeDataMigration, helm only) + | / + datahub-gms (healthy) + | + datahub-upgrade (SystemUpdate completed) + /--------------------/ | \ \------------------------------------------------\ + / | \-------------------\ \ +mysql-setup (completed) elasticsearch-setup (completed) kafka-setup (completed) (if apply) neo4j (healthy) + | | / \ + | | / \ +mysql (healthy) elasticsearch (healthy) broker (healthy) (if not internal) schema-registry (healthy) + | + zookeeper (healthy) +``` \ No newline at end of file From a90f2a9de9d3083fc128e68f50953e4641bd2136 Mon Sep 17 00:00:00 2001 From: david-leifker <114954101+david-leifker@users.noreply.github.com> Date: Fri, 28 Jul 2023 12:53:32 -0500 Subject: [PATCH 2/2] Update sidebars.js --- docs-website/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js index a40e1348db7aa..ce912c137145b 100644 --- a/docs-website/sidebars.js +++ b/docs-website/sidebars.js @@ -445,7 +445,7 @@ module.exports = { "docs/components", "docs/architecture/metadata-ingestion", "docs/architecture/metadata-serving", - "docs/architecture/docker-containerrs", + "docs/architecture/docker-containers", ], }, {