Skip to content

Latest commit

 

History

History
123 lines (92 loc) · 4.37 KB

install.md

File metadata and controls

123 lines (92 loc) · 4.37 KB

Installation of LWGS Person Data Processor Service

This document will describe the setup of the environment of the lwgs person data processor service. It is recommended to adjust the configuration to your needs especially for the productive environment.

Prerequisites

You should make sure you've installed the following tools:

  • docker, docker-compose (and a running docker daemon)
  • git, github account with access to the lwgs-person-data-processor-service

Preparation

Login into githubs docker repository (replacing #USER# with your github handle). The password you need to provide here is a github personal access token with the permission read:packages (see also: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).

 # docker login ghcr.io -u #USER#

Checkout the project

 # git clone https://github.com/ch-bj/lgs-person-data-processor-service.git

Create a copy of .env from the example file

 # cp example.env .env

Update credentials, sedex settings, etc. (make sure you're not using these example values in a public accessible setting / in production).

RABBITMQ_USER=lwgs
RABBITMQ_PASSWORD=oor2ith5yae3ahc1eesequ0ho1die8Zo
REST_API_KEY=eidushufooxeeraeraePh1japeu6ahn9Atei0shu2o
SEDEX_SENDER_ID=123
SEDEX_RECIPIENT_ID=321
SEDEX_MESSAGE_TYPE_FULL_EXPORT=2518
SEDEX_MESSAGE_TYPE_INCREMENTAL=2519

If the default values of the sync parameters do not suit you you can adjust them according to the README.

PARTIAL_SYNC_PAGE_SIZE=10000
PARTIAL_SYNC_SCHEDULING_TYPE=FIXED_DELAY
PARTIAL_SYNC_CRON_SCHEDULE=0 0 * * * ?
PARTIAL_SYNC_FIXED_DELAY=300000
FULL_SYNC_PAGE_SIZE=10000

Alterantive Database Configurations

In order to use a different database backend as the default (postgres), you can configure this via the .env file in the repository. The following settings allow to define db access and driver.

Example settings for Oracle:

DB_USERNAME=##DBUSER##
DB_PASSWORD==##DBPASS##
DB_JDBC_URL=jdbc:oracle:thin:@##HOSTNAME##:##PORT##/##DBNAME##
DB_HIBERNATE_DIALECT=org.hibernate.dialect.OracleDialect
DB_DRIVER_CLASS_NAME=oracle.jdbc.driver.OracleDriver

For further information regarding the oracle driver configuration see: https://docs.oracle.com/en/database/oracle/oracle-database/21/jjdbc/data-sources-and-URLs.html#GUID-088B1600-C6C2-4F19-A020-2DAF8FE1F1C3.

Run Service

Simply run docker-compose --profile postgres up -d within the root of the project, when using the bundled postgres. If you've configured a different database (e.g. external oracledb), you can skip the --profile postgres.

 # docker-compose up -d
 [+] Running 12/12
 ⠿ Network lwgs-person-data-processor-service_default         Created    0.1s
 ⠿ Network lwgs-person-data-processor-service_internal        Created    0.1s
 ⠿ Volume "lwgs-person-data-processor-service_rabbit-logs"    Created    0.0s
 ⠿ Volume "lwgs-person-data-processor-service_grafana-data"   Created    0.0s
 ⠿ Volume "lwgs-person-data-processor-service_log-data"       Created    0.0s
 ⠿ Volume "lwgs-person-data-processor-service_hsqldb-data"    Created    0.0s
 ⠿ Volume "lwgs-person-data-processor-service_sedex"          Created    0.0s
 ⠿ Volume "lwgs-person-data-processor-service_rabbit-data"    Created    0.0s
 ⠿ Container lwgs-person-data-processor-service-rabbitmq-1    Started    2.1s
 ⠿ Container lwgs-person-data-processor-service-backend-1     Started    2.0s
 ⠿ Container lwgs-person-data-processor-service-prometheus-1  Started    2.3s
 ⠿ Container lwgs-person-data-processor-service-grafana-1     Started    3.0s

The generated sedex files will be placed within the lwgs-person-data-processor-service_sedex volume.

You might want to change this to a bindmount within the docker-compose.yml file while testing:

-      - sedex:/var/sedex
+      - /tmp/sedex:/var/sedex

Provided Services

After docker is started you'll find the following services running: