Jämförda versioner

Nyckel

  • Dessa rader lades till.
  • Denna rad togs bort.
  • Formateringen ändrades.



Innehållsförteckning

Konfiguration av Virtualiseringsplattformen

VP 2.2.1 och senare

Från och med version 2.2.1 överlagras defaultinställningar genom att på applikationens classpath skapa 2 filer, För att överlagra defaultinställningar behöver en fil med namnet vp-config-override.properties och vp-security-override.properties. I dessa 2 filer definierar man endast de parametrar som skall skilja sig från de defaultinställningar som finns definierade i applikationen. I den mule-paketerade applikationen (vp-services-[version].zip) finns defaultinställningar definierade under <zip>/classes/vp-config.properties, respektive <zip>/classes/vp-security.properties.

Parametrar i vp-config.properties

Parameter = Unikt namn på konfigurations parameter.

Default värde = Värdet på parametern, så som det är konfigurerat i den paketerade VP applikationen. Kan överlagras med egna värden vid behov, se version av VP ovan för mer info om överlagring av parametrar.

Kommentar = Förklaring/hjälp för en parameter.

Applikationsinställningar

Generella inställningar för VP, som inte faller in under något specifikt område

ParameterDefault värdeKommentar

IP_WHITE_LIST

127.0.0.1

Kommaseparerad lista innehållandes ip-adresser över konsumenter som vill kommunicera med VP via http. Exempel på
konsumenter är aggregerande tjänster, Engagemangsindex och reverse proxy. 

Default tillåts 127.0.0.1, dvs kommunikation internt exempelvis för aggregerande tjänster och Engagemangsindex.

Info

Sedan VP 2.2.4 är det möjligt att definiera subnät i listan av adresser, tex 127.0.0 för alla adresser under det subnätet.

VAGVALROUTER_INBOUND_URI

vagvalrouter/v1

 

VAGVALROUTER_SENDERID

OU Fält i inkommande certifikat som skall användas för att plocka ut information av avsändare, för att kunna göra behörighetskontroll. Notera att för SITHS certifikat skall värdet 2.5.4.5 användas.

VAGVALROUTER_HTTPSCONSUMERCONNECTORNAME

VPConsumerConnector

 
VP_INSTANCE_IDTHIS_VP_INSTANCE_ID

Ett unikt ID på en VP instans för att att användas som identifierare vid kommunikation mellan flera VP instanser, tex en regional och nationell.

Info

Sedan VP 2.2.4

ENABLE_LOG_TO_JMStrue

Frivillig property för att styra om loggning skall ske till JMS eller inte.

Info

Sedan VP 2.2.6

VAGVALROUTER_SENDER_IP_ADRESS_HTTP_HEADERX-Forwarded-For

Frivillig property som tex en lastdelare kan sätta för att vidarebefordra information
om en klients ip adress. 

Info

Sedan VP 2.2.6

 

Dashboard för enkel statistik på tillgängliga tjänster

ParameterDefault värdeKommentar

HTMLDASHBOARDSERVICE_INBOUND_URI

monitor/dashboard

Adress till den tjänst i VP som exponerar enkel statistik på de virtuella tjänster som finns driftsatta.

HTMLDASHBOARDSERVICE_PORT

22000Port till den tjänst i VP som exponerar enkel statistik på de virtuella tjänster som finns driftsatta.

Monitorera om VP är operativ

VP exponerar en tjänst som kan användas för att avgöra om tjänsten VP är operativ, dvs att alla nödvändiga resurser som VP behöver finns tillgängliga och fungerar.

Notera att denna tjänst inte skall blandas ihop med virtuella tjänsten Ping eller PingForConfiguration.

ParameterDefault värdeKommentar

PINGSERVICE_INBOUND_URI

monitor/ping

Adress (URI) till ping-tjänst.

PINGSERVICE_PORT

21000Port till ping-tjänst.

PINGSERVICE_RESPONSE

TP is alive!

Texten som ping-tjänsten svarar med om VP är operativ.

