From 69c22eca3352a6f94a8c707b2558528911559845 Mon Sep 17 00:00:00 2001
From: Lubomir Bucek <lubomir.bucek@eox.at>
Date: Tue, 20 Oct 2020 16:13:16 +0200
Subject: [PATCH] update readme
---
README.md | 20 +++++++++++++++-----
conftest.py | 10 ----------
2 files changed, 15 insertions(+), 15 deletions(-)
delete mode 100644 conftest.py
diff --git a/README.md b/README.md
index 9333a429..3cce22ff 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ configuration, installation instructions, as well as canonical references.
# Architecture
The PRISM View Server (PVS) uses various Docker images whereas `core`,
-`cache`, `client`, and `preprocessor` are build from this repository and
+`cache`, `client`, `ingestor`, `fluentd` and `preprocessor` are build from this repository and
the others are pulled from docker hub.
## Prerequisites
@@ -29,11 +29,17 @@ In base stack
* traefik-data
+In logging stack
+
+* logging_es-data
+
Per collection
* db-data used by database
* redis-data used by redis
* instance-data used by registrar and renderer
+* report-data sftp output of reporting interface
+* from-fepd - sftp input to **ingestor**
## Services
@@ -182,17 +188,19 @@ docker pull registry.gitlab.eox.at/esa/prism/vs/pvs_cache
docker pull registry.gitlab.eox.at/esa/prism/vs/pvs_preprocessor
docker pull registry.gitlab.eox.at/esa/prism/vs/pvs_client
docker pull registry.gitlab.eox.at/esa/prism/vs/fluentd
+docker pull registry.gitlab.eox.at/esa/prism/vs/ingestor
```
Create external network for stack to run:
```
docker network create -d overlay vhr18-extnet
docker network create -d overlay emg-extnet
+docker network create -d overlay dem-extnet
```
Add following .env files with credentials to the cloned copy of the repository /env folder: `vhr18_db.env`, `vhr18_obs.env`, `vhr18_django.env`.
create docker secrets:
-Sensitive environment variables are not included in the .env files, and must be generated as docker secrets. To create docker secrets run :
+Sensitive environment variables are not included in the .env files, and must be generated as docker secrets. All stacks currently share these secret names, therefore it must stay the same for all stacks. To create docker secrets run:
```bash
# replace the "<variable>" with the value of the secret
printf "<OS_PASSWORD_DOWNLOAD>" | docker secret create OS_PASSWORD_DOWNLOAD -
@@ -200,7 +208,7 @@ printf "<DJANGO_PASSWORD>" | docker secret create DJANGO_PASSWORD -
printf "<OS_PASSWORD>" | docker secret create OS_PASSWORD -
```
-Deploy the stack:
+Deploy the stack in dev environment:
```
docker stack deploy -c docker-compose.vhr18.yml -c docker-compose.vhr18.dev.yml -c docker-compose.logging.yml -c docker-compose.logging.dev.yml vhr18-pvs # start VHR_IMAGE_2018 stack in dev mode, for example to use local sources
docker stack deploy -c docker-compose.emg.yml -c docker-compose.emg.dev.yml emg-pvs -c docker-compose.logging.yml -c docker-compose.logging.dev.yml # start Emergency stack in dev mode, for example to use local sources
@@ -234,7 +242,7 @@ Select `@timestamp` as time field
### setup sftp
-The `SFTP` image allow remote access into 2 logging folders, you can define (edit/add) users, passwords and (UID/GID) in the respictive configuration file ( e.g *config/vhr_sftp_users.conf* ).
+The `SFTP` image allow remote access into 2 logging folders, you can define (edit/add) users, passwords and (UID/GID) in the respective configuration file ( e.g *config/vhr_sftp_users.conf* ).
The default username is `eox`, once the stack is deployed you can sftp into the logging folders through port 2222 on -if you are running the dev stack- localhost :
@@ -243,7 +251,7 @@ sftp -P 2222 eox@127.0.0.1
```
You will log in into`/home/eox/data` directory which contains the 2 logging directories : `to/panda` and `from/fepd`
- **NOTE:** The mounted directory that you are directed into is *`/home/user`*, where `user` is the username, hence when changing the username in the `.conf` file, the `sftp` mounted volumes path in `docker-compse.<collection>.yml` must change respectivly.
+ **NOTE:** The mounted directory that you are directed into is *`/home/user`*, where `user` is the username, hence when changing the username in the `.conf` file, the `sftp` mounted volumes path in `docker-compse.<collection>.yml` must change respectively.
Once a product is registered, a xml report that contains `WMS` and `WCS` getCapabilities links is generated and saved in the same volume which `to/panda` is mounted to, once you successfuly sftp into the "sftp image" you can navigate to the generated reports.
@@ -291,4 +299,6 @@ docker save -o pvs_core.tar registry.gitlab.eox.at/esa/prism/vs/pvs_core
docker save -o pvs_cache.tar registry.gitlab.eox.at/esa/prism/vs/pvs_cache
docker save -o pvs_preprocessor.tar registry.gitlab.eox.at/esa/prism/vs/pvs_preprocessor
docker save -o pvs_client.tar registry.gitlab.eox.at/esa/prism/vs/pvs_client
+docker save -o pvs_ingestor.tar registry.gitlab.eox.at/esa/prism/vs/pvs_ingestor
+docker save -o fluentd.tar registry.gitlab.eox.at/esa/prism/vs/fluentd
```
diff --git a/conftest.py b/conftest.py
deleted file mode 100644
index 7a1d3249..00000000
--- a/conftest.py
+++ /dev/null
@@ -1,10 +0,0 @@
-def pytest_addoption(parser):
- parser.addoption("--name", action="store", default="default name")
-
-
-def pytest_generate_tests(metafunc):
- # This is called for every test. Only get/set command line arguments
- # if the argument is specified in the list of test "fixturenames".
- option_value = metafunc.config.option.name
- if 'name' in metafunc.fixturenames and option_value is not None:
- metafunc.parametrize("name", [option_value])
\ No newline at end of file
--
GitLab