Introduktion
Formål
Vejledning til installation og konfiguration af standardproduktet EMC® XDS Repository Connectors Version 1.9.
Der henvises til XDS Repository Installation Guide hvor dette er relevant.
Læsevejledning
Det forudsættes at læseren har kendskab til Linux (Ubuntu 16.04), Java og scriptingsproget Ansible.
Dokumenthistorik
Version | Dato | Ansvarlig | Beskrivelse |
0.1 | 08.11.2017 | KvalitetsIT | Initiel version |
Definitioner og referencer
Definition | Beskrivelse |
NSP | National Service Platform |
| Installationsscripts | De i dokumentet omtalte installationsscripts er at finde på SVN under: https://svn.nspop.dk/svn/kvalitetsit/xdsinfrastruktur |
Krav til miljø
Krav til operativsystem
XDS Repository produktet kan køre på både Linux og Windowsbaserede operativsystemer XDS Repository Installation Guide (se side 19).
De leverede installationsscripts kræver dog, at det underliggende operativsystem er af typen Ubuntu 16.04 eller tilsvarende.
Da XDS Repository er en Java web applikation kræves en Servlet container til afvikling. XDS Repository Installation Guide nævner Apache Tomcat og Oracle WebLogic.
De leverede installationsscripts installerer en Apache Tomcat ved afvikling.
Krav til adgang til andre services
Da XDS Repository har brug for en persisteringsservice, antager installationsscriptsene, at der er en xDB instans tilstede til dette formål.
XDS Repository kan anvende en xDB (master) til skrivning og evt. en række xDB (replicas) til læsning.
Installationsscripts indeholder konfigurationsvariable til dette formål.
Derudover indeholder pakken med installationsscripts scripts, der har til formål at oprette en database på en given xDB instans til brug for XDS Registry. Se xdb-repository.yml for databaseoprettelse.
XDS Repository skal have adgang til et XDS Registry til indexering af dokumenter for at levering af nye dokumenter vha ITI-41 ProvideAndRegisterDocumentSet kan fungere.
Krav til datahåndtering
XDS Repository gemmer ikke data selv, men overlader dette til den underliggende xDB (se evt SDS XDB Installationsvejledning).
Krav til hardware
XDS Repository ressourceforbrug (processorkraft og memory) vil afhænge af flere parametre:
- Antallet af samtidige requests
- Størrelsen af payload i requests og response
Deployment på Ubuntu 16.04
Dette afsnit beskriver deploymentprocessen på Ubuntu 16.04.
Deployment dækker i dette tilfælde over installationen af XDS Repository basissoftwaren og dennes afhængigheder.
Installation af XDS Repository basissoftware og afhængigheder
Dette emne er beskrevet i kapitlerne 2 og 4 i XDS Repository Installation Guide.
Installationsscriptet installerer den nødvendige Apache Tomcat7 server som en Systemd service i den leverede playbook tomcat.yml.
Selve XDS Repository installeres og konfigureres via installationsscripts til dette (se rollerne roles/hip-config henholdsvis roles/hip-deploy i pakken med installationsscripts).
Installationsscriptet antager, at XDS Repository war-filen ligger på den host, hvor installationsscriptet køres fra.
En sådan er leveret med sammen med installationsscriptsene i SVN (repository.war).
Konfiguration af komponenterne
Al konfiguration foregår ved afvikling af Ansible scripts. Det er således ikke meningen, at der skal foregå en manuel konfigurering på driftsmiljøerne.
Installationsscriptsene kan aktivere den relevante konfiguration ved anvendelse af Ansible Inventories.
For XDS Repository kan man således påvirke konfigurationen af ved følgende Ansible variable:
| Konfigurationsparameter | Beskrivelse |
|---|---|
| hip_hostname | Tomcat serverens hostname |
| hip_service_description | Navn på XDS Repository service |
| hip_xdb_host | Hostnavn på xDB (master) server |
| hip_xdb_port | Port for xDB (master) server |
| hip_xdb_database | Databasenavn for XDS Repository i xDB |
| hip_xdb_username | Brugernavn for xDB databasen |
| hip_xdb_password | Password til xDB databasen |
| hip_xdb_replica_host | Optionelt hostnavn for xDB replica |
| hip_xdb_replica_port | Optionelt hostnvan for xDB replica |
| xdsrepository_register_documentset_url | Url hvor XDS Repository kan få indexeret indkommende dokumenter |
Logning
Logning kan deles op i tre områder:
- Applikationslog (support/fejlfindingsformål)
- SLA log
- Auditlog
Applikationslog
Logs forefindes i følgende katalog: <configuration_dir>\.hip\logs
Den konkrete værdi af configuration_dir sættes i installationsscript.
Da der benyttes Simple Logging Facade for Java (SLF4J) kombineret med Log4j logging provider implementation kan logning i XDS Repository konfigureres ved at levere en logningskonfiguration ind som en log4j.xml konfigurationsfil-
Installations- og konfigurationsscriptsene håndtere dette og konfigurerer to logs som beskrevet nedenfor. Den konkrete logningskonfiguration kan ses i https://svn.nspop.dk/svn/kvalitetsit/xdsinfrastruktur/trunk/ansible/roles/hip-config/templates/repository/log4j.xml
SLA log
Til dette formål anvendes access loggen fra Tomcat serveren, der hoster XDS Repository.
Auditlog
Al auditlog foretages i de foranliggende NSP komponenter. For XDS Repository vedkommende er dette dokumentdelingsservicen (DDS) og dokumentregistreringsservicen (DRS).
Opgradering af komponenter
Ved opgradering af XDS Repository basissoftwaren skal de tilhørende release notes gennemgåes med henblik på at afdække evt. ændringer i forhold til installation og/eller konfiguration.
Hvis der ikke er ændringer i forhold til dette er det tilstrækkeligt med en erstatning af basissoftware pakken (warfilen) og en gentagelse af installationsscripts.
Afinstallation af servicen
Der er ikke leverert scripts til dette. Antagelsen er, at den (virtuelle) host, hvor XDS Repository er installeret nedlægges.
Alternativt afinstalleres Apache Tomcat7 serveren.