Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootBackend For Frontend Facade (GM-Facade) - Leverancebeskrivelse


...

Driftsvejledningen indeholder information om GM-BFF Facade med hensyn til eksterne afhængigheder, standard placering af logfiler og konfigurationsfiler, og evt. krav til genstart af applikationer hvis komponenten ikke er responsiv.

I afsnit 3 (Komponenter) er beskrevet hvilke komponenter, der indgår i GM-BFF Facade og deres forventede placering med hensyn til platform.

Afsnit 5 (Konfiguration) beskriver aktuelle konfigurationsparametre for GM-BFF Facade henholdsvis Repository, samt eksempler på konfigurationsparameter-filer.

Afsnit 6.1, 6.2 og 6.3 (Overvågning) beskriver hvorledes GM-BFF Facade komponenterne overvåges.

I afsnit 6.4 er GM-BFFFacade-relaterede logfiler beskrevet, så disse evt. kan overvåges, og tillige danne baggrund for fejlsøgning.

...

Specielle krav til backup er beskrevet i afsnit 8 (Krav til backup m.m.), ligesom procedure ved reetablering af komponenten ud fra backup beskrives.

Læsevejledning

Læseren forventes at have kendskab til .NSP miljøet...

Definitioner og referencer

...

Dette dokument dækker følgende komponenter:

  • Graviditetsmappens App Facade (GM-Facade)
    • Type: Webservice
    • Filnavn: gmaf.war
    • Statusurl: <serverurl>/gmaf/status
    • Alarmurl: <serverurl>/gmaf/alarm
    • Endpoints for GM-Facade:
      • Opslag i journal url:  <serverurl>/gmaf/api/2025/06/25/journal

Daglig drift

Dette afsnit beskriver den daglige drift af systemet.

Relaterede services

GM-Facade afhænger af tilstedeværelsen af en række andre services, og ved fejl i nogle af disse vil komponenten fejle tilsvarende. Disse services er:

  • Mobile Access to Health Documents (MHD)
  • Certificate Revocation Authority  (CRA)

Konfiguration

Komponenterne afvikles i et ??? docker compose setup, som ligger under ???

log4j konfiguration

Log4j konfiguration findes i (hvis ovenstående format anvendes):

Se yderligere opsætning i installationsvejledningen.

SLA-log konfiguration

Konfiguration af SLA-log findes i filen:

Whitelist konfiguration

Der foretages whitelisting ...

Monitorering

Til statuscheck af GM-BFF

Overvågning

GM-BFF overvåges ...

Placering af HTML overvågningsside

...

Fortolkning af HTML overvågningsside

Alle overvågningssider returnerer enten status 200 hvis de i øjeblikket kører fint, status 404 hvis servicen ikke er deployeret, .... og status 500, hvis der er opstået en fejl, og komponenten derfor ikke virker korrekt.

Overvågningstype

Som udgangspunkt overvåges følgende:

Audit log

Auditlogning foretages med ...

under https://git.nspop.dk/scm/com/graviditetsmappens-app-facade.git. Konfigurationsproperties er beskrevet GM-Facade - Installationsvejledning#Konfiguration


Property

Beskrivelse

Påkrævet

Default værdi

Property

Beskrivelse

Påkrævet

Default værdi

mhd.baseurlPrefix på de dokumentreferencer som returneres fra MHD. Prefixet skal matche den kørende instans adresse. Eksempel: 

https://test1-cnsp.ekstern-test.nspop.dk:8443/mhd

Ja
gmaf.httpclient.connectiontimeout.seconds

Forbindelse timeout i sekunder. 

Nej25
gmaf.httpclient.pooling.maxconnections.pr.route

Antal HttpClients forbindelser der kan åbnes pr. rute

Nej20
gmaf.httpclient.pooling.maxconnections.total

Totale antal HttpClients forbindelser der kan åbnes

Nej200
gmaf.http.forward.headers

Kommasepareret liste af http headers der videresendes i request til mhd.

Nej


