Introduktion
Formål
Dette dokument indeholder en beskrivelse af hvordan erstatningsCPR2 (herefeter eCPR2) 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
| Version | Dato | Ændring | Ansvarlig |
Definitioner og referencer
| NSP | National Service PLatform |
| DGWS | Den Gode WebSErvice |
| NAS2 | National Adviseringsservice |
| SCES | CPR enkeltopslag |
Installation
eCPR anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
Jenkins
eCPR bygges med NSP's Jenkins server via følgende jobs: registry.nspop.dk/platform/nsp
- ECPR2_build/ Bygger koden
- ECPR2_push_release/ - HVAD GØR DET HER?
NSP Leverandøren er selv ansvarlige for at pushe release versioner af eCPR til NSP Docker Registry gennem Jenkins. Spørg jacob om hvordan push/release virker ift når vi aflerverer eCPR som en branch på git (Spørgsmål til Jacob (se dokument))
Docker
eCPR består af en service og dermed også et docker image som pushes til NSP Docker Registry. Det hedder registry.nspop.dk/components/ecpr2:
Docker Compose
eCPR leveres samtidig som et sæt af Docker Compose filer, der findes i folderen https://git.nspop.dk/projects/COM/repos/erstatnings-cpr-numre/browse/compose
Compose folderen indeholder 4 underfoldere hvor databaseligger under configuration:
| Folder navn | Beskrivelse |
| configuration/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. |
| release | Her ligger en Docker Compose fil til brug i produktion |
eCPR leveres via en github branch, navngivet som den aktuelle version.
Krav til miljø
Krav til applikationsservere
Komponenterne er udviklet og testet i Docker ved anvendelse af imaget "registry.nspop.dk/platform/nsp:3-latest"
Komponenternes konfiguration er tilpasset deployement på WildFly 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
Der er krav til at eCPR har adgang til en MySQL database.
Databasen vedligeholdes ved hjælp af Liquibase. Liquibase forventer at database samt bruger allerede er oprettet. Som standard forventes det at databasen den hedder ecpr2, men dette kan ændres, ved at ændre i følgende to property filer:
- liquibase.test.properties placeret i compose/configuration/database
- ecpr2.properties, som er placeret i compose/configuration
For begge filer gælder, at url'en skal tilpasses hvor databasenavnet (originalt ecpr2) ændres.
Hvis integrationstestene skal afvikles skal propertien "changelogFile" ændres til liquibase-changelog-test.xml (standard) i filen liquidbase.test.properties. Hvis integrationstestene ikke skal afvikles, ændres propertien "changelogFile" til at pege på liquibase-changelog-master.xml.
Krav til adgang til andre services og views
eCPR kræver adgang til NSP STD gennem 3 forskellige views:
- Authorization View fra autorisationsregisteret
- Bemyndigelse View fra bemyndigelsesservice
- Person View fra cpr registeret
Hver view er yderligere beskrevet nedenfor, hvor det ses hvilke informationer, der skal udstedes gennem hvert view:
| Authorization view |
|---|
| Information |
| Authorisationsnummer |
| CPR |
| Uddannelses Kode |
| ValidFrom |
| ValidsTo |
| Bemyndigelses view |
|---|
| Information |
| BemyndigelsePID |
| Rettighed |
| System |
| Status |
| Arbejdsfunktion |
| Bemyndigede cvr |
| Bemyndigede cpr |
| Bemyndigende cpr |
| Gyldig fra dato |
| gyldig til dato |
| ValidFrom |
| ValidTo |
| Person View |
|---|
| Information |
| Status |
| CPR |
| ValidFrom |
| ValidTo |
eCPR kræver derudover adgang til NAS2 for at kunne udføre de relevante adviseringer, samt adgang til SCES, for at kunne verificere CPR-numre.
Krav til hardware
Der stilles ikke nogle særlige krav til hardware. Servicen er en Java Spring Boot service, og kan dermed køre på en virtuel maskine.
Konfiguration
I folderen https://svn.nspop.dk/svn/components/nas/trunk/compose/configuration findes følgende konfigurationsfiler:
ecpr2.properties | Konfiguration af ecpr2 services |
| log4j2-ecpr2.xml | Konfiguration af Log4J |
FMK-KRS-TEST.jks | Certifikat til testbrug. Det er konfigureret i ecpr.properties hvilket certifikat der bruges |
Alle filer skal tilrettes til de forskellige miljøer som eCPR2 installeres på. Filerne indeholder en konfiguration, der passer til eCPR2 i en standalone test konfiguration.
I eCPR - Driftsvejledning er hver enkel fil gennemgået i detaljer.
SLA logning
Spørg Markus
Konfigurationsfiler til SLA logning ligger inde i de Docker images som NAS2 producere. De følger standarden for SLA logning og det bør derfor ikke være nødvendigt at ændre i disse.
Afvikling
eCPR startes og stoppes med Docker Compose kommandoer. Her indsættes den relevante folder mellem $foldernavn$ alt efter miljø,:
Start: docker-compose -f compose/$foldernavn$/docker-compose.yml up
Stop: docker-compose -f compose/$foldernavn$/docker-compose.yml down
Hvis servicen eks. køres i development miljø bruges docker-compose -f compose/development/docker-compose.yml up for at starte servicen op
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".