Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootNational Adviseringsservice 2 (NAS2 ) - LeverancebeskrivelseYderligere dokumentation
includeroottrue


Table of Contents
maxLevel2

...

Dette dokument indeholder en beskrivelse af hvordan National Adviseringsservice 2 Multiplexer (herefter NAS2NAS Multiplexer) installeres på et NSP Backend miljø.

...

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

DatoAnsvarligBeskrivelse
TBDJacob Qvortrup
2019-11-18Joans PedersenFørste
Draft
udgave af installationsvejledningen

Definitioner og referencer

ReferenceBeskrivelse
NAS2National Adviseringsservice 2
NAS1National Adviseringsservice 1
NSPDen nationale service platform
DriftenNSP Leverandøren og NSP Driftleverandøren
SDSSundhedsdatastyrelsen
Driftvejledning
NAS2
Multiplexer -
Driftvejledning
driftsvejledning

Installation

NAS2 NAS Multiplexer  anvender NSP's Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.

...

NAS2 bygges med NSP's Jenkins server via følgende jobs:

NSP Leverandøren er selv ansvarlige for at pushe release versioner af NAS2 NAS Multiplexer til NSP Docker Registry gennem Jenkins.

Docker

NAS2 NAS Multiplexer består af fem et Docker images som pushes til NSP Docker Registry med følgende navnenavn:

Docker Compose

-multiplexer

Docker Compose

NAS multuplexer NAS2 leveres samtidig som et sæt af Docker Compose filer i folderen https://svn.nspop.dk/svn/components/nas-multiplexer/trunk/compose/.

For release x.y.z af NAS2 NAS Multiplexer findes Docker Compose filerne i folderen https://svn.nspop.dk/svn/components/nas-multiplexer/tags/release-x.y.z/compose/

En leverance af NAS2 NAS Multiplex består af en compose folder som beskrevet ovenfor samt tilhørende tags af de fem Docker imagestag af docker image.

Compose folderen indeholder 5 4 underfoldere:

FolderIndhold
configurationHer 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
developmentHer ligger en Docker Compose fil til brug for udvikling. Se Guide til Udviklere.
testHer ligger en Docker Compose fil der kan starte NAS2 i en standalone test konfiguration.
releaseHer ligger den Docker Compose fil som det forventes driften anvender på både test og produktionsmiljøerne.

Krav til miljø

Krav til applikationsservere

...

Der stilles ingen krav til operativsystemet udover, at det skal være Linux, og docker skal være installeret.

Krav til database

Databasen til NAS2 systemet er en selvstændig database og selvstændige tabeller i forhold til NAS1. NAS2 deler derfor ikke database med NAS1.NAS Multiplexer anvender ikke en database. 

Krav til adgang til andre services

NAS2 anvender NSP Kafka installationen på NSP Backend miljøet samt NSP Databasen. Uden adgang til disse kan servicen ikke fungere.NAS Multiplexer kalder videre til både NAS1 og NAS2 servicene. Det er notify servicen der kaldes. Derfor skal NAS Multiplexeren have adgang til disse to services for at kunne fungere. 

Krav til datahåndtering

Kravet til anvendere af NAS1 og NAS2 er at adviseringer ikke må indeholde personfølsomme data. Da det er anvendere af notify servicen på NAS1 der skal kalde NAS Multiplexeren er det de samme regler som for NAS1 og NAS2 der gælder for NAS Multiplexer.  NAS Multiplexer har dog ikke nogen måde at sikre dette, det er derfor op til SDS at sikre anvenderne overholder dette.

Krav til hardware

NAS2's NAS Multiplexerens ressourceforbrug vil afhænge af følgende:

  • Antallet og størrelsen af samtidige afleveringer af Adviseringer

    Antallet af samtidige hentning

    af Adviseringer

    .

  • Antallet af ID'er i en ID-liste der aktivt anvendes ifm hentning af Adviseringer.

NAS2 er derimod lavet således at dens ressourceforbrug stort set ikke vil afhænge af følgende:

  • Antallet af Pullpoints
  • Antallet af Abonnementer.
  • Antallet af ID-lister.

NAS2 gennerelle krav til hardware er baseret på NSP Kafka miljøets krav til hardware, da denne står for opbevaring af alle Adviseringer.

Konfiguration

I folderen https://svn.nspop.dk/svn/components/nas/trunk/compose/configuration findes følgende konfigurationsfiler:

FilIndhold
notificationbroker

multiplexer.properties

Konfiguration af
Notification Broker servicen
NAS Multiplexer servicen
log4j-multiplexer
idlist.propertiesKonfiguration af ID-list servicensubscriptionmanager.propertiesKonfiguration af Subscription Manager servicenpullpointfactory.propertiesKonfiguration af Pullpoint Factory servicenpullpoint.propertiesKonfiguration af Pullpoint servicencleanup.propertiesKonfiguration af Cleanup servicennas-ds.xmlDatasource filen der bruges af alle serviceslog4j-notificationbroker
.xmlLog opsætning af
Notification Broker servicenlog4j-idlist.xmlLog opsætning af ID-list servicenlog4j-subscriptionmanager.xmlLog opsætning af Subscription Manager servicenlog4j-pullpointfactory.xmlLog opsætning af Pullpoint Factory servicenlog4j-pullpoint.xmlLog opsætning af Pullpoint servicenlog4j-cleanup.xmlLog opsætning af Cleanup
NAS Multiplexer servicen

Alle filer skal tilrettes til de forskellige miljøer som NAS2 NAS Multiplexer installeres på. Filerne indeholder en konfiguration der passer til NAS2 NAS Multiplexer i en standalone test konfiguration.

I Driftvejledningen er hver enkel fil gennemgået i detaljer.

...

Konfigurationsfiler til SLA logning ligger inde i de Docker images som NAS2 NAS Multiplexer producere. De følger standarden for SLA logning og det bør derfor ikke være nødvendigt at ændre i disse.

Afvikling

NAS2 NAS Multiplexer startes og stoppes med Docker Compose kommandoer.

...

For en standalone test af NAS2 NAS Multiplexer hentes "compose" folderen for den ønskede version med Subversion og kommandoen "docker-compose up" køres i folderen "test".

...