Page History
...
Introduktion
Formål
Dette dokument indeholder en beskrivelse af hvordan installeres på et ??? miljø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.
Læsevejledning
Læseren forventes at have kendskab til ....
...
| NSP | Den nationale service platform |
| SDS | Sundhedsdatastyrelsen |
| Driftsvejledning | GM-BFF - Driftsvejledning |
| GitHub Actions | https://github.com/features/actions |
Installation
GM-BFF anvender ??? Continuous Integration og Continuous Deployment miljøer til byg og leverance af komponenten.
Jenkins
GM-BFF bygges med Jenkins server via følgende jobs:
Docker
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 \ | Starter appen i docker med configuration angivet i application.xml og configuration af logning i logback.xml |
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.
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.GM-BFF består af følgende Docker image som pushes til ??? Docker Registry:
Krav til miljø
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.
Krav til operativsystem
Der stilles ingen krav til operativsystemet udover, at det skal være Linux, og docker skal være installeret.
Krav til adgang til andre services
se GM-BFF - Guide til udviklere#Kravtilsoftware
Krav til hardware
Hver instans af GM-BFF kræver ca. 1GB hukommelse at afvikle.
Konfiguration
I folderen ??? findes følgende konfigurationsfiler:
...
Alle filer skal tilrettes til de forskellige miljøer som GM-BFF installeres på. Filerne indeholder en konfiguration der passer til GM-BFF i en standalone test konfiguration.
I GM-BFF - Driftsvejledning er hver enkel fil gennemgået i detaljer.
SLA logning
Konfigurationsfiler til SLA logning konfigureres i nedenstående filer. De følger standarden for SLA logning og det bør derfor ikke være nødvendigt at ændre i disse.
...
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/
SLA logning
SLA-Logger benyttes ikke, men i stedet logges varighed af kald til komponenten i standard loggeren.
Afvikling
GM-BFF startes og stoppes med ??? Docker Compose kommandoer.
Dokument Historik
| 3/4 2025 | Martin Henriksen/SDS | Etablering af dokumentation |
...