Indhold
Introduktion
Formål
Dette dokument indeholder en beskrivelse af hvordan IDSAS 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.
Definitioner og referencer
NSP | Den nationale service platform |
Driften | NSP Leverandøren og NSP Driftleverandøren |
SDS | Sundhedsdatastyrelsen |
Installation
IDSAS anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
Jenkins
IDSAS bygges med NSP's Jenkins server via følgende jobs:
- IDSAS_build - Bygger koden
- IDSAS_push_snapshot - Pusher det nyeste snapshot image til NSP Docker Registry.
NSP Leverandøren er selv ansvarlige for at pushe release versioner af IDSAS til NSP Docker Registry igennem Jenkins.
Docker
IDSAS består af følgende Docker images som pushes til NSP Docker Registry:
registry.nspop.dk/components/idsas/registration |
registry.nspop.dk/components/idsas/lookup |
registry.nspop.dk/components/idsas/salt |
registry.nspop.dk/components/idsas/operations |
Docker Compose
IDSAS leveres samtidig som et sæt af Docker Compose filer i folderen https://git.nspop.dk/projects/COM/repos/identitetsloering-af-ansatte-i-det-danske-sundhedsvaesen/browse/compose.
En leverance af IDSAS 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 IDSAS - Driftsvejledning. |
database | Her ligger liquidbase change sets til databasen. |
development | Her ligger en Docker Compose fil til brug for udvikling. Se IDSAS - Guide til udviklere. |
test | Her ligger en Docker Compose fil der kan starte IDSAS i en standalone test konfiguration. |
release | Her ligger Docker Compose-filer som det forventes, at driften anvender på både test og produktionsmiljøerne.
Der ligger også en compose fil som skal køres, for at få de seneste databaseændringer på med liquibase. Se mere under "Afvikling".
|
Krav til miljø
Krav til applikationsservere
Komponenterne er udviklet og testet i Docker ved anvendelse af imaget "registry.nspop.dk/platform/nsp:latest".
Komponenternes konfiguration er tilpasset deployment 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 adgang til andre services
IDSAS kræver adgang til "Personinformation".
Konfiguration
I folderen "compose/configuration" findes følgende konfigurationsfiler:
idsas-registration.properties | Konfiguration af idsas-registration servicen |
idsas-lookup.properties | Konfiguration af idsas-lookup servicen |
idsas-operations.properties | Konfiguration af idsas-operations servicen |
log4j.properties | Opsætning af logning i servicen |
liquidbase.properties | Database-credentials til liquibase |
Alle filer skal tilrettes til de forskellige miljøer som IDSAS installeres på. Filerne indeholder en konfiguration der passer til IDSAS i en standalone test konfiguration.
I IDSAS - Driftsvejledning er de enkelte filer gennemgået i detaljer.
SLA logning
Konfigurationsfiler til SLA logning konfigureres i nedenstående filer. De følger standarden for SLA logning og det bør derfor ikke være nødvendigt at ændre i disse.
nspslalog-idsas.properties | Propertyfil, der udpeger den konkrete SLA log konfigurationsfil, der anvendes |
log4j-nspslalog-idsas.properties | SLA log konfigurationsfil |
Afvikling
IDSAS startes og stoppes med Docker Compose kommandoer.
Salt
For at servicen kan køre, skal det sikres, at der ligger et aktuelt "salt" i databasen til sløring. Se mere under "Oprettelse/fornyelse af salt" i IDSAS - Driftsvejledning.
Liquibase
Database-ændringer til servicen køres på med Liquibase. Dette gøres i praksis ved at køre "release/docker-compose-db.yml" med kommandoen:
docker-compose -f compose/release/docker-compose-db.yml up --build
Bemærk, at "compose/configuration/liquibase.properties" skal indeholde de relevante database-credentials.
Standalone test
For en standalone test af IDSAS hentes "compose" folderen for den ønskede version og kommandoen herunder køres i testfolderen:
docker-compose up
NSP Miljø
På et NSP miljø hentes "compose" folderen for den ønskede version og kommandoen "docker-compose -f <compose-file> up" køres i folderen "release", for hver docker-compose fil.