Ga naar hoofdinhoud

Docker commands en configuratie

Postgres database server

De postgres database server kan als volgt worden opgestart. De postgres docker image biedt ook mogelijkheden voor optionele configuratie.

docker run \
    -e POSTGRES_PASSWORD=SECRET_POSTGRES_PASSWORD \
    postgres

scheme-db

Het scheme-db kan geconfigureerd worden met een aantal environment variables

Het scheme-db component kan gestart worden met behulp van docker:

docker run \
    -e PGHOST="postgres-host" \
    -e PGPORT="5432" \
    -e PGSSLMODE="require" \
    -e PGUSER="postgres-user" \
    -e PGPASSWORD="SECRET_POSTGRES_PASSWORD" \
    -e PGDATABASE="scheme-db" \
    registry.gitlab.com/blauwe-knop/vorderingenoverzicht/scheme-db:0.22.13 #version:scheme-db

Toelichting op de configuratie:

Parameter	Toelichting
PGHOST	Moet ingesteld staan op het intern adres waar de postgres database server van de stelselbeheerder bereikbaar is.
PGPORT	Moet ingesteld staan op de poort waar de postgres database server van de stelselbeheerder bereikbaar is.
PGSSLMODE	Moet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder. Mogelijke waarden: require,disable,verify-ca,verify-full
PGUSER	Moet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder.
PGPASSWORD	Moet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder.
PGDATABASE	Moet ingesteld staan op `scheme-db`.

scheme-management-process

Het scheme-management-process kan geconfigureerd worden met een aantal environment variables

Het scheme-management-process component kan gestart worden met behulp van docker:

docker run -p 8080:80 \
    -e SCHEME_SERVICE_API_KEY="scheme-service" \
    -e SCHEME_SERVICE_ADDRESS="http://scheme-service:8008" \
    registry.gitlab.com/blauwe-knop/vorderingenoverzicht/scheme-management-process:0.21.0 #version:scheme-management-process

Toelichting op de configuratie:

Parameter	Toelichting
LISTEN_ADDRESS	Moet ingesteld staan op het adres waarop `scheme-management-process` luistert.
SCHEME_SERVICE_API_KEY	Moet ingesteld staan op de API key waarmee `scheme-management-process` toegang kan krijgen tot het `scheme-service` van de stelselbeheerder.
SCHEME_SERVICE_ADDRESS	Moet ingesteld staan op het address waar `scheme-management-process` het `scheme-service` van de stelselbeheerder kan bereiken.
LOG_TYPE	Moet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVEL	Moet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

scheme-management-ui

Het scheme-management-ui kan geconfigureerd worden met een aantal environment variables

Het scheme-management-ui component kan gestart worden met behulp van docker:

docker run -p 8081:80 \
    -e SCHEME_MANAGEMENT_ADDRESS="https://scheme-management-process" \
    -e HSM_ADDRESS="https://hsm-process" \
    registry.gitlab.com/blauwe-knop/vorderingenoverzicht/scheme-management-ui:0.24.2 #version:scheme-management-ui

Toelichting op de configuratie:

Parameter	Toelichting
LISTEN_ADDRESS	Moet ingesteld staan op het adres waarop `scheme-management-ui` luistert.
SCHEME_MANAGEMENT_ADDRESS	Moet ingesteld staan op het extern adres (intranet) waar het `scheme-management-process` component van de stelselbeheerder bereikbaar is.
HSM_ADDRESS	Moet ingesteld staan op het extern adres (intranet) waar het `hsm-process` component van de stelselbeheerder bereikbaar is.
LOG_TYPE	Moet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVEL	Moet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

scheme-process

Het scheme-process kan geconfigureerd worden met een aantal environment variables

Het scheme-process component kan gestart worden met behulp van docker:

docker run -p 8084:80 \
    -e SCHEME_SERVICE_API_KEY="scheme-service-api-key" \
    -e SCHEME_SERVICE_ADDRESS="http://scheme-service:8008" \
    registry.gitlab.com/blauwe-knop/vorderingenoverzicht/scheme-process:0.21.0 #version:scheme-process

Toelichting op de configuratie:

