Introduktion
Formål
Dette dokument indeholder en beskrivelse af hvordan servicen Stamdatamodul (herefter SDM) 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
| Dato | Ansvarlig | Beskrivelse |
|---|---|---|
| 13-09-2021 | Thomas Kilden Nielsen | Draft udgave af installationsvejledningen |
Definitioner og referencer
| Reference | Beskrivelse |
|---|---|
| SDM | StamData Modul |
| SKRS | Stamdata Kopi Register Service |
| SRFS | Stamdata Register Fleropslags Service |
| SAES | Stamdata Autorisationsregister Enkelopslags Service |
| SCES | Stamdata Cprregister Enkeltopslags Service |
| SYES | Stamdata Yderregister Enkeltopslags Service |
| Driften | NSP Leverandøren og NSP Driftleverandøren |
| SDS | Sundhedsdatastyrelsen |
| Driftvejledning | SDM - Driftvejledning |
Installation
SDM anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
Jenkins
SDM bygges med NSP's Jenkins server via følgende jobs:
- SDM_build - Bygger koden
- SDM_push_snapshot - Pusher det nyeste snapshot image til NSP Docker Registry.
NSP Leverandøren er selv ansvarlige for at pushe release versioner af SDM til NSP Docker Registry gennem Jenkins.
Docker
SDM består af 6 Docker images som pushes til NSP Docker Registry med følgende navne:
| Docker image name |
|---|
| registry.nspop.dk/components/sdm/authorization-lookup-ws |
| registry.nspop.dk/components/sdm/batch-copy-ws-rfs |
| registry.nspop.dk/components/sdm/batch-copy-ws-krs |
| registry.nspop.dk/components/sdm/yder-lookup-ws |
| registry.nspop.dk/components/sdm/cpr-ws |
| registry.nspop.dk/components/sdm/personinformation |
Docker Compose
SDM leveres samtidig som et sæt af Docker Compose filer i folderen https://svn.nspop.dk/svn/components/sdm/trunk/compose.
For release x.y.z af SDM findes Docker Compose filerne i folderen https://svn.nspop.dk/svn/components/sdm/tags/sdm-x.y.z/compose
En leverance af SDM består af en compose folder som beskrevet ovenfor samt tilhørende tags af de 6 Docker images.
Compose folderen indeholder 5 underfoldere:
| Folder | Indhold |
|---|---|
| configuration | Her ligger alle de konfigurationsfiler som det forventes af driften tilretter til det anvendte miljø. Se Driftvejledningen |
| database | Her ligger alle de databasefiler som det forventes at driften lægger på en NSP database |
| 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 SDM i en standalone test konfiguration. |
| release | Her 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:2.1.12"
Komponenternes konfiguration er således tilpasset deployering på WildFly 8.2 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 database
Komponenten er testet mod MariaDB version 10.6.
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.
Konfiguration
I folderen https://svn.nspop.dk/svn/components/sdm/trunk/compose/configuration findes følgende konfigurationsfiler opdelt pr. service i SDM:
SKRS
| Fil | Indhold |
|---|---|
| stamdata-batch-copy-ws-krs.properties | Opsætning af SKRS service |
| stamdata-batch-copy-krs-ds.xml | Opsætning af datasource for SKRS |
| log4j-stamdata-batch-copy-ws-krs.properties | Logopsætning af SKRS |
| log4j-nspslalog-stamdata-batch-copy-krs.properties | Opsætning af NSP SLA log |
| nspslalog-stamdata-batch-copy-krs.properties | Opsætning af NSP SLA log |
SRFS
| Fil | Indhold |
|---|---|
| stamdata-batch-copy-ws-rfs.properties | Opsætning af SRFS service |
| stamdata-batch-copy-rfs-ds.xml | Opsætning af datasource for SRFS |
| log4j-stamdata-batch-copy-ws-rfs.properties | Logopsætning af SRFS |
| log4j-nspslalog-stamdata-batch-copy-rfs.properties | Opsætning af NSP SLA log |
| nspslalog-stamdata-batch-copy-rfs.properties | Opsætning af NSP SLA log |
SAES
| Fil | Indhold |
|---|---|
| stamdata-authorization-lookup-ws.properties | Opsætning af SAES service |
| stamdata-authorization-lookup-ds.xml | Opsætning af datasource for SAES |
| log4j-stamdata-authorization-lookup-ws.properties | Logopsætning af SAES |
| log4j-nspslalog-stamdata-authorization-lookup.properties | Opsætning af NSP SLA log |
| nspslalog-stamdata-authorization-lookup.properties | Opsætning af NSP SLA log |
SCES
| Fil | Indhold |
|---|---|
| stamdata-cpr-ws.properties | Opsætning af SCES service |
| stamdata-cpr-ds.xml | Opsætning af datasource for SCES |
| log4j-stamdata-cpr-ws.properties | Logpæstning af SCES |
| log4j-nspslalog-stamdata-cpr.properties | Opsætning af NSP SLA log |
| nspslalog-stamdata-cpr.properties | Opsætning af NSP SLA log |
country-mapper-internal.properties (country-mapper-external.properties) | Mapning mellem landekode og landenavn |
SYES
| Fil | Indhold |
|---|---|
| stamdata-yder-lookup-ws.properties | Opsætning af SYES service |
| stamdata-yder-lookup-ds.xml | Opsætning af datasource for SYES |
| log4j-stamdata-yder-lookup-ws.properties | Logopsætning af SYES |
| log4j-nspslalog-stamdata-yder-lookup.properties | Opsætning af NSP SLA log |
| nspslalog-stamdata-yder-lookup.properties | Opsætning af NSP SLA log |
PersonInformation
| Fil | Indhold |
|---|---|
| stamdata-personinformation.properties | Opsætning af PersonInformation service |
| stamdata-personinformation-ds.xml | Opsætning af datasource for PersonInformation |
| log4j-stamdata-personinformation.properties | Logopsætning af PersonInformation |
| log4j-nspslalog-stamdata-personinformation.properties | Opsætning af NSP SLA log |
| nspslalog-stamdata-personinformation.properties | Opsætning af NSP SLA log |
Alle filer skal tilrettes til de forskellige miljøer som SDM installeres på. Filerne indeholder en konfiguration der passer til SDM i en standalone test konfiguration.
I Driftvejledningen er hver enkel fil gennemgået i detaljer.
Afvikling
SDM startes og stoppes med Docker Compose kommandoer.
Standalone test
For en standalone test af SDM hentes "compose" folderen for den ønskede version med Subversion og kommandoen "docker-compose up" køres i folderen "test".
NSP Miljø
På et NSP miljø hentes "compose" folderen for den ønskede version med Subversion og kommandoen "docker-compose up" køres i folderen "release".