Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Tilrettelser efter snak med Jacob Qvortrup
Navitabs
rooteCPR - Leverancebeskrivelse
includeroottrue

Følgende punkter er valgt ud fra FSK - installationsvejledning

Overblik

Skal indeholde en introduktion til siden. Derduover kunne det også indeholde en introduktion tik hvilke dependencies der er til systemet. Måske også antallet af komponenter systemet består af? 

Ændringslog

Dette er en versionshistorik

Byggevejledning

  1. Beskriv hvordan projektet bygges uden test (Vi er nede i mvn kommandoer)
  2. Beskriv hvor deployables ender efter build (Target folder?).

Afvikling af tests

  1. Beskriv hvordan test afvikles (Måske en adskillelse mellem integrationstests og unittest?) 

Krav til database

Servicen er testet mod MariaDB version 10.1, som bliver brugt på NSP platformen.

Bemærk, ved unittest anvendes en in-memory H2 database, som automatisk startes op, når unittests køres.

Krav til hardware

Oprettelse af databaser og tabeller

Herunder beskrives servicens tilgang til database samt oprettelse af tabeller og views.

Tilgang til database

Oprettelse af database og tabeller

Deployment

Konfiguration af servicen

Herunder beskrives properties i eCPR komponentens konfigurationsfiler.

application.properties

Tabel med properties?

Overblik over komponenter

Der følgende beskriver de forskellige deployables som komponenten indeholder.

...

Filnavn på deployet

...

Beskrivelse

...

Kilde

...

fsk-service.war

...

FSK servicen

...

fsk-service-<version>.war


!!! — NAS — !!!

Introduktion

Formål

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

...

Læseren forventes at have kendskab til Sundhedsdatastyrelsens platform NSP, samt generelt kendskab til WildFly applikation serverserver, Docker, Docker Compose samt Ubuntu Linux operativ system.

...

Definitioner og referencer




eCPR
NAS2







Installation

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

...

eCPR består af en service og dermed også et docker image som pushes til NSP Docker Registry. Det hedder registry.nspop.dk/fmkcomponents/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 5 4 underfoldere hvor databaseligger under configuration:



configurationOBS!! Database ligger under configuration folderen??/databaseHer 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.
test
release

...

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

Krav til database

(Generelt om dette afsnit: Vi venter med at opdatere det til vi kender formatet af databaserne mm)

...

Krav til adgang til andre services

eCPR kræver adgang til NAS2 for at kunne udføre de relevante adviseringer

VI ER NÅET HERTIL!!!

(Krav til adgang til NAS 2) NAS2 anvender NSP Kafka installationen på NSP Backend miljøet samt NSP Databasen. Uden adgang til disse kan servicen ikke fungere.

...

Kravet til anvendere af NAS2 er at adviseringer ikke må indeholde personfølsomme data. NAS2 har dog ikke nogen måde at sikre dette, det er derfor op til SDS at sikre anvenderne overholder dette.

Krav til hardware

(Spørg Anders (ARN))

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

...

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

ecpr2.properties

Konfiguration af ecpr2 services
kafka-producer properties???
log4j2-ecpr2.xml

Hvad med de .properties der er i ecpr2-service/resources? Hvilke skal med of hvilke udelades?

Fra NAS

notificationbroker.properties

Konfiguration af Notification Broker servicenidlist.propertiesKonfiguration af ID-list servicensubscriptionmanager.propertiesKonfiguration af Subscription Manager servicenpullpointfactory.propertiesKonfiguration af Pullpoint Factory servicenpullpoint.propertiesKonfiguration af Pullpoint servicencleanup.propertiesKonfiguration af Cleanup servicenadministration.propertiesKonfiguration af administrations servicen.nas-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 servicenlog4j-administration.xmlLog opsætning af administrations servicen.

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 NAS2 eCPR2 installeres på. Filerne indeholder en konfiguration der passer til NAS2 eCPR2 i en standalone test konfiguration. 

I Driftvejledningen er (LINK!) er hver enkel fil gennemgået i detaljer. ← Skal vi også det? eller rettere, skal det være her eller i driftvejledningen?Ja 

SLA logning

Spørg Mark

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.

...

eCPR startes og stoppes med Docker Compose kommandoer. Her indsættes den relevante folder mellem $foldernavn$ alt efter miljø,:

Start: docker-compose -f compose/development$foldernavn$/docker-compose.yml up -d --build

Stop:  docker-compose -f compose/development$foldernavn$/docker-compose.yml down

Specielt for administration servicen

Denne service udstiller kun REST endpoints til anvendelse af administration af NAS2 og skal derfor kun være tilgængelig for driften.

Standalone test

For en standalone test af NAS2 hentes "compose" folderen for den ønskede version med Subversion og kommandoen "docker-compose up" køres i folderen "test".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 Subversion git og kommandoen "docker-compose up" køres i folderen "release".

...