Parameter	Toelichting
LISTEN_ADDRESS	Moet ingesteld staan op het adres waarop `scheme-process` luistert.
SCHEME_SERVICE_API_KEY	Moet ingesteld staan op de API key waarmee `scheme-process` toegang kan krijgen tot het `scheme-service` van de stelselbeheerder.
SCHEME_SERVICE_ADDRESS	Moet ingesteld staan op het address waar `scheme-process` het `scheme-service` van de stelselbeheerder kan bereiken.
LOG_TYPE	Moet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVEL	Moet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

scheme-service

Het scheme-service kan geconfigureerd worden met een aantal environment variables

Het scheme-service component kan gestart worden met behulp van docker:

docker run -p 8083:80 \
    -e API_KEY="SECRET_API_KEY" \
    -e SCHEME_DB_HOST="postgres-host" \
    -e SCHEME_DB_USERNAME="postgres-user" \
    -e SCHEME_DB_PASSWORD="SECRET_POSTGRES_PASSWORD" \
    -e LOG_LEVEL="debug" \
    registry.gitlab.com/blauwe-knop/vorderingenoverzicht/scheme-service:0.22.0 #version:scheme-service

Toelichting op de configuratie:

Parameter	Toelichting
LISTEN_ADDRESS	Moet ingesteld staan op het adres waarop `scheme-service` luistert.
API_KEY	Moet ingesteld staan op een geheime API key waarmee de andere componenten toegang kunnen krijgen tot deze service.
SCHEME_DB_HOST	Moet ingesteld staan op het intern adres waar de postgres database server van de stelselbeheerder bereikbaar is.
SCHEME_DB_PORT	Moet ingesteld staan op de poort waar de postgres database server van de stelselbeheerder bereikbaar is.
SCHEME_DB_USERNAME	Moet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder.
SCHEME_DB_PASSWORD	Moet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder.
SCHEME_DB_DATABASE	Moet ingesteld staan op `scheme-db`.
SCHEME_DB_SSLMODE	Moet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder. Mogelijke waarden: require,disable,verify-ca,verify-full
SCHEME_DB_SSL_SERVER_CERT_PATH	Optioneel. Pad naar het CA-certificaat (sslrootcert) voor de modes `verify-ca` of `verify-full`.
SCHEME_DB_SSL_CLIENT_CERT_PATH	Optioneel. Pad naar het client-certificaat (sslcert) voor mutual TLS.
SCHEME_DB_SSL_CLIENT_PRIVATE_KEY_PATH	Optioneel. Pad naar de client private key (sslkey) voor mutual TLS.
SCHEME_DB_PKCS12_PATH	Optioneel. Pad naar een PKCS12-bestand (bijv. `/etc/ssl/client.p12`) als alternatief voor losse PEM-certificaten.
SCHEME_DB_PKCS12_PASSWORD	Optioneel. Wachtwoord voor het PKCS12-bestand.
SCHEME_DB_MAX_IDLE_CONNS	Moet ingesteld staan op het maximaal aantal toegestane idle connecties op de postgres database server van de stelselbeheerder.
SCHEME_DB_MAX_OPEN_CONNS	Moet ingesteld staan op het maximaal aantal toegestane open connecties op de postgres database server van de stelselbeheerder.
LOG_TYPE	Moet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVEL	Moet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

vhsm-db

Het vhsm-db kan geconfigureerd worden met een aantal environment variables

Het vhsm-db component kan gestart worden met behulp van docker:

docker run \
    -e PGHOST="postgres-host" \
    -e PGPORT="5432" \
    -e PGSSLMODE="require" \
    -e PGUSER="postgres-user" \
    -e PGPASSWORD="SECRET_POSTGRES_PASSWORD" \
    -e PGDATABASE="vhsm-db" \
    registry.gitlab.com/blauwe-knop/common/vhsm-db:0.2.9 #version:vhsm-db

Toelichting op de configuratie:

Parameter	Toelichting
PGHOST	Moet ingesteld staan op het intern adres waar de postgres database server van de stelselbeheerder bereikbaar is.
PGPORT	Moet ingesteld staan op de poort waar de postgres database server van de stelselbeheerder bereikbaar is.
PGSSLMODE	Moet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder. Mogelijke waarden: require,disable,verify-ca,verify-full
PGUSER	Moet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder.
PGPASSWORD	Moet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder.
PGDATABASE	Moet ingesteld staan op `vhsm-db`.

vhsm-service

Het vhsm-service kan geconfigureerd worden met een aantal environment variables

Het vhsm-service component kan gestart worden met behulp van docker:

docker run -p 8085:80 \
    -e API_KEY="SECRET_API_KEY" \
    -e SCHEME_DB_HOST="postgres-host" \
    -e SCHEME_DB_USERNAME="postgres-user" \
    -e SCHEME_DB_PASSWORD="SECRET_POSTGRES_PASSWORD" \
    -e LOG_LEVEL="debug" \
    registry.gitlab.com/blauwe-knop/common/vhsm-service:0.3.0 #version:vhsm-service

Toelichting op de configuratie:

Parameter	Toelichting
LISTEN_ADDRESS	Moet ingesteld staan op het adres waarop `vhsm-service` luistert.
API_KEY	Moet ingesteld staan op een geheime API key waarmee de andere componenten toegang kunnen krijgen tot deze service.
ORGANIZATION_PRIVATE_KEY	Optioneel. De private key (PEM) van de organisatie waarmee getekend en versleuteld wordt. Als deze is gezet, wordt er geen database gebruikt en zijn de `VHSM_DB_*` waarden niet nodig.
VHSM_DB_HOST	Moet ingesteld staan op het intern adres waar de postgres database server van de stelselbeheerder bereikbaar is.
VHSM_DB_PORT	Moet ingesteld staan op de poort waar de postgres database server van de stelselbeheerder bereikbaar is.
VHSM_DB_USERNAME	Moet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder. Optioneel bij certificaat-authenticatie.
VHSM_DB_PASSWORD	Moet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder. Optioneel bij certificaat-authenticatie.
VHSM_DB_DATABASE	Moet ingesteld staan op `vhsm-db`.
VHSM_DB_SSLMODE	Moet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de stelselbeheerder. Mogelijke waarden: require,disable,verify-ca,verify-full
VHSM_DB_SSL_SERVER_CERT_PATH	Optioneel. Pad naar het CA-certificaat (sslrootcert) voor de modes `verify-ca` of `verify-full`.
VHSM_DB_SSL_CLIENT_CERT_PATH	Optioneel. Pad naar het client-certificaat (sslcert) voor mutual TLS.
VHSM_DB_SSL_CLIENT_PRIVATE_KEY_PATH	Optioneel. Pad naar de client private key (sslkey) voor mutual TLS.
VHSM_DB_PKCS12_PATH	Optioneel. Pad naar een PKCS12-bestand (bijv. `/etc/ssl/client.p12`) als alternatief voor losse PEM-certificaten.
VHSM_DB_PKCS12_PASSWORD	Optioneel. Wachtwoord voor het PKCS12-bestand.
VHSM_DB_MAX_IDLE_CONNS	Moet ingesteld staan op het maximaal aantal toegestane idle connecties op de postgres database server van de stelselbeheerder.
VHSM_DB_MAX_OPEN_CONNS	Moet ingesteld staan op het maximaal aantal toegestane open connecties op de postgres database server van de stelselbeheerder.
LOG_TYPE	Moet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVEL	Moet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

hsm-process

Het hsm-process kan geconfigureerd worden met een aantal environment variables

Het hsm-process component kan gestart worden met behulp van docker:

docker run -p 8086:80 \
    -e VHSM_SERVICE_API_KEY="hsm-service-api-key" \
    -e VHSM_SERVICE_ADDRESS="http://vhsm-service:8008" \
    registry.gitlab.com/blauwe-knop/vorderingenoverzicht/hsm-process:0.2.0 #version:hsm-process

Toelichting op de configuratie:

Parameter	Toelichting
LISTEN_ADDRESS	Moet ingesteld staan op het adres waarop `hsm-process` luistert.
VHSM_SERVICE_API_KEY	Moet ingesteld staan op de API key waarmee `hsm-process` toegang kan krijgen tot het `vhsm-service` van de stelselbeheerder.
VHSM_SERVICE_ADDRESS	Moet ingesteld staan op het address waar `hsm-process` het `vhsm-service` van de stelselbeheerder kan bereiken.
LOG_TYPE	Moet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVEL	Moet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

Postgres database server
scheme-db
scheme-management-process
scheme-management-ui
scheme-process
scheme-service
vhsm-db
vhsm-service
hsm-process