From 4dc4d69e427c8043e8730493fb29371df8a07ffb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20Mei=C3=9Fl?= <stephan.meissl@eox.at> Date: Mon, 29 Jun 2020 16:01:14 +0200 Subject: [PATCH] formatting and some adjustments --- documentation/operator-guide/intro.rst | 34 ++++++++++++++------------ 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/documentation/operator-guide/intro.rst b/documentation/operator-guide/intro.rst index f00806ca..f4532cf8 100644 --- a/documentation/operator-guide/intro.rst +++ b/documentation/operator-guide/intro.rst @@ -3,12 +3,12 @@ Introduction ============ -This guide will detail the operation of a View Server and all of its +This guide details the operation of a View Server and all of its components. Since the View Server is a Docker based software and all of its components are -distributed and executed in context of Docker images and containers, a -knowledge of Docker and Docker Swarm is required. +distributed and executed in context of Docker images and containers, basic +knowledge of Docker and Docker Swarm is a prerequisite. Components ---------- @@ -18,7 +18,7 @@ respective Docker image in parenthesis): - Ingestor (ingestor) - Preprocessor (preprocessor) - - Registrator (core) + - Registrar (core) - Renderer (core) - Cache (cache) - Seeder (cache) @@ -34,11 +34,13 @@ Docker Images ------------- The software is distributed as Docker images, which can be instantiated -and run in their intended role. Some images are hosted on the docker hub, +and run in their intended role. Some images are hosted on +`docker hub <https://hub.docker.com/>`_, the official and default repository for Docker images. Other images reside -on the gitlab.eox.at repository. Images from the official repository -are only identified via their name, whereas images from the eox repository -conventionally use the full URL, including the domain name. +on an `EOX hosted registry <gitlab.eox.at>`_. Images from the official registry +are only identified via their name, whereas images from the EOX registry +conventionally use the full URL, including the domain name. Below is a list of +the used images: - mdillon/postgis:10 - redis @@ -51,15 +53,15 @@ conventionally use the full URL, including the domain name. Configuration Files ------------------- -The following configuration files will impact the behavior of the View Server: +The following configuration files impact the behavior of the View Server: - - index.html: This is the main file to configure the client. In this file, - the viewing layer, search and download enpoints are configured. Usually - this is associated with additional backdrop and overlay layers. - - preprocessor.yml: This file configures the preprocessing process. - - mapcache.xml: This file defines the input sources of the cache and its - published layers. - - init-db.sh: This file sets up the registrator and renderer side of the VS, + - `index.html`: This is the main file to configure the client. In this file, + the viewing layer, search and download endpoints are configured. Usually + this is associated with additional backdrop and overlay layers. + - `preprocessor.yml`: This file configures the preprocessing steps. + - `mapcache.xml`: This file defines the input sources of the cache and its + published layers. + - `init-db.sh`: This file sets up the registrar and renderer side of the VS. Setup ----- -- GitLab