Dette dokument indeholder en beskrivelse af hvordan XDSCleanup installeres på et NSP Backend miljø.
Læseren forventes at have kendskab til Sundhedsdatastyrelsens platform NSP, samt generelt kendskab til WildFly applikation server, Docker, Docker Compose samt Ubuntu Linux operativ system.
28-02-20022 | KvalitetsIT | Initiel udgave |
NSP | Den nationale service platform |
Driften | NSP Leverandøren og NSP Driftleverandøren |
SDS | Sundhedsdatastyrelsen |
Driftvejledning | XDSCleanup - Driftsvejledning |
XDSCleanup anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
XDSCleanup bygges med NSP's Jenkins server via følgende jobs:
NSP Leverandøren er selv ansvarlig for at pushe release versioner af XDSCleanup til NSP Docker Registry gennem Jenkins.
XDSCleanup består af følgende to Docker images som pushes til NSP Docker Registry:
registry.nspop.dk/components/xdscleanup |
registry.nspop.dk/components/xdscleanup-deprecated |
XDSCleanup leveres samtidig som et sæt af Docker Compose filer i folderen /compose.
En leverance af XDSCleanup består af en compose folder som beskrevet ovenfor samt tilhørende tags af det byggede Docker image.
Compose folderen indeholder fem underfoldere:
configuration | Her ligger alle de konfigurationsfiler som det forventes af driften tilretter til det anvendte miljø. Se XDSCleanup - Driftsvejledning Heri findes også folderen database, som indeholder sql-filer til oprettelse af databaser (udelukkende til testformål). |
development | Her ligger en Docker Compose fil til brug for udvikling. Se Guide til Udviklere. |
test | Her ligger en Docker Compose fil der kan starte XDSCleanup i en standalone test konfiguration. |
release | Her ligger den Docker Compose fil som det forventes driften anvender på både test og produktionsmiljøerne. |
Komponenterne er udviklet og testet i Docker ved anvendelse af imaget "registry.nspop.dk/platform/nsp:3.0.2"
Komponenternes konfiguration er således tilpasset deployering på WildFly 21 applikationsservere med OpenJDK 8.
Der stilles ingen krav til operativsystemet udover, at det skal være Linux, og docker skal være installeret.
XDSCleanup anvender NXRG- og OpenXDS-databaserne.
XDSCleanup ressourceforbrug vil afhænge af følgende:
Antallet og kompleksiteten af af samtidige forespørgsler på dokumentmetadata.
I folderen compose/configuration findes følgende konfigurationsfiler:
log4j.properties | Log opsætning. |
log4j-nspslalog-xdscleanup.properties | Log4j SLA-log konfiguration. |
log4j-xdscleanup-ws.xml | Log opsætning af NXRG servicen. |
module.xml | JBoss modul-definition. |
nspslalog-xdscleanup.properties | SLA-log konfiguration. |
nxrg-ds.xml | NXRG datasource definition. |
openxds-ds.xml | Openxds datasource definition. |
sdm-ds.xml | SDM datasource definition |
xdscleanup.properties | Konfiguration af XDSCleanup servicen. |
xdscleanup-deprecated.properties | Konfiguration af XDSCleanup Deprecated servicen. |
Alle filer skal tilrettes til de forskellige miljøer som XDSCleanup installeres på. Filerne indeholder en konfiguration der passer til XDSCleanup i en standalone test konfiguration.
Konfigurationsfilerne til SLA logning følger standarden for SLA logning, og det bør derfor ikke være nødvendigt at ændre i disse.
Begge XDSCleanup containere startes og stoppes med Docker Compose kommandoer.
For en standalone test af XDSCleanup hentes "compose" folderen for den ønskede version og kommandoen "docker-compose up" køres i folderen "test".
På et NSP miljø hentes "compose" folderen for den ønskede version og kommandoen "docker-compose up" køres i folderen "release".