Overblik

Dette dokument beskriver installation og konfiguration af Behandlingstestamenteregister-servicen (BTR).

Behandlingstestamenteregister-servicen består af følgende komponent (war-arkiv), der skal konfigureres og deployes på en applikationsserver:

• ltr-btr-service-wildfly: Livs- og behandlingstestamenteregister-servicen. War-arkiv. Servlet-baseret webservice pakket specifikt til Wildfly.

Projektet bygges med Maven og kræver Java 8 samt en MariaDB-installation for at kunne afvikle unit-tests.

Udover normalt tilgængelige Maven dependencies, afhænger projektet også af interne artefakter. Hvis disse artefakter ikke er udgivet (released) i den påkrævede version i NSP's Nexus repository, skal man selv udtjekke og bygge dem fra NSP's Subversion i den pågældende version. Artefakternes forskellige versioner vil være tilgængelige under et Subversion-tag. Disse artefakter er:

• cpr-subscriber (Maven identifier: dk.sds:cprsubscriber)

For at bygge disse interne artefakter, henvises der til artefakternes dokumentation.

Ændringslog

Byggevejledning

For at bygge projektet og dets deployables (war-filer) uden at køre unit-tests og integrationstests, anvendes følgende Maven kommando:

mvn clean install -DskipTests

Projektets deployables ender i target-mappen under de respektive moduler.

Afvikling af unit-tests

For at afvikle projektets unit-tests, skal en MariaDB-database-server være tilgængelig.

I udviklingssammenhæng kan man oprette de nødvendige database-schemas vha. scriptet compose/database/db/create_db.sql. I application.properties-filen i projektet er datasources som default sat til at anvende root-user med tomt password. Database-strukturen bliver automatisk oprettet vha. Flyway SQL-scripter, når unit-testene afvikles.

Unit-testene i projektet kan afvikles med følgende Maven-kommando:

mvn clean test

Alternativt kan også samtidigt bygge projektet ved at anvende Maven-kommandoen:

mvn clean install

Afvikling af integrationstests

Se testvejledningen.

Krav til miljø

Komponenten er tilpasset at kunne indgå i det aktuelt gældende CI-miljø på NSP. Det tager aktuelt udgangspunkt i version 1 af NSP's platform Docker image.

Krav til database

Servicen er testet mod MariaDB version 10.1, som bliver brugt på NSP platformen.

Krav til hardware

Der stilles ikke nogle særlige minimumskrav til hardware, men man skal forvente at bruge high-end hardware (både cpu, ram, netkort og diske) for at kunne opfylde de gældende svartidskrav på NSP.

Oprettelse af databaser og tabeller

Herunder beskrives servicens tilgang til database samt oprettelse af tabeller og views.

Tilgang til database

Servicen består af en database, der både indeholder data for Livstestamenteregistret og for Behandlingstestamenteregistret. Derudover afhænger den af adgang til et view i en (replikeret) stamdata-database.

Servicen konfigureres med 1 datasource, som tilgår databasen vha. separat specificerede brugere.

En bruger skal give adgang til databasen, og den skal være tildelt følgende rettigheder på databasen:

• Ved normal drift i produktion: SELECT, INSERT, UPDATE, DELETE
• Yderligere nødvendige rettigheder ved databaseoprettelse og migreringer: CREATE, DROP, ALTER

Databasebrugeren, der tilgår stamdata-view'et, skal være tildelt følgende rettigheder:

• Ved normal drift i produktion: SELECT
• Yderligere nødvendige rettigheder ved databaseoprettelse og migreringer: CREATE VIEW, DROP

Oprettelse af database og tabeller

Datamodellen styres vha. inkrementelle SQL-scripter, der kan findes under compose/database/db/migration. De er inddelt i 2 undermapper:

• btr: indeholder scripts til at køre på servicens Livstestamenteregister-database og Behandlingstestamenteregister-database
• stm: indeholder scripts til at køre på en (replikeret) stamdata-database.

I produktion anvendes scripterne manuelt og skal køres på databasen i inkrementel rækkefølge baseret på versionsnummeret i filnavnet (først V1__(...).sql, dernæst V2__(...).sql, osv.). Hvert script må aldrig køres mere end én gang; der gælder dog en undtagelse for ikke-versionerede scripter, hvis filnavne begynder med R, som står for Repeatable. Disse Repeatable scripter skal køres hver gang deres indhold (checksum) er blevet ændret, men de må først køres efter alle versionerede scripter er blevet kørt.

Ved initial installation af servicen vil det således være følgende scripter, der skal køres i den nedenstående rækkefølge:

Servicens Behandlingstestamenteregister og Livstestamenteregister-database

• btr/V1__create_LivingWill.sql
• btr/V2__create_PropertiesLivingWill.sql
• btr/V3__create_TreatmentWill.sql 
• btr/V4__create_PropertiesTreatmentWill.sql
• btr/V5__alter_add_NoForcedTreatmentIfIncapable.sql
• btr/V6__migrate_RelativeAcceptanceRequired_to_AcceptanceNeeded.sql
• btr/V7__add_AcceptanceNeeded_for_all.sql
• btr/V8__add_PersonIdentifier_index.sql
• btr/V9__add_PersonIdentifier_index.sql

(Replikeret) Stamdata-database

• stm/R__create_v2_Person_Simplified_view.sql

Deployment

Komponenten deployes vha. NSP's platform Docker image og konfigurationsfiler mountes i containeren som angivet i projektets Compose-filer.

ltr-btr-service-wildfly indholder de nødvendige konfigurationsfiler til valg af datasource, brugerdefinerede parametre, logning, mm. Wildfly-modulet er integreret i komponentens Docker image.

Konfiguration af servicen

Herunder beskrives properties i ltr-btr-service-wildfly komponentens konfigurationsfiler.

application.properties

log4j.xml

Konfigurerer logning for servicen.

Der benyttes en rolling file appender, hvor størrelsen af log filerne og antallet af gemte log filer konfigureres med de to environment variable: LOG_MAX_FILE_SIZE og LOG_MAX_BACKUP_INDEX.

Standardværdierne angiver nogle brugbare niveauer for anvendelse i produktion. Se Driftsvejledningen for uddybet beskrivelse af logning.

Se den officielle Log4j dokumentation for alternativ konfiguration.

minlogclient.properties

BTR anvender MinLogProvider til at registrere logninger i MinLog2, og i den forbindelse skal Kafka properties for Min Log 2 konfigureres. 

log4j-nspslalog.properties

Standardværdierne konfigurerer en Log4j-backend der logger med ISO 8601 timestamps.

Se  NSP-util - Designdokument.doc  eller den officielle Log4j 1 dokumentation for alternativ konfiguration.

accesshandler

security.properties

Konfigurerer security-api'et. Standardværdierne opsætter en keystore til signering af responses. Der henvises til accesshandlerens dokumentation for yderligere detaljer om konfiguration af security-api'et.

security.skip

Der henvises til accesshandlerens dokumentation for yderligere detaljer om konfiguration af security-api'et.

Konfiguration af datasources

ltr-btr-service-wildfly-komponenten kræver adgang til en JNDI-datakilde. Det skal opsættes i Wildfly og henvises til i tjenestens application.properties.

Overblik over komponenter

Se driftsvejledningen for yderligere information.

Opgradering af komponenter

Når der kommer opgraderinger til en komponent, vil der medfølge release notes, der beskriver opgradering, fallback, osv. for den enkelte komponent.