Introduktion

Formål

Vejledning til installation og konfiguration af FSK Registry Adapter. 
Afsnit 2 indeholder servicekrav til det omliggende miljø, herunder krav til operativsystem og standardapplikationer, som f.eks. applikationsservere, Java og/eller Net versioner mm., angivet på version og service pack-niveau. 
Afsnit 3 beskriver hvorledes servicen deployeres, herunder om der er krav om evt. genstart af server eller andre applikationer. Ved opgradering af komponenten beskrives desuden tilstanden, systemet skal være i for at opgraderingen kan finde sted, f.eks. om applikationsserver og/eller databaseserver skal være stoppet.

Læsevejledning

Læseren forventes at have kendskab til National Sundheds-IT’s platform NSP, samt generelt kendskab til WildFly applikation server og Ubuntu Linux operativ system.
Dokumentet beskriver ikke forhold der berører konfiguration på DoDi, NSP eller centrale ’NSP-lignende miljøer’ eller etablering og konfiguration af distribution af data fra DoDi til øvrige platforme.
Hvor der i teksten er angivet <packing> refereres til topniveaufolderen for release-pakken med kildekode. Folderens navngivning afhænger af versionen på releaset.

Definitioner og referencer

Krav til miljø

Krav til applikationsservere

Komponenterne er udviklet og testet

...

vha. Docker.

Dockerfiler basere sig på NSP base image fra nspop.dk registry:
registry.nspop.dk/platform/nsp:1

Som udstiller WildFly 8.2 applikationsserver og

Komponenternes konfiguration er tilpasset deployering på WildFly 8.2 applikationsservere.

Applikationsserveren kræver Java 8.

Krav til operativsystem

Der stilles ingen krav til operativsystemet, ud over krav om, at Java er understøttet på operativsystemet.

Ubuntu Linux bruges som operativsystem på NSP’en, og udviklingen af komponenten er foretaget på Ubuntu 16.04.

Krav til adgang til andre services

FSK Registry Adapter læser og skriver i FSK Repositorys database.

Krav til database

Komponenten er testet mod MySQL mod MariaDB Version 510.5.60 1 i Docker.

Krav til datahåndtering

FSK Registry Adapter behandler og opbevarer (via FSK Repositorys database) personhenførbare informationer. Det handler om metadata for CDA dokumenter af typen stamkort.

Krav til hardware

Aftaleoversigt FSK Registry Adapter ressourceforbrug vil afhænge af følgende:

• Antallet af dokumenter der hentes samtidig

Deployment

...

Dette afsnit beskriver deploymentprocessen på WildFly 8.2.af FSK registry.

I nuværende kode-base er følgende profiler forberedt:

Profilnavn	Profildefinitioner	Deployeringssti
conf	fskregistry-war/src/test/conf		compose/configuration	/pack/wildfly8/modules/sds/fskregistry/configuration

...

/main

Deployment af komponenter

OBS! Inden opstart af WildFly skal det sikres at properties og modul filer til servicen ligger i de applikationsspecifikke modul foldere på WildFly.

Udvikling

Før FSK Registry kan deployes i udvikling, så skal projektet være bygget.  Dette gøre vha. maven kommandoen:
mvn clean install

Dette resultere i filen

...

fskregistry-war/target/fskregistry.war

...

.

Derefter kan FSK Registry deployes vha. docker-compose:
docker-compose -f compose/development/docker-compose.yml up --build

Hvor build bygger docker image vha. opskriften fskregistry-war/Dockerfile

Test og Release

Før test og relase kan startes op, så skal FSK Registry pushes til Docker Resgitry på nspop.

Dette gøres ved at afvikle dette Jenkins job:
https://jenkins.nspop.dk/job/FSKregistry_push_snapshot/

Dette job sikre at FSK Registry kan bygges vha. jobbet:
https://jenkins.nspop.dk/job/FSKregistry_build/

Derefter kan FSK Registry deployes til test vha. docker-compose:
docker-compose -f compose/test/docker-compose.yml up
eller
docker-compose -f compose/release/docker-compose.yml up

Konfiguration af datasource

FSK Registry Adaptor anvender en MySQl MariaDB som database for mapning mellem cprnummer, formatcode, typecode og dokumentid.

Denne datasources slås op via JNDI. Datasourcen kan konfigureres i Wildfly ved at deploye filen i

...

DataSource konfigurationen deployes vha. Docker-compose.

...

Et eksempel kan findes i:

<packing>compose/fskregistry/fskregistry-war/src/test/installation/configuration/fsk-ds.xml

Konfiguration af komponenterne

Al konfiguration, undtagen foregår ved redigering af de relevante properties filer under WildFly modules. Ved konfigurationsændringer bør servicen/WildFly genstartes.skal docker-compose genstartes før ændringer slår igennem. Dette gøres ved at lukke applikationen ned vha. docker-compose f.eks.:
docker-compose -f compose/test/docker-compose.yml down

Indholdet af de enkelte konfigurationsfiler, er beskrevet og forklaret i FSK Registry Adapter - Driftsvejledning.

Filer beskrevet i det følgende kan tilpasses.

Deployment af modul

WildFly module for FSK Registry Adapter sættes op ved at kopiere opsættes vha. filen:

<packing>/fskregistry/fskregistry-war/src/test/conf → /pack/wildfly8/modules/sds/fskregistry/configuration/main/compose/configuration/module.xml

Konfiguration af FSK Registry Adapter

fskreg.properties

En skabelon for denne fil findes i:

<packing>compose/fskregistry-war/src/test/conf/fskreg.properties

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/sds/fskregistry/configuration/main/configuration/fskreg.properties

Yderligere information kan findes i FSK Registry Adapter - Driftsvejledning.

log4j-fskregistry-ws.xml og log4j.properties

Konfigurerer logopsætningen for FSK Registry Adapter..

For applikationsloggen, konfigureres størrelsen af log filerne og antallet af gemte log filer med de to environment variable: LOG_MAX_FILE_SIZE og LOG_MAX_BACKUP_INDEX.

Skabeloner En skabelon for log4j konfiguration findes i:

<packing>/fskregistry-war/src/test/confcompose/configuration/log4j-fskregistry-ws.xml

Filen redigeres inden den placeres på WildFly i:

/pack/wildfly8/modules/sds/fskregistry/configuration/main/
compose/configuration/log4j.properties

Konfiguration af NSP SLA log

NSP-util anvendes som en del af servicen og skal konfigureres. Eksempel på konfiguration-fil findes i:

<packing>compose/fskregistry-war/src/test/conf/
   configuration/log4j-nspslalog-fskreg.properties
   compose/configuration/nspslalog-fskreg.properties

Filerne redigeres inden de placeres på WildFly i:

/pack/wildfly8/modules/sds/fskregistry/configuration/main/

Yderligere information kan findes i FSK Registry Adapter - Driftsvejledning

Logfiler

FSK Registry Adapter kan logge kald til følgende logs: En NSP-SLA-log og en applikationslog.

...

Alle logs er beskrevet i driftsvejledningen.

Ved opstart af vha. docker-compose i development og test, så logges der desuden til følgende foldere:
compose/development/log
eller
compose/test/log

Opgradering af komponenter

Når der kommer opgraderinger til en komponent, vil der medfølge en release-note, der beskriver hvad opgraderingen består af, samt hvilke handlinger der er nødvendige for at opgradere den deployerede komponent.

Afinstallation af servicen

Fjern service-komponenter under WildFly’ deployments/ folder:

fskregistry.war

Fjern properties filer under Aftaleoversigt XDS Adaptere modul-foldere:

/pack/wildfly8/modules/sds/fskregistry/configuration/main/

Efter vi bruger docker-compose til deployment, så afvikles applikationen i en docker container.

Derfor er det nok at lukke bruge docker-compose til at lukke apllikationen ned, som beskrevet tidligere.

Fjern eventuelt logfiler fra compose/development/log og compose/test/logFjern eventuelt logfiler.