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

bk-config-db

Het bk-config-db kan geconfigureerd worden met een aantal environment variables

Het bk-config-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="bk-config-db" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/bk-config-db:0.19.0

Toelichting op de configuratie:

ParameterToelichting
PGHOSTMoet ingesteld staan op het intern adres waar de postgres database server van de bronorganisatie bereikbaar is.
PGPORTMoet ingesteld staan op de poort waar de postgres database server van de bronorganisatie bereikbaar is.
PGSSLMODEMoet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie. Mogelijke waarden: require,disable,verify-ca,verify-full
PGUSERMoet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
PGPASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
PGDATABASEMoet ingesteld staan op bk-config-db.

bk-config-service

Het bk-config-service kan geconfigureerd worden met een aantal environment variables

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

docker run -p 8082:80 \
-e API_KEY="SECRET_API_KEY" \
-e BK_CONFIG_DB_HOST="postgres-host" \
-e BK_CONFIG_DB_USERNAME="postgres-user" \
-e BK_CONFIG_DB_PASSWORD="SECRET_POSTGRES_PASSWORD" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/bk-config-service:0.18.17

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop bk-config-service luistert.
API_KEYMoet ingesteld staan op een geheime API key waarmee de andere componenten toegang kunnen krijgen tot deze service.
BK_CONFIG_DB_HOSTMoet ingesteld staan op het intern adres waar de postgres database server van de bronorganisatie bereikbaar is.
BK_CONFIG_DB_PORTMoet ingesteld staan op de poort waar de postgres database server van de bronorganisatie bereikbaar is.
BK_CONFIG_DB_USERNAMEMoet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
BK_CONFIG_DB_PASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
BK_CONFIG_DB_DATABASEMoet ingesteld staan op bk-config-db.
BK_CONFIG_DB_SSLMODEMoet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie. Mogelijke waarden: require,disable,verify-ca,verify-full
BK_CONFIG_DB_MAX_IDLE_CONNSMoet ingesteld staan op het maximaal aantal toegestane idle connecties op de postgres database server van de bronorganisatie.
BK_CONFIG_DB_MAX_OPEN_CONNSMoet ingesteld staan op het maximaal aantal toegestane open connecties op de postgres database server van de bronorganisatie.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

bk-management-process

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

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

docker run -p 8080:80 \
-e SCHEME_DISCOVERY_URL="https://demo-scheme-manager-scheme-process" \
-e SCHEME_ROOT_PUBLIC_KEY="SCHEME_ROOT_PUBLIC_KEY" \
-e BK_CONFIG_SERVICE_ADDRESS="http://bk-config-service" \
-e BK_CONFIG_SERVICE_API_KEY="SECRET_BK_CONFIG_SERVICE_API_KEY" \
-e ORGANIZATION_NAME="Demo Organization" \
-e ORGANIZATION_OIN="00000000000000000001" \
-e ORGANIZATION_DISCOVERY_URL="https://demo-organization-service-discovery-process" \
-e ORGANIZATION_ROLE="SOURCE_ORGANIZATION" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/bk-management-process:0.19.2

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop bk-management-process luistert.
SCHEME_DISCOVERY_URLMoet ingesteld staan op het extern adres waar het scheme-process component van de stelselbeheerder bereikbaar is. De url van de Vorderingenoverzicht Rijk Demo omgeving is https://api.stelsel.vorijk-demo.blauweknop.app.
SCHEME_ROOT_PUBLIC_KEYMoet ingesteld staan op de scheme root public key van de stelselbeheerder.
BK_CONFIG_SERVICE_ADDRESSMoet ingesteld staan op het interne adres waar het bk-config-service component van de bronorganisatie bereikbaar is.
BK_CONFIG_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee bk-management-process toegang kan krijgen tot het bk-config-service van de bronorganisatie.
ORGANIZATION_NAMEMoet ingesteld staan op de naam van de bronorganisatie.
ORGANIZATION_OINMoet ingesteld staan op het organisatie-identificatienummer (OIN) van de bronorganisatie.
ORGANIZATION_DISCOVERY_URLMoet ingesteld staan op het extern adres waar het service-discovery-process component van de bronorganisatie bereikbaar is.
ORGANIZATION_ROLEMoet ingesteld staan op SOURCE_ORGANIZATION.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