PINGSERVICE_ERROR_RESPONSE

TP ERROR:

Texten som ping-tjänsten svarar med om VP inte operativ. Efter : fyller VP på med felmeddelande. 

PINGSERVICE_TEST_LOGICAL_ADDRESS

TEST_SERVICE_HSA_ID

Den logiska adress som ping-tjänsten använder för att göra ett internt anrop till virtuella tjänsten Ping. För att detta skall fungera korrekt måste det gå att adressera virtuella Ping tjänsten i VP mad angiven logisk adress. Routing och behörighet för detta sätts upp i Tjänstekatalogen.

PINGSERVICE_TEST_TIMEOUT_MS

2000

Timeout i millisekunder (2000 ms = 2 sekunder) som tjänsten har på sig att svara.

PINGSERVICE_TEST_URL

https://${TP_HOST}:${TP_PORT}/${TP_BASE_URI}/Ping/1/rivtabp20

Adress till den virtuella Ping tjänst som ping-tjänsten anropar.
   

VP exponerar även tjänsten PingForConfiguration, definierad i RIV TA.

ParameterDefault värdeKommentar
PINGFORCONFIGURATIONSERVICE_RIVTABP20_INBOUND_ENDPOINT
Kodblock
http://${TP_HOST}:${PINGFORCONFIGURATIONSERVICE_RIVTABP20_PORT}/${TP_BASE_URI}/${PINGFORCONFIGURATIONSERVICE_RIVTABP20_INBOUND_URI} 
Info
titleSedan release

VP 2.2.3

PINGFORCONFIGURATIONSERVICE_RIVTABP20_PORT

8080Port till PingForConfiguration tjänsten.

PINGFORCONFIGURATIONSERVICE_RIVTABP20_INBOUND_URI

services/PingForConfiguration/1/rivtabp20

Adress (URI) till PingForConfiguration tjänsten.
PINGFORCONFIGURATIONSERVICE_RIVTABP21_INBOUND_ENDPOINT
Kodblock
http://${TP_HOST}:${PINGFORCONFIGURATIONSERVICE_RIVTABP21_PORT}/${TP_BASE_URI}/${PINGFORCONFIGURATIONSERVICE_RIVTABP21_INBOUND_URI}
Info
titleSedan release

VP 2.2.3

PINGFORCONFIGURATIONSERVICE_RIVTABP21_PORT

8080Port till PingForConfiguration tjänsten.

PINGFORCONFIGURATIONSERVICE_RIVTABP21_INBOUND_URI

services/PingForConfiguration/1/rivtabp21

Adress (URI) till PingForConfiguration tjänsten.

Hantering av VP's lokala cache för Tjänsteadresseringskatalogen

Konfiguration för tjänsten reset TAK cache, vlken används för att ladda in ny information från Tjänsteadresseringskatalogen.

ParameterDefault värdeKommentar
RESETVAGVALCACHE_INBOUND_URIresetcacheAdress (URI) till tjänsten resetcache. Denna konfiguration ger att tjänsten är tillgänglig via http//:23000/resetcache
RESETVAGVALCACHE_PORT23000Port till tjänsten resetcache.
LOCAL_TAK_CACHE${user.home}${file.separator}.tk.localCache

Sökväg till filen som skall innehålla den lokala cachen av Tjänstekatalogen i VP.

Info
titleSedan release

VP 2.2.1

 

Hantering av lokal cache av HSA's organisationsträd

Konfiguration för tjänsten reset HSA cache, vlken används för att ladda in ny information från HSA. Informationen från HSA representeras i form av XML filer som läses in i VP.

...

Kommaseparerad lista av sökvägar till filer som innehåller HSA information att ladda in i VP's HSA cache.

 

Varning

Notera att i VP 2.2.0 och VP 2.2.1 så finns det ingen default HSA fil paketerad. För att VP skall starta krävs därför att man uppdaterar vp-config.properties (VP 2.2.0) eller vp-config-override.properties (VP 2.2.1) med en sökväg till en existerande hsacachecomplementary.xml.

För VP 2.2.1 finns en HSA fil med enbart SE noden att ladda ner här, läs installationsanvisning för VP 2.2.1 en för hur den skall appliceras.

Köhantering, ActiveMQ

Inställningar för ActiveMQ och köer för hantering av loggar

ParameterDefault värdeKommentar

SOITOOLKIT_MULE_AMQ_BROKER_URL

failover:(tcp://localhost:61616)

Adress för att koppla upp VP till ActiveMQ

SOITOOLKIT_MULE_AMQ_MAX_REDELIVERIES

3Antalet försök innan ett meddelande anses felaktigt och skickas till dead letter kön

SOITOOLKIT_MULE_AMQ_REDELIVERY_DELAY

10000Sätter tiden mellan nya omsändningsförsök, 10000 = 10 sekunder

SOITOOLKIT_MULE_AMQ_NO_OF_CONSUMERS

2Antalet konsumenter som kommer att startas upp och ta emot meddelanden
SOITOOLKIT_LOG_INFO_QUEUESOITOOLKIT.LOG.STOREKönamn för köer att hantera meddelande (request/response) loggar.
SOITOOLKIT_LOG_ERROR_QUEUESOITOOLKIT.LOG.ERRORKönamn för köer att hantera error loggar.

Generellt tjänster, ändpunkter

...

TP_DISPATCH_MAX_THREADS_ACTIVE

...

TP_DISPATCH_MAX_THREADS_IDLE

...

TP_DISPATCH_MAX_THREADS_TTL

...

TP_RECEIVE_MAX_THREADS_ACTIVE

...

TP_RECEIVE_MAX_THREADS_IDLE

...

TP_RECEIVE_MAX_THREADS_TTL

...

SERVICE_TIMEOUT_MS

...

Ange i millesekunder, defaultvärde hur länge en ändpunkt skall vänta innan ett synkront anrop avbryts.

Info

Läs också det som beskrivs i rubriken Feature responseTimeout för konfiguration per tjänst.

...

SOCKET_SO_LINGER_MS

...

SO_TIMEOUT is the timeout that a read() call will block. If the timeout is reached, a java.net.SocketTimeoutException will be thrown. 

# If you want to block forever put this option to zero (the default value), then the read() call will block until at least 1 byte could be read.

Info

Sedan VP 2.2.2

...

VP_MULE_HTTPS_PRODUCER_CONNECTOR_TCPNODELAY

...

VP_MULE_HTTPS_PRODUCER_CONNECTOR_KEEPALIVE

...

VP_MULE_HTTPS_PRODUCER_CONNECTOR_KEEPALIVE_TIMEOUT_MS

...

VP_MULE_HTTPS_CONSUMER_CONNECTOR_TCPNODELAY

...

VP_MULE_HTTPS_CONSUMER_CONNECTOR_KEEPALIVE_TIMEOUT_MS

...

VP_MULE_HTTP_CONSUMER_CONNECTOR_TCPNODELAY

...

VP_MULE_HTTP_CONSUMER_CONNECTOR_KEEPALIVE

...

VP_MULE_HTTP_CONSUMER_CONNECTOR_KEEPALIVE_TIMEOUT_MS

...

VP_MULE_HTTP_CONSUMER_CONNECTOR_SERVICE_TIMEOUT_MS

...

Ange i millesekunder hur länge VP skall vänta att en klient har leveretat hela sitt svar

Info

Borttagen i release VP 2.2.2, all hantering av default timeout definieras i SERVICE_TIMEOUT_MS, läs också det som beskrivs i rubriken Feature responseTimeout för konfiguration per tjänst.

...

VP_MULE_HTTP_CONSUMER_CONNECTOR_SOCKET_SO_LINGER_MS

...

SO_TIMEOUT is the timeout that a read() call will block. If the timeout is reached, a java.net.SocketTimeoutException will be thrown. 

# If you want to block forever put this option to zero (the default value), then the read() call will block until at least 1 byte could be read.

Info

Sedan VP 2.2.2

...

TP_HOST

...

TP_PORT

...

TP_PORT_HTTP

...

TP_BASE_URI

...

Inställningar för att VP´s koppling till Tjänsteadresseringskatalogen (TAK)

...

TP_SOKVAGVALSINFO_URL

...

http://localhost:8082/tp-vagval-admin-services/SokVagvalsInfo/v2

...

Adress till tjänsten i TAK för att hämta behörigheter och routing information.

Info

Sedan VP 2.2.2 finns ett beroende till TAK 1.4.0 pga att en ny tjänst med EI filter finns implementerad.

...

TK_HOST

...

Kodblock
https://${TP_HOST}:${GETSUPPORTEDSERVICECONTRACTS_RIVTABP21_PORT}/${TP_BASE_URI}/GetSupportedServiceContracts/1/rivtabp21?connector=VPProducerConnector

...

Info
titleSedan release

VP 2.2.3

Default till https på port 23001 för bakåtkompabilitet.

...

GETSUPPORTEDSERVICECONTRACTS_OUTBOUND_URI

...

tp-vagval-admin-services/GetSupportedServiceContracts

...

Kodblock
http://${TP_HOST}:${TP_PORT_HTTP}/${TP_BASE_URI}/services/GetSupportedServiceContracts/2/rivtabp21

...

Info
titleSedan release

VP 2.2.3

...

Version 2 av adress till tjänsten i TAK för att hämta information om vilka tjänstekontrakt som stöds av en verksamhet/system (logisk adress).

Info

Sedan VP 2.2.2

...

GETSUPPORTEDSERVICECONTRACTS_RIVTABP21_PORT

...

GETLOGICALADDRESSESBYSERVICECONTRACT_OUTBOUND_URI

...

tp-vagval-admin-services-1.3.1/GetLogicalAddresseesByServiceContract

...

Adress till tjänsten i TAK för att hämta information om vilka verksamheter/system (logisk adress) en konsument har behörighet att anropa, givet tjänstekontrakt.

Info

Borttagen i release VP 2.2.2

...

GETLOGICALADDRESSESBYSERVICECONTRACT_RIVTABP21_PORT

...

23001

Port till tjänsten i TAK för att hämta information om vilka verksamheter/system (logisk adress) en konsument har behörighet att anropa, givet tjänstekontrakt.

Info

Borttagen i release VP 2.2.2. Ersätts av GETLOGICALADDRESSESBYSERVICECONTRACT_V1_INBOUND_ENDPOINT

...

Ersätter GETLOGICALADDRESSESBYSERVICECONTRACT_RIVTABP21_PORT för att kunna styra om

man vill ha http eller https internt. Default till samma port som tidigare.

Info

Sedan VP 2.2.2

...

Info

Sedan VP 2.2.2

finnas på classpath.

För att överlagra defaultinställningar vad gäller säkerhet behöver en fil med namnet vp-security-override.properties finnas på classpath.

Instruktion för tidigare versioner av VP

SKLTP VP - Konfiguration av äldre versioner

Release Note - Virtualiseringsplatformen, för att läsa om förändringar mellan olika versioner

Instruktion för sensate versionen av VP - 2.2.7

Typiska inställningar i vp-security-overide.properties

Kodblock
TBD

 

Typiska inställningar i vp-config-overide.properties

Kodblock
TBD

 

Komplett sammanställning av alla inställningar som finns i VP

2.2.7-RC1 vp-config.properties

2.2.7-RC1 vp-security.properties

Konfiguration av specifika features

Feature keep-alive

För de virtuella tjänster i VP som har stöd för keep-alive finns det möjlighet att per tjänst styra om keep-alive skall vara aktiverat eller ej. Ett default värde (feature.keepalive) sätts för alla virtuella tjänster som sedan kan överlagras av respektive tjänst som vill aktivera keep-alive. Aktiveringen av keep-alive görs enligt en given konvention:

...

Default sätts connection och response timeouten i parametern SERVICE_TIMEOUT_MS.

Parametrar i vp-security.properties (Certifikat inställningar)

Sökväg till katalog innehållandes certifikat

ParameterDefault värdeKommentar

TP_TLS_STORE_LOCATION

../certs

Katalogen som innehåller certifikatsfiler.

Truststore

En truststore innehåller certifikat från andra intressenter som vp förväntas kommunicera med och lita på.

ParameterDefault värdeKommentar

TP_TLS_STORE_TRUSTSTORE_TYPE

jksformat på truststore

TP_TLS_STORE_TRUSTSTORE_FILE

truststore.jks

filnamn på truststore innehållandes certifikat som vp förväntas lita på

TP_TLS_STORE_TRUSTSTORE_PASSWORD

password

lösenordet på truststore

Keystore som producent

Keystore som innehåller autentiseringsinformation som skall skickas till konsumenter när VP agerar som producent, dvs när VP tar emot information.

ParameterDefault värdeKommentar

TP_TLS_STORE_PRODUCER_TYPE

jksformat på keystore

TP_TLS_STORE_PRODUCER_FILE

tp.jks

fiknamn på klientcertifikat

TP_TLS_STORE_PRODUCER_PASSWORD

password 

TP_TLS_STORE_PRODUCER_KEY_PASSWORD

password 

Keystore som konsument

Keystore som innehåller autentiseringsinformation som skall skickas till producenter när VP agerar som konsument, dvs när VP skickar information.

...

TP_TLS_STORE_CONSUMER_TYPE

...

TP_TLS_STORE_CONSUMER_FILE

...

.

...

TP_TLS_STORE_CONSUMER_PASSWORD

...

TP_TLS_STORE_CONSUMER_KEY_PASSWORD

...

Konfigurera loggning av LogEvents

Konfiguration av loggning görs i <mule-hom>/apps/<vp-services>/classes/log4j.xml, notera att det inte krävs någon omstart av applikationen, ändringar slår direkt i runtime.

...

Kodblock
titlemule-app-vp.log
** logEvent-info.start ***********************************************************
IntegrationScenarioId=
ContractId=
LogMessage=xreq-in
ServiceImpl=vagval-dynamic-routing-flow
Host=33.33.33.1 (33.33.33.1)
ComponentId=1133a557-b5cc-11e3-bd36-2da34769782a
Endpoint=https://localhost:20000/vp/tjanst1
MessageId=15c27c95-b5cc-11e3-bd36-2da34769782a
BusinessCorrelationId=15cc67b1-b5cc-11e3-bd36-2da34769782a
BusinessContextId=
ExtraInfo=
-senderid=tp
-originalServiceconsumerHsaid=null
-source=se.skl.tp.vp.util.LogTransformer
-cxf_service=urn:skl:tjanst1:rivtabp20
-rivversion=RIVTABP20
-receiverid=vp-test-producer
Payload=
** logEvent-info.end *************************************************************

 

VP 2.2.2 och senare

I VP 2.2.2 infördes möjligheten styra loggning av payload av eller på. All loggning av LogEvents styrs från VP 2.2.2 enbart med följande konstruktion, se kommentar i exemplet för olika lognivåer.

Info

Notera att i VP 2.2.2 är default att logga payload. Vid ett godkännande att sätta default avslagen payload loggning kommer detta att införas i en release.

Kodblock
title<vp-services>/classes/log4j.xml
   <!--      
        For logging events to QUEUE using EventLogger:
        
        NOTE: For now default is to log payload for each request/response, however for performance
        etc the opposite is the goal, to not log payload by default. This will be addressed in
        coming releases.
        
        DEBUG puts logevents (with payload) and errorevents on log queue
        INFO puts logevents (without payload) and errorevents on log queue
        ERROR will only put errorevents on log queue
         
    -->
    <logger name="org.soitoolkit.commons.mule.messageLogger">
        <level value="DEBUG" />
    </logger>

 

...