Introduktion

Formål

Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af programmet.

Driftsvejledningen indeholder information om XDSCleanup komponenten med hensyn til afvikling, konfiguration og overvågning.

Læsevejledning

Læseren forventes at have kendskab til drifts-setuppet vedr. XDS Registry og det tilhørende XDB repository.

Dokumenthistorik

Version	Dato	Ansvarlig	Beskrivelse
0.1	28-02-2022	KvalitetsIT	Initiel udgave

Afvikling

XDSCleanup udstiller et antal http-endpoints. Dette afsnit beskriver hvilke endpoints der er, og deres returkoder og fortolkning af svaret.

Cleanup

Primært endpoint, som starter en iteration af oprydningen: Eksempel på kald:

curl -i localhost:8060/xdscleanup/cleanup

Der returneres følgende http-statuskoder:

Statuskode	Fortolkning
200 OK	Sletningen gik godt. Det vil fremgå af applikationloggen, hvad der er slettet.
400 Bad Request	Requestet blev afvist, da et andet request allerede var i gang.
500 Internal Server Error	Noget gik galt under sletning. Applikationsloggen bør inspiceres for at fastslå problemet.

Health

Overvågnings-endpoint, som bruges til at overvåge komponentens sundhedstilstand. Eksempel på kald:

curl -i localhost:8060/xdscleanup/health

Der returneres følgende http-statuskoder:

Statuskode	Fortolkning
200 OK	Sletningen gik godt. Det vil fremgå af applikationloggen, hvad der er slettet.
500 Internal Server Error	Noget gik galt under sletning. Applikationsloggen bør inspiceres for at fastslå problemet.

Desuden vil body'en indeholde en json-struktur, der beskriver hvilke dele af systemet der er blevet tjekket, og deres tilstand. Eksempel:

{
  "version": "42e17e1cb3ea8d8abd21d87252b14a136020e7c0",
  "registry.db": "OK"
}

Konfiguration

Grundlæggende konfiguration foregår ved redigering i filen application.properties, som skal placeres under mappen "config" relativt i forhold til hvor jar-filen startes fra.

I filen skal følgende properties være definerede:

Property	Beskrivelse
xds.iti18.endpoint	Adressen på Aftale XDS Registrys iti-18 endpoint
xds.iti62.endpoint	Adressen på Aftale XDS Registrys iti-62 endpoint
xdb.url	Stien til Aftale Registry XDB
xdb.username	Brugernavn til Aftale Registry XDB
xdb.password	Kodeord til Aftale Registry XDB
xdb.database	Navnet på Aftale Registry XDB-databasen
delete.after.days	Hvor gamle dokumenter i Registry skal være, før de slettes
max.deletes	Hvor mange dokumenter der max slettes ved en kørsel af jobbet
type.code	Type Code på de dokumenter der slettes (Her er aftale = "39289-4")

Logning

XDSCleanup logger på standardout vha. log4j. Jobbet vil undervejs i kørslen udskrive følgende INFO statements ud:

Undervejs i søgningen i XDB:
- Found documents to delete: X (efter hver 100 dokumenter)
- Finished finding documents to delete, found: X
Undervejs i sletning fra XDS:
- Deleted X/Y documents from registry
- Finished deleting documents, deleted: X , failed deleting: Y
Job finished successfully eller Job finished - Y deletions failed

Fejl vil blive logget som ERROR statements og vil være "Error fetching uuids from XDB" eller "Error deleting document with ID" med tilhørende fejlbesked.

Overvågning

Her beskrives hvilke informationer der udskrives på health-url'en.