bk-management-ui

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

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

docker run -p 8081:80 \
-e BK_MANAGEMENT_ADDRESS="https://bk-management-process" \
-e HSM_ADDRESS="https://hsm-process" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/bk-management-ui:0.18.2

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop bk-management-ui luistert.
BK_MANAGEMENT_ADDRESSMoet ingesteld staan op het extern adres (intranet) waar het bk-management-process component van de bronorganisatie bereikbaar is.
HSM_ADDRESSMoet ingesteld staan op het extern adres (intranet) waar het hsm-process component van de bronorganisatie bereikbaar is.

service-discovery-process

Het service-discovery-process kan geconfigureerd worden met een json bestand.

Creëer een map config, met daarin een bestand genaamd bk-configuration.json:

{
"financialClaimRequestApi": {
"v4": "https://demo-organization-citizen-financial-claim-process"
},
"sessionApi": {
"v2": "https://demo-organization-session-process"
}
}

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

docker run -p 8088:80 \
-v "$PWD/config":/var/www/.well-known \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/service-discovery-process:0.17.25

session-service

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

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

docker run -p 8083:80 \
-e API_KEY="SECRET_API_KEY" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/session-service:0.17.29

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop session-service luistert.
API_KEYMoet ingesteld staan op een geheime API key waarmee de andere componenten toegang kunnen krijgen tot deze service.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

session-process

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

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

docker run -p 8084:80 \
-e SCHEME_DISCOVERY_URL="https://api.stelsel.vorijk-demo.blauweknop.app" \
-e SCHEME_ROOT_PUBLIC_KEY="SCHEME_ROOT_PUBLIC_KEY" \
-e SESSION_SERVICE_ADDRESS="http://demo-organization-session-service" \
-e SESSION_SERVICE_API_KEY="SECRET_SESSION_SERVICE_API_KEY" \
-e BK_CONFIG_SERVICE_ADDRESS="http://demo-organization-bk-config-service" \
-e BK_CONFIG_SERVICE_API_KEY="SECRET_BK_CONFIG_SERVICE_API_KEY" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/session-process:0.19.1

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop session-process luistert.
SCHEME_DISCOVERY_URLMoet ingesteld staan op het extern adres waar het scheme-process component van de stelselbeheerder bereikbaar is. De url van de Vorderingenoverzicht Rijk Demo omgeving is https://api.stelsel.vorijk-demo.blauweknop.app.
SCHEME_ROOT_PUBLIC_KEYMoet ingesteld staan op de scheme root public key van de stelselbeheerder.
SESSION_SERVICE_ADDRESSMoet ingesteld staan op het interne adres waar het session-service component van de bronorganisatie bereikbaar is.
SESSION_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee session-process toegang kan krijgen tot het session-service van de bronorganisatie.
BK_CONFIG_SERVICE_ADDRESSMoet ingesteld staan op het interne adres waar het bk-config-service component van de bronorganisatie bereikbaar is.
BK_CONFIG_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee session-process toegang kan krijgen tot het bk-config-service van de bronorganisatie.
HSM_ADDRESSMoet ingesteld staan op het extern adres (intranet) waar het hsm-process component van de bronorganisatie bereikbaar is.
SESSION_EXPIRATION_MINUTESMoet ingesteld staan op de lengte van een sessie in minuten.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

financial-claim-request-db

Het financial-claim-request-db kan geconfigureerd worden met een aantal environment variables

Het financial-claim-request-db component kan gestart worden met behulp van docker:

docker run \
-e PGHOST="postgres-host" \
-e PGUSER="postgres-user" \
-e PGPASSWORD="SECRET_POSTGRES_PASSWORD" \
-e PGDATABASE="financial-claim-request-db" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/financial-claim-request-db:0.17.19

Toelichting op de configuratie:

ParameterToelichting
PGHOSTMoet ingesteld staan op het intern adres waar de postgres database server van de bronorganisatie bereikbaar is.
PGUSERMoet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server.
PGPASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server.
PGDATABASEMoet ingesteld staan op financial-claim-request-db.

financial-claim-request-service

Het financial-claim-request-service kan geconfigureerd worden met een aantal environment variables

Het financial-claim-request-service component kan gestart worden met behulp van docker:

docker run -p 8085:80 \
-e API_KEY="SECRET_API_KEY" \
-e FINANCIAL_CLAIM_REQUEST_DB_HOST="postgres-host" \
-e FINANCIAL_CLAIM_REQUEST_DB_USERNAME="postgres-user" \
-e FINANCIAL_CLAIM_REQUEST_DB_PASSWORD="SECRET_POSTGRES_PASSWORD" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/financial-claim-request-service:0.17.24

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop financial-claim-request-service luistert.
API_KEYMoet ingesteld staan op een geheime API key waarmee de andere componenten toegang kunnen krijgen tot deze service.
FINANCIAL_CLAIM_REQUEST_DB_PASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
FINANCIAL_CLAIM_REQUEST_DB_HOSTMoet ingesteld staan op het intern adres waar de postgres database server van de bronorganisatie bereikbaar is.
FINANCIAL_CLAIM_REQUEST_DB_PORTMoet ingesteld staan op de poort waar de postgres database server van de bronorganisatie bereikbaar is.
FINANCIAL_CLAIM_REQUEST_DB_USERNAMEMoet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
FINANCIAL_CLAIM_REQUEST_DB_PASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
FINANCIAL_CLAIM_REQUEST_DB_DATABASEMoet ingesteld staan op financial-claim-request-db.
FINANCIAL_CLAIM_REQUEST_DB_SSLMODEMoet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie. Mogelijke waarden: require,disable,verify-ca,verify-full
FINANCIAL_CLAIM_REQUEST_DB_MAX_IDLE_CONNSMoet ingesteld staan op het maximaal aantal toegestane idle connecties op de postgres database server van de bronorganisatie.
FINANCIAL_CLAIM_REQUEST_DB_MAX_OPEN_CONNSMoet ingesteld staan op het maximaal aantal toegestane open connecties op de postgres database server van de bronorganisatie.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

mock-source-system (Voorbeeld van een bronsysteem API)

Het mock-source-system kan geconfigureerd worden met een aantal environment variables

Het mock-source-system component kan gestart worden met behulp van docker:

docker run -p 8087:80 \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/mock-source-system:0.19.26

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop mock-source-system luistert.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn

citizen-financial-claim-process

Het citizen-financial-claim-process kan geconfigureerd worden met een aantal environment variables

Het citizen-financial-claim-process component kan gestart worden met behulp van docker:

