Commit cec431d6 authored by André Anjos's avatar André Anjos 💬

[doc] Improved admin docs

parent 0f5aa7cb
Pipeline #1803 failed with stage
This diff is collapsed.
......@@ -32,43 +32,45 @@ necessary.
.. _administratorguide-architecture-software:
.. figure:: img/platform-overview.*
:width: 60%
:width: 40%
:align: center
Software architecture of the platform
:num:`Figure #administratorguide-architecture-software` represents the
software architecture of the platform, where the interaction between the
following modules are shown:
:numref:`administratorguide-architecture-software` represents the software
architecture of the platform, where the interaction between the following
modules are shown:
* The **Web Server**, allows the users to interact, online, with the platform.
* The **Experiments**, describes fully parametrized scientific workflows as a
set of organized transformations, from the use of raw data from databases
such as images, to the generation of results such as ROC plots. Each
experiment can, hence, be decomposed into a set of execution jobs.
* The **Scheduler**, distributes jobs on the **Worker Nodes**, also called
* The **Scheduler**, assigns jobs on the **Worker Nodes**, also called
processing nodes.
* The **Cache**, stores all the data written by the experiments
* The **Object Repository**, contains all the objects required to define
scientific experiments, such as algorithm implementations and experiment
parameters.
* The **Experiment, State and Cache Database**, contains all the objects
required to define scientific experiments, such as algorithm implementations
and experiment parameters, as well the current load state of the processing
farm together with intermediary data produced by the experiments (cache). The
backend communicates to the frontend via this database.
.. _administratorguide-architecture-hardware:
.. figure:: img/hardware-architecture.*
:width: 50%
:align: center
Hardware architecture of the platform
:num:`Figure #administratorguide-architecture-hardware` represents the
matching hardware architecture of the platform. Each component in this figure
could be deployed on a different computer, as long as it can establish a
connection with all the other components it needs to interact with. In this
case, this would make possible to distribute the load on several machines.
However, it should be equally possible to accommodate all software components
into a single (multi-core) computer for tests or demonstrations. To benefit
from commodity computing, plain Intel-compatible PC's either in desktop or
rack-mountable format are recommended for deployment. Network connectivity,
if necessary, is assumed IP (Internet Protocol) based.
:numref:`administratorguide-architecture-hardware` represents the matching
hardware architecture of the platform. Each component in this figure could be
deployed on a different computer, as long as it can establish to the central
database server and storage. In this case, this would make possible to
distribute the load on several machines. It should be equally possible to
accommodate all software components into a single (multi-core) computer for
tests or demonstrations. To benefit from commodity computing, plain
Intel-compatible PC's either in desktop or rack-mountable format are
recommended for deployment.
Wedding List
......
......@@ -38,7 +38,7 @@ The administrative command ``qsetup`` can be used to configure or re-configure
the backend:
.. command-output:: ./bin/django qsetup --help
:cwd:../..
:cwd: ../..
This command will check current queue usage w.r.t. submitted experiments and
......@@ -56,7 +56,7 @@ If your cache becomes very large, you may have to delete old files. The
administative command ``cleanup_cache`` can help you in that task:
.. command-output:: ./bin/django cleanup_cache --help
:cwd:../..
:cwd: ../..
This command will first check running experiments and database files and make
......
......@@ -47,7 +47,9 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
]
'sphinxcontrib.ansi',
'sphinxcontrib.programoutput',
]
import sphinx
if sphinx.__version__ >= "1.4.1":
......
......@@ -59,9 +59,9 @@ Distributed processing nodes
Distributed processing nodes
In this scenario, depicted in :num:`Figure
#administratorguide-usecaseanalysis-distributed-nodes`, every processing node
is running on a dedicated machine.
In this scenario, depicted in
:numref:`administratorguide-usecaseanalysis-distributed-nodes`, every
processing node is running on a dedicated machine.
One computer acts as the web front-end, handling all the incoming requests from
the users, scheduling the jobs on the processing nodes and sending the results
......@@ -82,8 +82,8 @@ Load-balanced distributed architecture
Load-balanced distributed architecture
In this scenario, depicted in :num:`Figure
#administratorguide-usecaseanalysis-load-balancing`, every module (web
In this scenario, depicted in
:numref:`administratorguide-usecaseanalysis-load-balancing`, every module (web
server, database server, scheduler, processing node) is running on a dedicated
machine.
......
......@@ -91,10 +91,10 @@ Summary
Physical hardware of the platform deployed at Idiap
The resulting hardware infrastructure is summarized in :num:`Figure
#administratorguide-idiapplatform-hardware-physical`. Communication
between each machine and the storage is through a 10Gbits/s switch
HP Procurve E8212zl.
The resulting hardware infrastructure is summarized in
:numref:`administratorguide-idiapplatform-hardware-physical`. Communication
between each machine and the storage is through a 10Gbits/s switch HP Procurve
E8212zl.
.. _administratorguide-idiap_platform-virtualization:
......
This diff is collapsed.
This diff is collapsed.
......@@ -40,9 +40,9 @@ BEAT platform.
:numbered:
architecture
idiap_platform
applications
deployment_guidelines
installation
backend
idiap_platform
platform_extension
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment