1. Introduktion
1.1. Formål
Dette dokument indeholder en beskrivelse af hvordan SFSK installeres på et NSP Backend miljø.
1.2. 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.
1.3. Dokument Historik
| 9/6 2021 | Eva Troels/KIT | Draft udgave af installationsvejledningen |
1.4. Definitioner og referencer
| NSP | Den nationale service platform |
| Driften | NSP Leverandøren og NSP Driftleverandøren |
| SDS | Sundhedsdatastyrelsen |
| Driftvejledning | SFSK - Driftsvejledning |
2. Installation
SFSK anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
2.1. Jenkins
SFSK bygges med NSP's Jenkins server via følgende jobs:
- SFSK_build - Bygger koden
- SFSK_push_snapshot - Pusher det nyeste snapshot image til NSP Docker Registry.
NSP Leverandøren er selv ansvarlige for at pushe release versioner af SFSK til NSP Docker Registry gennem Jenkins.
2.2. Docker
SFSK består af følgende Docker image som pushes til NSP Docker Registry:
2.3. Docker Compose
SFSK leveres samtidig som et sæt af Docker Compose filer i folderen compose.
For release x.y.z af SFSK findes Docker Compose filerne i folderen todo.
En leverance af SFSK består af en compose folder som beskrevet ovenfor samt tilhørende tags af det byggede Docker image.
Compose folderen indeholder 5 underfoldere:
| configuration | Her ligger alle de konfigurationsfiler som det forventes af driften tilretter til det anvendte miljø. Se SFSK - Driftsvejledning |
| 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 SFSK i en standalone test konfiguration. |
| release | Her ligger den Docker Compose fil som det forventes driften anvender på både test og produktionsmiljøerne. |
3. Krav til miljø
3.1. Krav til applikationsservere
Komponenterne er udviklet og testet i Docker ved anvendelse af imaget "registry.nspop.dk/platform/nsp:3.0.0-wildfly21.rc9"
Komponenternes konfiguration er således tilpasset deployering på WildFly 21 applikationsservere med OpenJDK 8.
3.2. Krav til operativsystem
Der stilles ingen krav til operativsystemet udover, at det skal være Linux, og docker skal være installeret.
3.3. Krav til adgang til andre services
SFSK anvender de bagvedliggende FSK komponenter NSP Backend miljøet (FSK Registry og FSK). Uden adgang til disse kan servicen ikke fungere.
3.4. Krav til hardware
SFSK ressourceforbrug vil afhænge af følgende:
- Antallet af samtidige læsninger af stamkort og stamkort metadata.
4. Konfiguration
I folderen compose/configuration findes følgende konfigurationsfiler:
| sfks.properties | Konfiguration af SFSK servicen |
| log4j-SFSK-ws.xml | Log opsætning af SFSK servicen |
| log4j-properties.xml | Log opsætning |
Alle filer skal tilrettes til de forskellige miljøer som SFSK installeres på. Filerne indeholder en konfiguration der passer til SFSK i en standalone test konfiguration.
I SFSK - Driftsvejledning er hver enkel fil gennemgået i detaljer.
4.1. SLA logning
Konfigurationsfiler til SLA logning ligger inde i det Docker image som SFSK producere. De følger standarden for SLA logning og det bør derfor ikke være nødvendigt at ændre i disse.
5. Afvikling
SFSK startes og stoppes med Docker Compose kommandoer.
5.1. Standalone test
For en standalone test af SFSK hentes "compose" folderen for den ønskede version med Git og kommandoen "docker-compose up" køres i folderen "test".
5.2. NSP Miljø
På et NSP miljø hentes "compose" folderen for den ønskede version med Git og kommandoen "docker-compose up" køres i folderen "release".