docker run -p 8086:80\
-e FINANCIAL_CLAIM_REQUEST_SERVICE_ADDRESS="http://demo-organization-financial-claim-request-service" \
-e FINANCIAL_CLAIM_REQUEST_SERVICE_API_KEY="SECRET_FINANCIAL_CLAIM_REQUEST_SERVICE_API_KEY" \
-e SESSION_SERVICE_ADDRESS="http://demo-organization-session-service" \
-e SESSION_SERVICE_API_KEY="SECRET_SESSION_SERVICE_API_KEY" \
-e BK_CONFIG_SERVICE_ADDRESS="http://demo-organization-bk-config-service" \
-e BK_CONFIG_SERVICE_API_KEY="SECRET_BK_CONFIG_SERVICE_API_KEY" \
-e HSM_ADDRESS="http://hsm-process:8080" \
-e SOURCE_SYSTEM_ADDRESS="https://demo-organization-discovery-url" \
registry.gitlab.com/blauwe-knop/vorderingenoverzicht/citizen-financial-claim-process:0.21.1

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop citizen-financial-claim-process luistert.
FINANCIAL_CLAIM_REQUEST_SERVICE_ADDRESSMoet ingesteld staan op het interne adres waar het financial-claim-request-service component van de bronorganisatie bereikbaar is.
FINANCIAL_CLAIM_REQUEST_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee citizen-financial-claim-process toegang kan krijgen tot het financial-claim-request-service van de bronorganisatie.
SESSION_SERVICE_ADDRESSMoet ingesteld staan op het interne adres waar het session-service component van de bronorganisatie bereikbaar is.
SESSION_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee citizen-financial-claim-process toegang kan krijgen tot het session-service van de bronorganisatie.
BK_CONFIG_SERVICE_ADDRESSMoet ingesteld staan op het interne adres waar het bk-config-service component van de bronorganisatie bereikbaar is.
BK_CONFIG_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee session-process toegang kan krijgen tot het bk-config-service van de bronorganisatie.
HSM_ADDRESSMoet ingesteld staan op het extern adres (intranet) waar het hsm-process component van de bronorganisatie bereikbaar is.
SOURCE_SYSTEM_ADDRESSMoet ingesteld staan op het interne adres waar het source-system component van de bronorganisatie bereikbaar zijn.
SOURCE_SYSTEM_CUSTOM_REQUEST_HEADERSMoet ingesteld staan op request headers welke meegegeven kunnen worden naar het achterliggende bronsysteem. Meerdere headers kunnen gescheiden door een komma meegegeven worden.
CONFIGURATION_EXPIRATION_MINUTESMoet ingesteld staan op de maximum duur van een configuratie in minuten.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet 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/vorderingenoverzicht/vhsm-db:0.1.4

Toelichting op de configuratie:

ParameterToelichting
PGHOSTMoet ingesteld staan op het intern adres waar de postgres database server van de bronorganisatie bereikbaar is.
PGPORTMoet ingesteld staan op de poort waar de postgres database server van de bronorganisatie bereikbaar is.
PGSSLMODEMoet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie. Mogelijke waarden: require,disable,verify-ca,verify-full
PGUSERMoet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
PGPASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
PGDATABASEMoet 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.0.5

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop vhsm-service luistert.
API_KEYMoet ingesteld staan op een geheime API key waarmee de andere componenten toegang kunnen krijgen tot deze service.
VHSM_DB_HOSTMoet ingesteld staan op het intern adres waar de postgres database server van de bronorganisatie bereikbaar is.
VHSM_DB_PORTMoet ingesteld staan op de poort waar de postgres database server van de bronorganisatie bereikbaar is.
VHSM_DB_USERNAMEMoet ingesteld staan op de gebruikersnaam waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
VHSM_DB_PASSWORDMoet ingesteld staan op het wachtwoord waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie.
VHSM_DB_DATABASEMoet ingesteld staan op vhsm-db.
VHSM_DB_SSLMODEMoet ingesteld staan op de SSL mode waarmee er ingelogd kan worden op de postgres database server van de bronorganisatie. Mogelijke waarden: require,disable,verify-ca,verify-full
VHSM_DB_MAX_IDLE_CONNSMoet ingesteld staan op het maximaal aantal toegestane idle connecties op de postgres database server van de bronorganisatie.
VHSM_DB_MAX_OPEN_CONNSMoet ingesteld staan op het maximaal aantal toegestane open connecties op de postgres database server van de bronorganisatie.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet 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.0.11

Toelichting op de configuratie:

ParameterToelichting
LISTEN_ADDRESSMoet ingesteld staan op het adres waarop hsm-process luistert.
VHSM_SERVICE_API_KEYMoet ingesteld staan op de API key waarmee hsm-process toegang kan krijgen tot het vhsm-service van de bronorganisatie.
VHSM_SERVICE_ADDRESSMoet ingesteld staan op het address waar hsm-process het vhsm-service van de bronorganisatie kan bereiken.
LOG_TYPEMoet ingesteld staan op type waarop dit component moet loggen. Mogelijke waarden: live,local
LOG_LEVELMoet ingesteld staan op level waarop dit component moet loggen. Mogelijke waarden: debug,info,warn