docs: add core-service architecture diagram (#2882)

Author: Panaetius

docs/cheatsheet/conf.py

@@ -42,6 +42,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "plantweb.directive",
     "sphinx.ext.autodoc",
     "sphinx_tabs.tabs",
     "sphinx.ext.napoleon",

docs/conf.py

@@ -42,6 +42,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "plantweb.directive",
     "sphinx.ext.autodoc",
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
@@ -359,7 +360,6 @@
     ("py:class", "Path"),
     ("py:class", "Persistent"),
     ("py:class", "optional"),
-    ("py:class", "persistent.Persistent"),
     ("py:class", '"LocalClient"'),
     ("py:class", '"ValueResolver"'),
     ("py:exc", "errors.ParameterError"),
@@ -369,5 +369,6 @@
     ("py:class", r"calamus.*"),
     ("py:class", r"docker.*"),
     ("py:class", r"marshmallow.*"),
+    ("py:class", r"persistent.*"),
     ("py:class", r"yaml.*"),
 ]

docs/reference/service.rst

@@ -21,6 +21,51 @@ Renku Core Service
 The Renku Core service exposes a functionality similar to the Renku CLI via a
 JSON-RPC API.
 
+Components:
+
+.. uml::
+
+    @startuml
+    skinparam componentStyle rectangle
+    skinparam lineStyle ortho
+
+    component Frontend {
+        [Views] -down-> RequestModel
+        ResponseModel -up-> [Views]
+    }
+
+    component "Business Logic" as bl {
+        [Controllers] --> renku.core
+        [Jobs] --> renku.core
+    }
+
+    database "External Git" as git {
+        folder "Remote Projects" as rp
+    }
+
+    database "Redis" as redis {
+        frame "Metadata" as metadata
+        frame "Jobs" as jobs
+    }
+
+    database "File Cache" as filecache {
+        folder "Projects" as projects
+        folder "Uploaded Files" as files
+    }
+
+    RequestModel -down-> bl
+    bl -up-> ResponseModel
+    [Controllers] -right-> rp
+    [Workers] -right-> bl
+    bl -left-> [Workers]
+    [Workers] -down-> jobs
+    bl -down-> filecache
+    bl -down-> redis
+
+    projects -[hidden]down-> files
+    metadata -[hidden]down-> jobs
+    @enduml
+
 
 API Specification
 -----------------

poetry.lock

@@ -96,6 +96,7 @@ pathspec = "<1.0.0,>=0.8.0"
 patool = "==1.12"
 pexpect = { version = "<4.9.0,>=4.8.0", optional = true }
 pillow = { version = ">=9.0.0,<9.2", optional = true }
+plantweb = { version = ">=1.2.1,<1.3.0", optional = true }
 pluggy = "==1.0.0"
 poetry-dynamic-versioning = { version = "^0.14.0", optional = true }
 portalocker = ">=2.2.1,<2.5"
@@ -206,7 +207,7 @@ tests = [
     "types-tabulate"
 ]
 toil = ["toil"]
-docs = ["renku-sphinx-theme", "sphinx-rtd-theme", "sphinxcontrib-spelling", "sphinx-tabs"]
+docs = ["plantweb", "renku-sphinx-theme", "sphinx-rtd-theme", "sphinxcontrib-spelling", "sphinx-tabs"]
 all = [
     "apispec",
     "apispec-webframeworks",
@@ -225,6 +226,7 @@ all = [
     "mypy",
     "pexpect",
     "pillow",
+    "plantweb",
     "poetry-dynamic-versioning",
     "ptvsd",
     "pydocstyle",