1. Indholdsfortegnelse

2. Introduktion

2.1. Formål

Dette dokument har normalt til formål at beskrive hvordan en NSP komponent installeres på NSP. GM-BFF kører ikke på NSP, men i Triforks test og produktionsmiljø. Dokumentet vil derfor kun liste overordnet, nogle af de teknologier som er brugt.

2.2. Læsevejledning

Læseren forventes at have kendskab til ....

2.3. Definitioner og referencer

NSP Den nationale service platform
SDS Sundhedsdatastyrelsen
Driftsvejledning GM-BFF - Driftsvejledning
GitHub Actions https://github.com/features/actions

3. Installation

GM-BFF bygges og startes  i lokal docker med følgende commando:

Kommando Beskrivelse 
mvn verify spring-boot:build-image -Dspring-boot.build-image.imageName=gm-bff -Drevision=1.0.2
 Bygger image med gm-bff med version 1.0.2 
docker run -p 8080:8080 \
  -v ./conf/logback.xml:/workspace/BOOT-INF/classes/logback.xml \
  -v ./conf/application.yml:/workspace/BOOT-INF/classes/application.yml \
  -e JAVA_OPTS="-XX:MaxDirectMemorySize=20M -Dspring.profiles.active=prod" \
  gm-bff
 Starter appen i docker med configuration angivet i application.xml og configuration af logning i logback.xml

3.1. GitHub Actions

GM-BFF benytter Github Action pipeline, hvor Workflows er ligger i folderen ./github/workflows. Byg af image startes ved at tagge med en version:

Git kommandoer 
git tag 1.0.146
 
git push --tags

Bemærk, bygge pipeline er ikke offentligt tilgængeligt og tagging skal også udføres i lukke repository.

3.2. Docker

Ved succesfuldt byg med Github Actions vil GM-BFF Docker image blive pushet ghcr.io/trifork/gm-bff. Bemærk, at der ikke er offentligt adgang.




4. Krav til miljø

4.1. Krav til applikationsservere

GM-BFF afvikles ikke som en standard NSP komponent i en applikationsserver, men i en tomcat webserver, som er default for en Spring Boot applikation.

4.2. Krav til operativsystem

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

4.3. Krav til adgang til andre services

se GM-BFF - Guide til udviklere#Kravtilsoftware

4.4. Krav til hardware

Hver instans af GM-BFF kræver ca. 1GB hukommelse at afvikle.

5. Konfiguration

GM-BFF konfigureres via følgende filer som alle skal være tilgængelige på classpath:

Filnavn Beskrivelse
application.yaml se i GM-BFF - Driftsvejledning#Konfiguration
logback.xml GM-BFF benytter logback til logning

For at filerne bliver tilgængelige på classpath, skal de  mountes ind i folderen /workspace/BOOT-INF/classes/ 


5.1. SLA logning

SLA-Logger benyttes ikke, men i stedet logges varighed af kald til komponenten i standard loggeren.

6. Afvikling

GM-BFF startes og med Docker Compose kommandoer.


7. Dokument Historik

3/4 2025 Martin Henriksen/SDS Etablering af dokumentation


  • No labels