Indholdsfortegnelse
1. Indledning
1.1. Formål
Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere de driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om hensyn til eksterne afhængigheder, placering af logfiler og konfigurationsfiler.
1.2. Sammenhæng med øvrigt dokumenter
Dette dokument er en del af den samlede dokumentation for NADM web facade.
Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.
2. Service Snitflade
Web facaden har normalt context root på /nadm .
2.1. Rest ressourcer
Web facade består af en række REST ressourcer som er specificeret med open-api 3.0. Samtlige REST ressourcer deployeres under stien (/NADM)/api .
2.2. Overvågning (servlet)
Endpoints | Funktionalitet |
|---|---|
| /status | Bruges af load-balanceren for at tjekke at servicen er deployet. Returnerer en tekst side med status information. Da denne service ikke er afhængig af database eller andre interne services, returnere den altid 200, hvis applikationen kører og hvis anvendte certifikater er gyldige. |
3. Login / logout
Endpoints | Funktionalitet |
|---|---|
| Start login flow, der ender når bruger med ønsket rolle er valgt. |
| Invalider session og rediriger til logout side |
4. Konfiguration
Konfiguration af web facade sker i filerne i compose/configuration mappen, som er beskrevet i NADM - NAF (web facade) - Installationsvejledning. I det følgende gennemgås konfigurationsfilernes detaljer.
4.1. Konfigurationsfiler
I det følgende gennemgås en oversigt over komponentens konfigurationsfiler.
| Konfigurationsfiler for web facade | |
|---|---|
| log4j-naf.xml | Log4j opsætninger der følger gængs standard på NSP. |
5. Logning
Alle logfiler er at finde i Wildfly Server log directory (/pack/wildfly/standalone/log/). Herunder findes en liste over alle logfiler med en beskrivelse af hvilke komponenter der skriver til dem.
Logfilnavn | Komponenter der skriver til denne |
|---|---|
| access.log | indeholder access-log information genereret af applikationen selv. |
| audit.log | indeholder audit-log information genereret af applikationen selv. Heri findes information om brugeren såvel som personer, der opereres på. |
| naf.log | Applikations log |
| oiosaml-sp.log | OIOSAML |
| oiosaml-sp-audit.log | OIOSAML Audit |
| server.log | Wildfly Applikationsserver |
5.1. SLA log punkter
NAF SLA logger ikke.
6. Fejlhåndtering
Applikationsfejl bliver logget ved hjælp af log4j, med type ERROR, INFO, DEBUG alt efter hvor alvorlig fejlen.