Versions Compared

Old Version 46

changes.mady.by.user Unknown User (jpe@kvalitetsit.dk)

Saved on

compared with

New Version Current

changes.mady.by.user Kristian Dorland

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyBeskrivelse
kafka.consumer.bootstrap.serversKommasepareret liste af Kafka servere som NAS2 skal anvende. Denne liste bør indeholde alle noderne i Kafka clusteret
kafka.consumer.client.idNavnet som NAS2 vil fremgå med i listen af Consumers på et Kafka Cluster.
nsp.kafka.consumer.component.nameNavnet på NAS2 komponenten
nsp.kafka.consumer.component.abbreviationKort navn på NAS2 komponenten
nsp.kafka.consumer.component.versionVersionen af NAS2 komponenten
nsp.kafka.consumer.service.nameNavnet på den service i NAS2 der anvender Kafka
datasource.jndiJNDI navnet på den datasource der giver adgang til NAS2 databasen.
app.endpointService endpoint (anvendes i DKS servlet)
pullpoint.app.endpoint.regexRegex udtryk for service Service endpoint for pull point servicen. Anvendes til at validere korrekt format af pullpoint. F.eks.: https?://localhost:\\d{1,5}/pullpoint/service/
liquibase.changelog.fileAngiver hvilken changelog fil som liquibase skal anvendes. Property er ikke krævet. Hvis der skal afvikles integrationstest mod det miljø der installeres skal denne sættes til liquibase-changelog-test.xml. Denne kan også sættes via en environmentvariabel i formen liquibase_changelog_file.

...

PropertyBeskrivelse
datasource.jndiJNDI navnet på den datasource der giver adgang til NAS2 databasen.
ageDen maksimale alder for et abonnement før det kommer i betragtning for oprydning. Format er beskrevet på https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java.lang.CharSequence-
liquibase.changelog.fileAngiver hvilken changelog fil som liquibase skal anvendes. Property er ikke krævet. Hvis der skal afvikles integrationstest mod det miljø der installeres skal denne sættes til liquibase-changelog-test.xml. Denne kan også sættes via en environmentvariabel i formen liquibase_changelog_file.
delete.batch.sizeAntal nasconsumers, der slettes i ét batch ved cleanup. Begrænses for at undgå at 'låse' databasen for længe ad gangen ved cleanup. 

log4j-cleanup.xml

Denne fil indeholder en Log4J opsætning der følger gængs standard på NSP.

...

Denne service konfigureres i filerne "administration.properties" og "log4j-administration.xml"

cleanup.properties

PropertyBeskrivelse
datasource.jndiJNDI navnet på den datasource der giver adgang til NAS2 databasen.
app.endpointService endpoint (anvendes i OpenAPI specifikationen).

log4j-cleanup.xml

Denne fil indeholder en Log4J opsætning der følger gængs standard på NSP.

...

NAS2 skal anvender NSP Kafka Clusteret på NSP Backend miljøet. Der kræves ikke nogen særlig opsætning af Kafka i forhold til det eksisterende NSP Kafka Cluster.

...

Administration af topics i NAS2

I det følgende gennemgåes de manuelle aktiviteter der skal ske i databasen og i Kafka ifm driften af NAS2. 

Nyt Topic

For at NAS2 skal kunne modtage adviseringer på et Topic skal dette oprettes i Kafka og i databasen. For at give tilladelse til at der kan oprettes abonnementer og afhentes adviseringer på et Topic, skal der desuden  oprettes et Topic Access i databasen. 

Opret Topic

Først oprettes Kafka Topic via følgende kommando:

Code Block
bin/kafka-topics.sh --create --bootstrap-server kafka-host:port --replication-factor 2 --partitions 6 --topic dk.nsp.bo.nas.fmk.MedicineCard

Herefter mappes dette Kafka Topic til et WS-Notification Topic i databasen på følgende måde:

Til at administrere topics og adgang til topics anvendes forskellige shell scripts, som kalder administrationsservicen i NAS2. I den forbindelse opdateres topics både i databasen og i kafka.

 Hent Topic

 Hent liste med alle Topics

Code Block
get_topics.sh basepath="localhost:8086/administration"

 Hent specifikt topic med detaljer

Code Block
get_topics.sh basepath="localhost:8086/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard"

Nyt Topic

For at NAS2 skal kunne modtage adviseringer på et Topic skal dette oprettes i Kafka og i databasen.
For at give tilladelse til at der kan oprettes abonnementer og afhentes adviseringer på et Topic, skal der desuden  oprettes et Topic Access i databasen. 

Opret Topic

Først oprettes Topic via følgende kommando, hvor topic er navnet på topic i databasen og internal_topic er  navnet på topic i kafka:

Code Block
create_topic.sh basepath="NAS/administration" topic="
Code Block
languagesql
INSERT INTO TopicMapping
	(topic, internal_topic)
VALUES
	('http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard', '" internalTopic="dk.nsp.bo.nas.fmk.MedicineCard');

