Introduktion

Formål

Dette dokument indeholder en beskrivelse af hvordan XDSCleanup installeres på et NSP Backend miljø.

Læsevejledning

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.

Dokument Historik

28-02-20022KvalitetsITInitiel udgave

Definitioner og referencer

NSPDen nationale service platform
DriftenNSP Leverandøren og NSP Driftleverandøren
SDSSundhedsdatastyrelsen
DriftvejledningXDSCleanup - Driftsvejledning

Installation

XDSCleanup anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.

Jenkins

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.

Docker

XDSCleanup består af følgende Docker image som pushes til NSP Docker Registry:

Docker Compose

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).

developmentHer ligger en Docker Compose fil til brug for udvikling. Se Guide til Udviklere.
testHer ligger en Docker Compose fil der kan starte XDSCleanup i en standalone test konfiguration.
releaseHer ligger den Docker Compose fil som det forventes driften anvender på både test og produktionsmiljøerne.

Krav til miljø

Krav til applikationsservere

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.

Krav til operativsystem

Der stilles ingen krav til operativsystemet udover, at det skal være Linux, og docker skal være installeret.

Krav til adgang til andre services

XDSCleanup anvender NXRG- og OpenXDS-databaserne.

Krav til hardware

XDSCleanup ressourceforbrug vil afhænge af følgende:

  • Antallet og kompleksiteten af af samtidige forespørgsler på dokumentmetadata.

  • Antallet af samtidige opdateringer samt registreringer af dokumentmetadata.

Konfiguration

I folderen compose/configuration findes følgende konfigurationsfiler:

log4j.propertiesLog opsætning.
log4j-nspslalog-xdscleanup.propertiesLog4j SLA-log konfiguration.
log4j-xdscleanup-ws.xmlLog opsætning af NXRG servicen.
module.xmlJBoss modul-definition.
nspslalog-xdscleanup.propertiesSLA-log konfiguration.
nxrg-ds.xmlNXRG datasource definition.
openxds-ds.xmlOpenxds datasource definition.
sdm-ds.xmlSDM datasource definition
xdscleanup.propertiesKonfiguration af XDSCleanup 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.

SLA logning

Konfigurationsfilerne til SLA logning følger standarden for SLA logning, og det bør derfor ikke være nødvendigt at ændre i disse.

Afvikling

XDSCleanup startes og stoppes med Docker Compose kommandoer.

Standalone test

For en standalone test af XDSCleanup hentes "compose" folderen for den ønskede version og kommandoen "docker-compose up" køres i folderen "test".

NSP Miljø

På et NSP miljø hentes "compose" folderen for den ønskede version og kommandoen "docker-compose up" køres i folderen "release".



  • No labels