Update docs

riotkit-org · Jul 31, 2020 · 208b010 · 208b010
1 parent 4445e11
commit 208b010
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 0 deletions.
diff --git a/docs/harbor-architecture.png b/docs/harbor-architecture.png
diff --git a/docs/source/_static/css/riotkit.css b/docs/source/_static/css/riotkit.css
@@ -0,0 +1,8 @@
+table.right-align-right-col {
+    text-align: right
+}
+
+.wy-nav-content {
+    max-width: none;
+    width: 100%;
+}
diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst
@@ -0,0 +1,14 @@
+Understanding architecture
+==========================
+
+Harbor imposes the architecture of a centralized gateway for web services. It is just like in a cloud, or in Kubernetes -
+the centralized Ingress/Webserver takes the traffic and routes it to other services.
+
+.. image:: ../harbor-architecture.png
+
+**Advantages:**
+
+- Easy to manage, and to maintain, one router to reload
+- Integration with services such as LetsEncrypt without additional work to be done
+- Most popular architecture for hosting multiple services
+- SSL termination at the router edge makes SSL support almost transparent to applications
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,6 +22,14 @@
 html_theme = 'glpi'
 html_theme_path = sphinx_glpi_theme.get_html_themes_path()
 
+html_theme_options = {
+    'body_max_width': None
+}
+
+html_css_files = [
+    'css/riotkit.css',
+]
+
 html_static_path = ['_static']
 htmlhelp_basename = 'DockerProjectTemplatedoc'
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -24,6 +24,7 @@ RiotKit Harbor 2
    structure
    basic-commands
    creating-first-service
+   architecture
 
 
 From authors