Opret Topic Access

" numPartitions=6 replicationFactor=2

Udover de ovenstående parametre er det også muligt at sætte kafka topic config parametre, hvis ønsket (fx cleanup.policy=delete).

Mulige kafka topic config parametre findes fx her: https://kafka.apache.org/documentation/#topicconfigs

Opret Topic Access

Efter oprettelse af et Topic, tildeles adgang ved at oprette Topic access. 

Topic Access Topic access oprettes med en identifier, der angiver adgangen til et specifikt topic. Identifier kan indeholde '"ALL'", et cvr-nummer på formen '"CVR:XXXXXXXX'", eller et et Subject Serial Number (CVR-RID, CVR-UID eller CVR-FID på formen: 'CVR:XXXXXXXX-XID:XXXXXXXX', UUID).
Eksempler:

  • '"CVR:46837428'"
  • '"CVR:46837428-FID:92421325'"
  • "UI:DK-O:G:23550132-5e1f-4e43-a5f9-048acf49e0b8"

Topic Access oprettes i databasen på følgende måde: 

Code Block
languagesql
INSERT INTO topic_access
	(topic, identifier, comment)
VALUES
	('.sh basepath="NAS/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard', 'ALL', '" operation="create" identifier="ALL" comment="SDS-4393: topic access oprettet');"

Lukke for et Topic

For at lukke for nye adviseringer til et Topic opdateres rækken i "TopicMapping" på følgende mådeanvendes følgende shell script og parametre:

Code Block
languagesql
UPDATE TopicMapping SET active = false where topic activate_deactivate_topic.sh basepath="NAS/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard";" activation="disable"

Slette et Topic

For at slette et topic bør det først være inaktivt i en periode således at der ikke kan afleveres nye data og modtagere kan nå at afhente alle deres adviseringer. Derefter skal nedenstående udføres. 

Nedenstående sletter topic fra NAS databasen .og i kafka: 

Code Block
languagesql
delete from TopicMapping where topic = '_topic.sh basepath="NAS/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard';

Nedenstående sletter topic i kafka.

"

Hvis et topic har tilhørende subscriptions vil sletning fejle med ovenstående kommando. Hvis man ønsker at gennemtvinge sletning og dermed også slette tilhørende subscriptions anvendes parameteren 'force' som nedenstående viser:

Code Block
delete_topic.sh basepath="NAS/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard" force="true"
Code Block
bin/kafka-topics.sh --delete --bootstrap-server kafka-host:port --topic dk.nsp.nas.fmk.MedicineCard

Ændre Topic Access

Hvis der skal ændres på hvem, der har lov til at tilgå et topic, skal det opdates i Topic Access i databasen. 

Tilføj en adgang til et Topic

Der kan være flere rækker i databasen med adgange tildeles adgange til et topic på cvr eller cvr-Xid. Der kan være flere adgange for et topic. For at give en ny tilladelse oprettes et nyt Topic Access på følgende måde: 

Code Block
languagesql
INSERT INTO topic_access
	(topic, identifier, comment)
VALUES
	('http.sh basepath="NAS/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard', '" operation="create" identifier="CVR:46837428', '" comment="SDS-4393: ny tilladelse oprettet');"

Slette en adgang til et Topic

Hvis en adgang til et Topic skal slettes, gøres det på følgende måde:

Code Block
languagesql
DELETE FROM topic_access 
WHERE.sh basepath="NAS/administration" topic = '"http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard'
AND" operation="delete" identifier = '"CVR:46837428';"

Ændre tilladelse fra 'ALL' til cvr eller cvr-Xid

...

Herefter tilføjes adgang for de ønskede CVR eller eller CVR-Xid. 

Udvide antallet af partitioner

Hvis der opstår et behov i Kafka for at udvide antallet af partitioner for et Topic, skal der ikke foretages noget i NAS2 idet den selv opdager dette og tilpasser sig det nye antal.

Overvågning

Alle services i NAS udstiller en status side. På denne side fremgår servicens versionsnummer samt status for adgang til database og/eller Kafka. Status siden kan tilgås via http://NAS/SERVICE_NAME/health. SERVICE_NAME er pullpoint, pullpointfactory, idlist, notificationbroker, subscriptionmanager eller cleanup. Det svarer til de 6 services der er implementeret i NAS2.

Eksempel på svar på fra status-siden. 

 Hent liste over adgange for et Topic

For at se hvilke identifiers der er tildelt adgang til et topic anvendes følgende script:

Code Block
languagesql
topic_access.sh basepath="NAS/administration" topic="http://www.dkma.dk/medicinecard/xml.schema/2012/06/01:MedicineCard"

Udvide antallet af partitioner

Hvis der opstår et behov i Kafka for at udvide antallet af partitioner for et Topic, skal der ikke foretages noget i NAS2 idet den selv opdager dette og tilpasser sig det nye antal.

Overvågning

