Introduktion
Formål
Vejledning til installation og konfiguration af standardproduktet EMC ® Documentum® XDS Registry Version 1.9.
Der henvises til XDS Registry 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 Registry produktet kan køre på både Linux og Windowsbaserede operativsystemer XDS Registry Installation Guide (se side 55).
De leverede installationsscripts kræver dog, at det underliggende operativsystem er af typen Ubuntu 16.04 eller tilsvarende.
Da XDS Registry er en Java web applikation kræves en Servlet container til afvikling. XDS Registry 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 Registry har brug for en persisteringsservice, antager installationsscriptsene, at der er en xDB instans tilstede til dette formål.
XDS Registry 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-registry.yml for databaseoprettelse.
Krav til datahåndtering
Konfigurationen af komponenten ligger som scripts og er under versionskontrol (SVN).
XDS Registry gemmer ikke data selv, men overlader dette til den underliggende xDB (se evt SDS XDB Installationsvejledning).
XDS Registry logger ned i et logkatalog (styres af installationsscripts). Der skal foretages sikkerhedskopi af logs (applikationslogs og auditlogs).
Krav til hardware
XDS Registry ressourceforbrug (processorkraft og memory) vil afhænge af flere parametre:
- Antallet af samtidige requests
- Størrelsen af payload i requests og response
Deployment
Dette afsnit beskriver deploymentprocessen på Ubuntu 16.04.
Deployment dækker i dette tilfælde over installationen af XDS Registry basissoftwaren og dennes afhængigheder.
Installation af XDS Registry basissoftware og afhængigheder
Dette emne er beskrevet i kapitlerne 4 og 6 i XDS Registry Installation Guide.
Installationsscriptet er lavet til et kunne udføres på en Ubuntu 16.04 instans. Installationsscriptet installerer den nødvendige Apache Tomcat7 servlet container som en Systemd service (dette sker i den leverede playbook tomcat.yml).
Selve XDS Registry installeres og konfigureres via installationsscripts til dette (se rollerne roles/hip-config henholdsvis roles/hip-deploy i pakken med installationsscripts).
Installationsscriptet antager, at XDS Registry war-filen ligger på den host, hvor installationsscriptet køres fra.
En sådan er leveret med sammen med installationsscriptsene i SVN (hip-webapps-registry-1.9.0.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 Registry kan man således påvirke konfigurationen af ved følgende Ansible variable:
| Konfigurationsparameter | Beskrivelse | Defaultværdi |
|---|---|---|
| hip_hostname | Tomcat serverens hostname | |
| hip_service_description | Navn på XDS Registry service | |
| hip_xdb_host | Hostnavn på xDB (master) server | |
| hip_xdb_port | Port for xDB (master) server | |
| hip_xdb_database | Databasenavn for XDS Registry 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 | |
| xdb_tar | Placeringen af xDB basissoftwarepakken | hip-webapps-registry-1.9.0.war |
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 Logback logging provider implementation kan logning i XDS Registry konfigureres ved at levere en logningskonfiguration ind som en logback.xml konfigurationsfil (detaljerne beskrevet i XDS Registry Installation Guide.)
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/registry/logback.xml
SLA log
Til dette formål anvendes access loggen fra Tomcat serveren, der hoster XDS Registry.
Auditlog
Al auditlog foretages i de foranliggende NSP komponenter. For XDS Registrys vedkommende er dette dokumentdelingsservicen (DDS).
Opgradering af komponenter
Ved opgradering af XDS Registry 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 Registry er installeret nedlægges.
Alternativt afinstalleres Apache Tomcat7 serveren.