1. Indholdsfortegnelse
2. Introduktion
2.1. Formål
Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om GM-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-Facade og deres forventede placering med hensyn til platform.
Afsnit 5 (Konfiguration) beskriver aktuelle konfigurationsparametre for GM-Facade henholdsvis Repository, samt eksempler på konfigurationsparameter-filer.
Afsnit 6.1, 6.2 og 6.3 (Overvågning) beskriver hvorledes GM-Facade komponenterne overvåges.
I afsnit 6.4 er GM-Facade-relaterede logfiler beskrevet, så disse evt. kan overvåges, og tillige danne baggrund for fejlsøgning.
Beskrivelse af standard fejlsøgning og start/stop vejledning for komponenterne er beskrevet i afsnit 7 (Standard 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.
2.2. Læsevejledning
Læseren forventes at have kendskab til NSP miljøet.
2.3. Definitioner og referencer
|
Definition |
Beskrivelse |
|---|---|
| NSP | Den nationale service platform |
| SDS | Sundhedsdatastyrelsen |
3. Komponenter
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
4. Daglig drift
Dette afsnit beskriver den daglige drift af systemet.
4.1. 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)
5. Konfiguration
Komponenterne afvikles i et docker compose setup, som ligger 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.baseurl | Prefix 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. |
Nej | 25 |
| gmaf.httpclient.pooling.maxconnections.pr.route |
Antal HttpClients forbindelser der kan åbnes pr. rute |
Nej | 20 |
| gmaf.httpclient.pooling.maxconnections.total |
Totale antal HttpClients forbindelser der kan åbnes |
Nej | 200 |
| 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.enabled | Enablement af validering af jtph-h. Skal være sat til true. | Ja |
|
|
|
|||
| Udsteder af jtp-h token. Eksempel: https://test.cloud.idm.trifork.com/auth/realms/gravid | Ja |
|
|
| jtph.issuers.sds.audience | Tilladt audience. Eksempel: https://audience.nspop.dk/mhd | Ja |
|
| jtph.issuers.sds.ttl | Time-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.1 | Skal være sat til https://data.gov.dk/concept/core/nsis/loa/Substantial | Ja |
|
| jtph.issuers.sds.assurance.level.2 | Skal være sat til https://data.gov.dk/concept/core/nsis/loa/High | Ja |
|
| jtph.issuers.sds.issuance.policy.1 | Skal være sat til urn:dk:sds:policy:gm-access | Ja |
|
|
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>.alias | Alias for certifikatet i keystore | Ja |
|
For mere information om konfiguration af access handler se NSP Access Handler - Driftvejledning#jtph.properties
5.1.1. 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 |
5.1.2. SLA-log konfiguration
GM_Facade er en viderestillingsservice og der er ikke separat sla-logning. I stedet logges udvalgte tider i GM-Facade loggen.
5.1.3. Whitelist konfiguration
Komponenten kræver ikke whitelisting. Sikkerhed er udelukkende styret af medsendt JTP-H.
5.2. 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.
6. 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
6.1. Audit log
Der foretages ingen audit logning i GM-Facade ud over det som logges af access handler.
7. Standard fejlsøgning
- Ved problemer med indlæsning af servicens konfigurationsfiler bør man verificere at 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.
8. Krav til backup m.m.
Det anbefales at aktuelle konfigurationsfiler til GM-Facade er under versionskontrol og back up.
9. Dokument Historik
| 3/4 2025 | Martin Henriksen/SDS | Etablering af dokumentation |
| 15/9 2025 | Thomas Glæsner/Trifork | Udfyldt |