Alle services i NAS udstiller en status side. På denne side fremgår servicens versionsnummer samt status for adgang til database og/eller Kafka. Status siden kan tilgås via http://NAS/SERVICE_NAME/health. SERVICE_NAME er pullpoint, pullpointfactory, idlist, notificationbroker, subscriptionmanager eller cleanup. Det svarer til de 6 services der er implementeret i NAS2.

Eksempel på svar på fra status-siden. 

Code Block
HTTP/1.1 200 OK
Connection: keep-alive
X-Powered-By: Undertow/1
Server: WildFly/8
Content-Type: application/json
Content-Length: 82
Date: Fri
Code Block
HTTP/1.1 200 OK
Connection: keep-alive
X-Powered-By: Undertow/1
Server: WildFly/8
Content-Type: application/json
Content-Length: 82
Date: Fri, 10 May 2019 08:06:26 GMT

{
	"version": "1.0.0-SNAPSHOT"
	,"database": "OK"
	,"kafka streamer": "OK"
}

...

LogningspunktKomponent

Eksempel på message fra applikationsloggen

(formatteret så det er lettere at læse i denne vejledning)

Der logges når der oprettes et PullPoint. Hertil medtages yderligere information, så som ejeren, evt. abonnement og URL, der er tilknyttet.

PullPointFactory

Service

STATISTIK: {
  "action":"createPullPoint",
  "info":{
    "pullPointId":"98a3f337-4a65-45db-9001-2c9f0b69ff05",
    "ownerItSystem":"NAS2UnitTests",
    "ownerCvr":"46837428"}}

Logning af alle forespørgsler til Pull Point service herunder antal af adviseringer, der medtages i svaret.

Der logges også om der var tale om replay (DGWS).

PullPoint

Service

STATISTIK: {
  "action":"getmessages",
  "info":{
    "pullPointId":"2acedce5-c00a-40bc-8ddf-fe6de2a596a3",
    "subscriptionIds":["a34c720f-9c26-4832-83d1-8671d4b6f7f3"],
    "quota":2,
    "replay":false}}

Alle kald til Notification Broker skal ligeledes logges sådan at antal af adviseringer modtaget kan uddrages. Her vil topic også medtages.

NotificationBroker

Service

STATISTIK: {
  "action":"notify",
  "info":{
    "quota":1,
    "topic":"TESTNAS-TOPIC1"}}
Offsets statistik log logger information omkring subscription og offsets på subscription og offsets i Kafka.PullPoint service
STATISTIK: {
  "action":"offsets",
  "owner":["46837428NAS2UnitTests"],
  "endOffsets":["146","72","72"],
  "maxOffsetDelta":["17"],
  "pullPointId":["d43c793f-b29a-4d61-b9db-5970e2fc65f0"],
  "deltaOffsets":["17","16","17"],
  "topic":["topic"],
  "subscriptionId":["d8274761-4c27-40d4-bef3-31cec848f5a6"]
}

For alle kald til Notifikation Broker logges det om et request indeholder DGWS headers.
Dermed er muligt at overvåge dette i forbindelse med udfasningen af muligheden for at kalde uden.

NotificationBroker

Service

STATISTIK: {
     "action":"notify",
     "info":{"No security headers found. Notification request is without DGWS protection"}
}

DKS-snitflader

Relevante services udstiller deres DKS-snitflade på endpointet "/dks".  I skrivende stund findes følgende:

  • <serverurl>/idlist/service/dks
  • <serverurl>/subscriptionmanager/service/dks
  • <serverurl>/pullpointfactory/service/dks
  • <serverurl>/pullpoint/service/dks

Test af DKS

Efter konfiguration og deployment af NAS2, kan en given DKS-snitfladen testes i stil med følgende:

Code Block
languagebash
curl -i http://localhost:8080/pullpointfactory/service/dks

Eksempel på output:

Code Block
languagexml
HTTP/1.1 200 OK
Connection: keep-alive
Transfer-Encoding: chunked
Content-Type: text/xml;charset=UTF-8
Date: Thu, 18 Jan 2024 09:28:28 GMT

<?xml version="1.0"?><root xmlns="http://nspop.dk/2014/04" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://nspop.dk/2014/04 dks.xsd">    <dksVersion>1</dksVersion>    <timestamp>2024-01-18T09:25:06+01:00</timestamp>    <name>pullpointfactory</name>    <endpoint>http://localhost:8080/pullpointfactory/service</endpoint>    <operations>    <action name="http://docs.oasis-open.org/wsn/bw-2/CreatePullPoint/CreatePullPointRequest"><model>synchronous_timeout</model><timeoutMillis>120000</timeoutMillis><idCardLevel>VOCES</idCardLevel></action>    </operations></root>

Oprydning

Der kan foretages oprydning af abonnementer og nasconsumers i databasen.
Der konfigureres hvor gamle abonnementer må være – se tidligere – og så sker oprydningen når oprydningsservicen kaldes.
Nasconsumers fjernes i batches af 20. 

...