Konfiguration af access-handler til validering af jtp-h tokens konfigureres med filerne i folderen /pack/wildfly/modules/system/layers/base/dk/sds/nsp/accesshandler/main. Filerne ctrl.skip og log.skip er tomme og selve konfiguration af accesshandleren ligger i filen jtph.properties:


     

Property

Beskrivelse

Påkrævet

Default værdi

jtph.enabledEnablement af validering af jtph-h. Skal være sat til true.Ja


jtph.issuers.sds.name

Udsteder af jtp-h token. Eksempel: https://test.cloud.idm.trifork.com/auth/realms/gravidJa
jtph.issuers.sds.audienceTilladt audience. Eksempel: https://audience.nspop.dk/mhdJa
jtph.issuers.sds.ttlTime-to-live benyttes pt. af access hander til at validere auth_time og iat. Derfor skal denne pt. sættes en måned. Eksempel: PT43200M 

Se evt. https://jira.nspop.dk/browse/SDS-8792
Ja
jtph.issuers.sds.assurance.level.1Skal være sat til https://data.gov.dk/concept/core/nsis/loa/SubstantialJa
jtph.issuers.sds.assurance.level.2Skal være sat til https://data.gov.dk/concept/core/nsis/loa/HighJa
jtph.issuers.sds.issuance.policy.1Skal være sat til urn:dk:sds:policy:gm-accessJa

Keys: 

Keys definere properties krævet for at validere signaturen af et jtp-h token. Da der kan være flere gyldige tokens på samme tid, så er kid fra token en del af propertien. Dog skal man angive små bogstaver og kun de første 32 tegn fra kid'en. 

jtph.keys.<keyid>.type
Typen af certifikatet. Eksempel: pkcs12
Ja
jtph.keys.<keyid>.file
Java keystore indeholdende et certikat 
Ja
jtph.keys.<keyid>.password
Adgangskode til keystore
Ja
jtph.keys.<keyid>.aliasAlias for certifikatet i keystoreJa


For mere information om konfiguration af access handler se NSP Access Handler - Driftvejledning#jtph.properties

Log-konfiguration

Der benyttes Log4j2. En konfiguration er findes i filen compose/configuration/log4j2.properties, hvor logs fra GM-Facade skrives til filen:

/pack/wildfly/standalone/log/gmaf.log

SLA-log konfiguration

GM_Facade er en viderestillingsservice og der er ikke separat sla-logning. I stedet logges udvalgte tider i GM-Facade loggen. 

Whitelist konfiguration

Komponenten kræver ikke whitelisting. Sikkerhed er udelukkende styret af medsendt JTP-H.

Monitorering

Til statuscheck af GM-Facade udstilles <serverurl>/gmaf/status som returnerer HTTP 200 når komponenten er oppe. Status returnerer ikke yderligere status'er, da servicen er en simpel viderestillingsservice uden egen datakilde. 

Overvågning

GM-Facade overvåges på <serverurl>/gmaf/alarm. Endpointet returnerer HTTP 200, med mindre et eller flere kald til komponenten er fejlet med HTTP 500, i så fald returnes HTTP 500:


Eksempel på kald der returnerer HTTP 200:

Monitor: Total number of requests: 5, failed: 0

Audit log

Der foretages ingen audit logning i GM-Facade ud over det som logges af access handler.De forskellige ITI-håndtag logges på følgende måde:

Standard fejlsøgning

  • Ved problemer med indlæsning af servicens konfigurationsfiler (...) bør man verificere at ...
  • Ved manglende logning hvor der forventes fejlbeskeder bør konfigurationsfilen (...) checkes, da logindstillingerne sættes herigennem.
  • alle påkrævede properties er sat og alle tilhørende filer er indlæst korrekt.
  • En service eller et job kan stoppes og startes gennem docker.

...

Det anbefales at aktuelle konfigurationsfiler til GM-BFF Facade er under versionskontrol og back up.

...

Dokument Historik

3/4 2025Martin Henriksen/SDSEtablering af dokumentation
15/9 2025Thomas Glæsner/TriforkUdfyldt