Error rendering macro 'navitabs'
com.atlassian.renderer.v2.macro.MacroException: The root page with the name 'NSP XDS Registry (NXRG) - Leverancebeskrivelse' does not exist in space with key 'web'!
Introduktion
Formål
Dette dokument indeholder en beskrivelse af hvordan NXRG 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
| 5/5 2021 | Nils Asbjørn Joensen/KIT | Draft udgave af installationsvejledningen |
Definitioner og referencer
| NSP | Den nationale service platform |
| Driften | NSP Leverandøren og NSP Driftleverandøren |
| SDS | Sundhedsdatastyrelsen |
| Driftvejledning | NXRG - Driftsvejledning |
Installation
NXRG anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
Jenkins
NXRG bygges med NSP's Jenkins server via følgende jobs:
- NXRG_build - Bygger koden
- NXRG_push_snapshot - Pusher det nyeste snapshot image til NSP Docker Registry.
NSP Leverandøren er selv ansvarlige for at pushe release versioner af NXRG til NSP Docker Registry gennem Jenkins.
Docker
NXRG består af følgende Docker image som pushes til NSP Docker Registry:
Docker Compose
NXRG leveres samtidig som et sæt af Docker Compose filer i folderen https://svn.nspop.dk/svn/components/nxrg/trunk/compose.
For release x.y.z af NXRG findes Docker Compose filerne i folderen https://svn.nspop.dk/svn/components/nxrg/tags/release-x.y.z/compose
En leverance af NXRG 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 NXRG - Driftsvejledning Heri findes også folderen database, som indeholder sql-filer til oprettelse af NXRG-databasen. |
| 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 NXRG 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:3.0.0-wildfly21.rc6" (2021/10/19)
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
Databasen til NXRG er en selvstændig database.
Databasen vedligeholdes ved hjælp af Liquibase. Liquibase forventer at database samt bruger allerede er oprettet. Som standard forventes det at databasen hedder nxrg, men dette kan ændres i nxrg-ds.xml.
Hvis der skal afvikles integrationstest mod det mijlø der installeres, skal changelog filen liquibase-changelog-test.xml anvendes. Dette kan angives via konfigurationsproperty liquibase.changelog.file.
Krav til adgang til andre services
NXRG anvender NAS (National Adviseringsservice) på NSP Backend miljøet. Uden adgang til NAS kan servicen ikke fungere.
Krav til hardware
NXRG 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 https://svn.nspop.dk/svn/components/nxrg/trunk/compose/configuration findes følgende konfigurationsfiler:
| crl.skip | Skip-liste til CRL-tjek. |
| log4j.properties | Log opsætning. |
| log4j-nspslalog-nxrg.properties | Log4j SLA-log konfiguration. |
| log4j-nxrg-ws.xml | Log opsætning af NXRG servicen. |
| module.xml | JBoss modul-definition. |
| nspslalog-nxrg.properties | SLA-log konfiguration. |
| nxrg.properties | Konfiguration af NXRG servicen. |
| nxrg-ds.xml | Datasource definition. |
Alle filer skal tilrettes til de forskellige miljøer som NXRG installeres på. Filerne indeholder en konfiguration der passer til NXRG 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
NXRG startes og stoppes med Docker Compose kommandoer.
Standalone test
For en standalone test af NXRG 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".