Page History
Navitabs | ||||
---|---|---|---|---|
| ||||
Table of Contents |
---|
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
Definition | Beskrivelse |
---|---|
DDS | Dokumentdelingsservice |
NSI | National Sundheds-IT |
NSP | Den nationale service platform (inden for sundheds-IT) |
XDS | Cross-Enterprise Document Sharing |
Driftsvejledning |
FSK Registry Adapter - Driftsvejledning | |
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.
Code Block |
---|
<packing>/xdswrappers/documentmetadataprovider-war/target/ao-documentmetadataprovider-<profil-navn>.war |
Servicekomponenter der skal deployes til WildFly, skal kopieres til mappen ”deployments”. Hvis WildFly kører normalt starter den selv komponenten op. Er dette ikke tilfældet skal WildFly genstartes.
Oprettelse af databasen
Aftaleoversigtens XDS Registry og XDS Repository har brug for en MySql database til persistering og hentning af dokumenter.
Der skal opsættes en MySQL database med en tilhørende bruger. Navnet på databasen kan f.eks. reflektere profilen f.eks. aoxdscache-rm henholdsvist aoxdscache-rn. De forskellige installationer kan også anvende samme db instans, da der udover selve dokumentet persisteres repository id og homecommunityid.
Når databasen er oprettet skal følgende scripts køres mod MySQL (i den nævnte rækkefølge):
Code Block |
---|
<packing>/xdswrappers/provider-cache/etc/sql/01_aoxdscache_create_tables.sql |
Konfiguration af datasource
Både Aftaleoverisgt XDS Registry og Repository anvender en MySQl som database for de dokumenter, der hentes fra det bagvedliggende bookplan system.
Begge moduler slår datasources op via JNDI. Datasourcen kan konfigureres i Wildfly ved at deploye filen i
...
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 MariaDB som database for mapning mellem cprnummer, formatcode, typecode og dokumentid.
Denne datasources slås op via JNDI.
DataSource konfigurationen deployes vha. Docker-compose.
...
Et eksempel kan findes i:
Code Block |
---|
<packing>compose/xdswrappersconfiguration/provider-cache/etc/example/aoxdscache-fsk-ds.xml |
Konfiguration af komponenterne
Al konfiguration, undtagen udpegning af log4j-konfigurationsfilen (se afsnit 3.2.2.4 og 3.2.3.5), 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 moduler for Aftaleoversigt XDS adapterne sættes op ved at kopiere filernemodule for FSK Registry Adapter opsættes vha. filen:
Code Block |
---|
<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/module.xml → /pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/
<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/module.xml → /pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/ |
Konfiguration af Aftaleoversigt XDS Registry Adapter
AODocumentProvider.properties
Konfigurerer opsætningen af bookplan RESTful klienten for Aftaleoversigt XDS Repository Adapter.
compose/configuration/module.xml |
Konfiguration af FSK Registry Adapter
fskreg.properties
En skabelon for denne fil findes i:
Code Block |
---|
<packing>compose/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/AODocumentProvider.properties |
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/ |
Yderligere information kan findes i driftsvejledningen.
cda_document_template.xml
Skabelon til brug under transformering af Bookplan aftaler til CDA dokumenter.
En skabelon for denne fil findes i:
Code Block |
---|
<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/cda_document_template.xml |
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/ |
aometadataconfiguration.xml
Konfigurerer opsætning af dokument-metadata anvendt af Aftaleoversigt XDS Registry Adapter.
En skabelon for denne fil findes i:
Code Block |
---|
<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>/aometadataconfiguration.xml |
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/ |
Yderligere information kan findes i driftsvejledningen.
aofilterconfiguration.xml
Konfigurerer opsætning af, hvordan Aftaleoversigt XDS Registry Adapter skal reagere på søge-parametre givet ved dokumentmetadata-forespørgsler.
En skabelon for denne fil findes i:
Code Block |
---|
<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/aofilterconfiguration.xml |
Bemærk at ovenstående fil ikke er placeret under en profil.
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/ |
Yderligere information kan findes i driftsvejledningen.
log4j-ao-documentmetadataprovider-ws.xml
Konfigurerer logopsætningen for Aftaleoversigt XDS Registry Adapter.
En skabelon for log4j konfiguration findes i:
Code Block |
---|
<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/log4j-ao-documentmetadataprovider-ws.xml |
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/ |
I det følgende vises hvordan Standalone.xml opdateres med logging profile konfigurationen specifikt til Aftaleoversigt XDS Registry Adapter, men opsætningen er også mulig igennem WildFly Administration Console.
Konfigurationen er udelukkende til stede for at Aftaleoversigt XDS Registry Adapters egen log4j logning virker, men er ikke sat op til at blive brugt som ses ved konfigurationen af level til OFF.
Code Block |
---|
<logging-profile name="ao-metadataprovider-<profil-navn>-logging-profile">
<size-rotating-file-handler name="PerformanceFile" autoflush="true">
<level name="OFF"/>
</size-rotating-file-handler>
<logger category="performancelogger" use-parent-handlers="false">
<level name="OFF"/>
<handlers>
<handler name="PerformanceFile"/>
</handlers>
</logger>
</logging-profile> |
Udpegning af log4j-konfigurationsfilen
Filen beskrevet i afsnit 3.2.2.3 udpeges som konfigurationsfil for log4j i filen:
Code Block |
---|
documentsharing.log4j.properties |
under roden i war-filen ao-documentmetadataprovider-<profil-navn>.war, der er placeret som beskrevet i afsnit 3.1. Bemærk, at denne fil (om nødvendigt) skal tilpasses direkte i war-filen og ikke findes under Aftaleoversigt XDS Registry Adapter’s modul på WildFly.
Konfiguration af NSP SLA log
NSP-util anvendes som en del af servicen og skal konfigureres. Eksempel på konfiguration-fil findes i:
Code Block |
---|
<packing>/xdswrappers/documentmetadataprovider-war/src/test/resources/<profil-navn>
log4j-nspslalog-ao-documentmetadataprovider-ws.properties
nspslalog-ao-documentmetadataprovider.properties |
Filerne redigeres inden de placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/ |
Yderligere information kan findes i driftsvejledningen.
Konfiguration af Aftaleoversigt XDS Repository Adapter
aoproviderconfiguration.xml
Konfigurerer metadata opsætning af Aftaleoversigt XDS Repository Adapter.
En skabelon for denne fil findes i:
Code Block |
---|
<packing>/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/aoproviderconfiguration.xml |
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/ |
Yderligere information kan findes i driftsvejledningen.
log4j-ao-documentprovider-ws.xml
Konfigurerer logopsætningen for Aftaleoversigt XDS Repository Adapter.
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:
Code Block |
---|
<packing>compose/xdswrappers/documentprovider-war/src/test/resources/<profil-navn>/configuration/log4j-aofskregistry-documentprovider-ws.xml |
Filen redigeres inden den placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/ |
...
.xml |
...
compose/configuration/log4j.properties |
Konfiguration af NSP SLA
Code Block |
---|
<logging-profile name="ao-provider-<profil-navn>-logging-profile">
<size-rotating-file-handler name="PerformanceFile" autoflush="true">
<level name="OFF"/>
</size-rotating-file-handler>
<logger category="performancelogger" use-parent-handlers="false">
<level name="OFF"/>
<handlers>
<handler name="PerformanceFile"/>
</handlers>
</logger>
</logging-profile> |
Udpegning af log-4j-konfigurationsfilen
Filen beskrevet i afsnit 3.2.3.3 udpeges som konfigurationsfil for log4j i filen:
Code Block |
---|
documentsharing.log4j.properties |
under roden i war-filen ao-documentprovider-<profil-navn>.war, der er placeret som beskrevet i afsnit 3.1. Bemærk, at denne fil (om nødvendigt) skal tilpasses direkte i war-filen og ikke findes under Aftaleoversigt XDS Repository Adapter’s modul på WildFly.
...
log
NSP-util anvendes som en del af servicen og skal konfigureres. Eksempel på konfiguration-fil findes i:
Code Block |
---|
<packing>compose/xdswrappers/documentprovider-war/src/test/resources/<profil-navn> configuration/log4j-nspslalog-ao-documentprovider-wsfskreg.properties compose/configuration/nspslalog-ao-documentprovider.properties |
Filerne redigeres inden de placeres på WildFly i:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/fskreg.properties |
Yderligere information kan findes i
...
FSK Registry Adapter - Driftsvejledning
Logfiler
FSK Registry Adapter
Start/genstart af service
Komponenterne kan genstartes ved ”touch” af de respektive war-filer på WildFly. Alternativt skal WildFly genstartes ved at køre kommandoen:
Code Block |
---|
/etc/init.d/wildfly8 restart |
Logfiler
Aftaleoversigt XDS Adapter-komponenterne kan logge kald til følgende logs: En NSP-SLA-log , og en applikationslog og eventuelt en performancelog.
I default opsætningen logges udelukkende fejl til applikationsloggen.
Det er muligt at konfigurere placeringen af filerne, samt hvilket niveau de logger på, ved at redigere i filerne beskrevet i afsnit 3.2.2.3, 3.2.2.4, 3.2.3.3 og 3.2.3.5.ovenfor.
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:
Code Block |
---|
ao-documentmetadataprovider<profil-navn>.war
ao-documentprovider<profil-navn>.war |
Fjern properties filer under Aftaleoversigt XDS Adaptere modul-foldere:
Code Block |
---|
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentmetadataprovider/config/<profil-navn>/
/pack/wildfly8/modules/nsi/ddsprojects/ao/documentprovider/config/<profil-navn>/ |
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 – se afsnit 3.4.