EOX GitLab Instance

Skip to content
Snippets Groups Projects
Verified Commit f76986ee authored by Stephan's avatar Stephan
Browse files

propose some update of the heading structure

parent 8f141f50
No related branches found
No related tags found
1 merge request!8Docs
...@@ -3,39 +3,42 @@ ...@@ -3,39 +3,42 @@
Initialization Initialization
============== ==============
In order to set up an instance of VS, the ``pvs_starter`` utility is In order to set up an instance of the View Server (VS), the separate
recommended. It is distributed as a Python package, easily installed via ``pvs_starter`` utility is recommended.
``pip``.
Running the Initialization
--------------------------
The ``pvs_starter`` utility is distributed as a Python package and easily
installed via ``pip``.
.. code-block:: bash .. code-block:: bash
pip3 install pvs_starter # TODO: git url pip3 install pvs_starter # TODO: git url
Now a new VS instance can be set up like this:
Now the VS instance can be set up like this:
.. code-block:: bash .. code-block:: bash
python3 -m pvs_starter.cli config.yaml out/ -f python3 -m pvs_starter.cli config.yaml out/ -f
This takes the initialization configuration ``config.yaml`` to generate This takes the initialization configuration ``config.yaml`` to generate
the structure in the ``out/`` directory. the required structure of a new VS instance in the ``out/`` directory.
Initialization config Configuration of the Initialization
--------------------- -----------------------------------
The important part of the initialization is the configuration. The format is The important part of the initialization is the configuration. The file is
structured in YAML and will be detailed here. It contains the following structured in YAML as detailed below. It contains the following
sections: sections:
``database`` ``database``
~~~~~~~~~~~~ ~~~~~~~~~~~~
Here, access credentials of the database are stored. It defines the Here, access details and credentials of the database are stored. It defines the
internal database name, user and password that will be created when the stack internal database name, user, and password that will be created when the stack
is deployed. Note that there is no ``host`` setting, as this will be handled is deployed. Note that there is no ``host`` setting, as this will be handled
automatically. automatically within the Docker Swarm.
.. code-block:: yaml .. code-block:: yaml
...@@ -130,7 +133,7 @@ and ``mask`` types are to be generated. ...@@ -130,7 +133,7 @@ and ``mask`` types are to be generated.
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
In the ``collections`` section, the collections are set up and it is defined In the ``collections`` section, the collections are set up and it is defined
which products of based on ``product_type`` and ``product_level`` will be inserted into them. The which products based on ``product_type`` and ``product_level`` will be inserted into them. The
``product_types`` must list types defined in the ``products`` section. ``product_types`` must list types defined in the ``products`` section.
.. code-block:: yaml .. code-block:: yaml
...@@ -147,7 +150,7 @@ which products of based on ``product_type`` and ``product_level`` will be insert ...@@ -147,7 +150,7 @@ which products of based on ``product_type`` and ``product_level`` will be insert
~~~~~~~~~~~~ ~~~~~~~~~~~~
Here, the three relevant storages can be configured: the ``source``, Here, the three relevant storages can be configured: the ``source``,
``preprocessed`` and ``cache`` storages. ``preprocessed``, and ``cache`` storages.
The ``source`` storage defines the location from which the original files will be The ``source`` storage defines the location from which the original files will be
downloaded to be preprocessed. Preprocessed images and metadata will then be downloaded to be preprocessed. Preprocessed images and metadata will then be
...@@ -271,6 +274,6 @@ This section defines the exposed services, and how the layers shall be cached in ...@@ -271,6 +274,6 @@ This section defines the exposed services, and how the layers shall be cached in
title: VHR Image 2018 Level 3 NDVI title: VHR Image 2018 Level 3 NDVI
abstract: VHR Image 2018 Level 3 NDVI abstract: VHR Image 2018 Level 3 NDVI
style: earth style: earth
# grids? cache options? # TODO grids? cache options?
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment