1. Introduktion

Formål

Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om hensyn til eksterne afhængigheder, placering af logfiler og konfigurationsfiler.

Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for NAP Platformen.

Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.

Ønskes mere information omkring arkitektur og design findes dette på NAP Platform - Design og Arkitektur beskrivelse.

Ønskes mere information omkring installationsvejledning til anvender kan findes på NAP Platform - Installationsvejledning.

Ønskes mere information omkring anvendelse kan dette findes på NAP Platform - Guide til anvendere.

Nap-admin-web

Hvordan fungerer servicen

Single page application med 2 routes:

Route

Funktionalitet

/projekter/{id}

Laver et kald til nap-administration og viser en projektoversigt.

I tilfælde af http fejl vises dette til brugeren.

/kontaktViser informationer om, hvordan der kan oprettes en NSP support sag

Konfiguration

configurations.json mappes til /pack/webapp/assets/

Key

Value

projectsEndpointProjekt endpoint
serverUrlRelative path til nap-admin

Konfigurationen kan ændres runtime, men skal matche loadbalancer indstillingerne.

Håndtering af fejlsituationer og logning

Nap-admin-web er en stateless webapplikation, foregår der ingen logning i denne komponent. Fejl vil dog blive skrevet ud i konsollen. I tilfælde af http fejl bliver klienten præsenteret med en fejl.

Nap-lobby-web

Hvordan fungerer servicen

Single page application med 2 routes:

Route

Funktionalitet

/projects

Laver et kald til nap-administration og viser en projektoversigt.

I tilfælde af http fejl vises dette til brugeren.

/helpViser informationer om, hvordan der kan oprettes en NSP support sag.

Konfiguration

configurations.json mappes til /pack/webapp/assets/

Key

Value

projectsEndpointProjekt endpoint
serverUrlRelative path til nap-admin

Konfigurationen kan ændres runtime, men skal matche loadbalancer indstillingerne.

Håndtering af fejlsituationer og logning

nap-lobby-web er en stateless webapplikation, og der foregår ingen logning i denne komponent. Fejl vil dog blive skrevet ud i konsollen. I tilfælde af http fejl bliver klienten præsenteret med en fejl.

Nap-test-web

Hvordan fungerer servicen

Nap-test-web fungerer som test-suite til værtsystemer.

Den tester, at kommunikationen over broen fungerer som den skal, og der er således ingen konfiguration, opsætning eller logning.

Håndtering af fejlsituationer og logning

nap-test-web er en stateless webapplikation, og der foregår ingen logning i denne komponent. Fejl vil dog blive skrevet ud i konsollen. I tilfælde af http fejl bliver klienten præsenteret med en fejl.

Nap-admin

Snitflade

Servicen kalder en database med projekter og udstiller dem på en REST snitfalde.

Endpoints

Funktionalitet

/projekter/{id}Validerer den indkommende SAMLassertion, kalder databasen og henter Projekt(er) baseret på det cvr nummer der tilknyttet brugerkonteksten.
/webapps/{id}Validerer den indkommende SAMLassertion, kalder databasen og henter WebApp(er).

Overvågnings snitflade

EndpointsFunktionalitet
/isAlive

Bruges af loadbalanceren for at tjekke at servicen er deployet. Returnerer en html side med deployment info.

Hvis der kan oprettes forbindelse til den database, der er konfigureret i datasource "jboss/datasources/admin", Returnere 200, ellers returneres 500.

Konfiguration

Følgende konfigurationsfiler skal være tilgængelige i classpath under deployment (loades fra applikationsserverens modules/dk/sds/nsp/nap/admin/main).

Konfigurationsfiler
FilnavnIndhold
nap-admin-compose-ds.xml

Datasource beskrivelse.

<datasources xmlns="http://www.jboss.org/ironjacamar/schema"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://www.jboss.org/ironjacamar/schema https://docs.jboss.org/ironjacamar/schema/ironjacamar_1_0.xsd">
    <datasource jndi-name="java:jboss/datasources/admin" pool-name="MariaDBDS">
        <connection-url>jdbc:mysql://napadmindb:3306/administration?autoReconnect=true</connection-url>
        <driver>mysql</driver>
        <pool>
            <max-pool-size>30</max-pool-size>
            <min-pool-size>5</min-pool-size>
        </pool>
        <security>
            <user-name>root</user-name>
            <password>pw</password>
        </security>
        <validation>
            <check-valid-connection-sql>select 1</check-valid-connection-sql>
            <validate-on-match>false</validate-on-match>
            <background-validation>true</background-validation>
            <background-validation-millis>10000</background-validation-millis>
        </validation>
        <timeout>
            <idle-timeout-minutes>10</idle-timeout-minutes>
        </timeout>
    </datasource>
</datasources>

log4j-napadmin.xmllog4j konfiguration
nap.jksJKS fil indeholdende NAP certifikat til audience /nap
nap-admin.properties
# Path to the service provider certificate
keystorePath=nap.jks

# Password to the service provider certificate
keystorePassword=Test1234

#  Path where public certificates of trusted STS services are stored
trustedStsCert=trusted-sts-certs.jks

# Password for the trusted sts certifikate keystore
trustedStsCertPassword=Test1234


# The audience, SAML-tokens are required to have
expectedAudience=https://audience.nspop.dk/nap

# Max clock skew
allowedClockDrift=3
trusted-sts-certs.jksJKS fil med certifikater fra STS providers.


Logging

Log4j konfigurationen skal findes i log4j-napadmin.xml på classpath.

Ved default konfiguration skrives alle modul-reletarede fejl til nap-admin.log

Fejlhåndtering

Applikationsfejl bliver logget ved hjælp af log4j, med type ERROR, INFO, DEBUG alt efter hvor alvorlig fejlen er. 

Fejlene vil blive vist i konsollen. 

Nap-java-host

Er et dummy læge praksis system, som ikke kræver nogen drift.