From 58670e617defe611b0985130ec65c63b706a55a2 Mon Sep 17 00:00:00 2001 From: Andreas Fritzler Date: Thu, 3 Aug 2023 16:21:03 +0200 Subject: [PATCH] Add overall architecture documentation Co-authored-by: Lukas Frank --- docs/architecture/README.md | 9 ++++++ docs/architecture/multi-cluster-setup.svg | 33 ++++++++++++++++++++++ docs/architecture/overall-architecture.svg | 17 +++++++++++ mkdocs.yml | 9 ++++-- 4 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 docs/architecture/README.md create mode 100644 docs/architecture/multi-cluster-setup.svg create mode 100644 docs/architecture/overall-architecture.svg diff --git a/docs/architecture/README.md b/docs/architecture/README.md new file mode 100644 index 000000000..c0873135b --- /dev/null +++ b/docs/architecture/README.md @@ -0,0 +1,9 @@ +# Architecture + +## Overview + +![overall architecture](overall-architecture.svg) + +## Example of a cross cluster setup + +![multi cluster setup](multi-cluster-setup.svg) diff --git a/docs/architecture/multi-cluster-setup.svg b/docs/architecture/multi-cluster-setup.svg new file mode 100644 index 000000000..8e9f0b6f0 --- /dev/null +++ b/docs/architecture/multi-cluster-setup.svg @@ -0,0 +1,33 @@ + + + + + + + + + + api-serverapi-serverapi-serverapi-servercontroller-managerapi-servercontroller-managercontroller-managercontroller-manager<kind>-poollet<kind>-poollet<kind>-poolletcontroller-manager<kind>-poollet diff --git a/docs/architecture/overall-architecture.svg b/docs/architecture/overall-architecture.svg new file mode 100644 index 000000000..5a3b845e3 --- /dev/null +++ b/docs/architecture/overall-architecture.svg @@ -0,0 +1,17 @@ + + + + + + + + api-servercompute-controllernetworking-controllerkubernetes clusteripam-controllerstorage-controllercontroller-manager<kind>-pool<kind>-poolletannouncesreferences<kind>-resource<kind>-classreferencespoollet-managerbrokerresourcesprovisionsresourcesresourcesapi-servercompute-controllernetworking-controlleripam-controllerstorage-controllercontroller-managerkubernetes clusterlandscapeconfigurationdeploy<kind>-classdeploy<kind>-pool<kind>-poolletpoollet-managerpool-provider<kind>-resourcereferenceannouncecreate/update/watchupdate/watchreference \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 20384283d..6daa29cee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,8 +49,13 @@ markdown_extensions: nav: - Home: README.md - Concepts: - - Machine Exec: concepts/machine-exec-flow.md -- Architecture: README.md + - Machine Exec: concepts/machine-exec-flow.md +- Architecture: architecture/README.md +- Components: + - API Server: README.md + - Controller Manager: README.md + - Poollet: README.md + - Broker: README.md - Usage: README.md - Developer Guide: - Local Setup: development/setup.md