Add schemata into documentation, closes #316

This commit is contained in:
Disassembler 2020-06-16 22:39:46 +02:00
parent 57cef0f4cf
commit d5aca4ad52
No known key found for this signature in database
GPG Key ID: 524BD33A0EE29499
14 changed files with 21 additions and 5 deletions

View File

@ -5,14 +5,14 @@ Basic and runtime images
------------------------
.. csv-table::
:file: images-list-basic.csv
:file: attachments/images-list-basic.csv
:header-rows: 1
Common service images
---------------------
.. csv-table::
:file: images-list-services.csv
:file: attachments/images-list-services.csv
:header-rows: 1
List of application images
@ -21,5 +21,5 @@ List of application images
All application images have the application user UID/GID 8080 and listen on internal port 8080 (HTTP).
.. csv-table::
:file: images-list-apps.csv
:file: attachments/images-list-apps.csv
:header-rows: 1

View File

@ -2,7 +2,7 @@ Map services used in applications
=================================
.. csv-table::
:file: map-services.csv
:file: attachments/map-services.csv
:header-rows: 1
1. Used by CKAN extensions *reclineview*, *spatial* and *geoview*.

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

View File

@ -1,6 +1,10 @@
SPOC architecture
=================
.. image:: attachments/schema-arch-interop.png
:alt: Architecture - Services interoperation schema
:align: center
Configuration file
------------------

View File

@ -1,6 +1,10 @@
SPOC building and packaging
=============================
.. image:: attachments/schema-spoc-builder.png
:alt: Deliverable lifecycle - Building and packaging schema
:align: center
Usage
-----

View File

@ -5,6 +5,10 @@ SPOC is the main component of the platform. It provides means for the layers, im
SPOC is written in python 3.7 and uses LXC as a userspace interface for the Linux kernel containment features. SPOC consists of a python module, configuration file, init task and three main binaries to work with the respective deliverable types.
.. image:: attachments/schema-arch-overview.png
:alt: Architecture - Platform overview schema
:align: center
Goals and non-goals
-------------------
@ -37,7 +41,7 @@ Finally, Docker maintainers explicitly refuse to implement a feature which would
The downside of using LXC is that its usage requires more knowledge about how the linux containers actually work. Another problem is fast availability of the desired image as most 3rd party applications are shipped with `Dockerfile` or directly distributed as Docker images. SPOC/LXC requires rewriting into LXC-compatible containers, however this is simplified by SPOC as the `image building <spoc-builder.html>`_ aims to mimic the features of Docker and automatize LXC container building using *Dockerfile*-like syntax.
In the future, LXC and part of SPOC may be replaced by Podman and Podman-compose to reach even wider audience.
In the future, LXC and part of SPOC may be replaced by Podman and Podman-compose, Vagrant or even Ansible to reach even wider audience.
Package manager
---------------

View File

@ -1,6 +1,10 @@
SPOC user manual
==================
.. image:: attachments/schema-spoc-user.png
:alt: Deliverable lifecycle - User consumption schema
:align: center
Usage
-----