diff --git a/docs/harbor-architecture.png b/docs/harbor-architecture.png new file mode 100644 index 0000000..2f315dc Binary files /dev/null and b/docs/harbor-architecture.png differ diff --git a/docs/source/_static/css/riotkit.css b/docs/source/_static/css/riotkit.css new file mode 100644 index 0000000..0d62b2f --- /dev/null +++ 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 new file mode 100644 index 0000000..e888dd7 --- /dev/null +++ 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 index 976af7a..a8b931c 100644 --- 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 index 283b03d..d97eb6b 100644 --- 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