Introduktion
Formål
Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af EMC® Documentum® xDB Version 10.5.
Der henvises til XDB Manual hvor dette er relevant.
Komponentens afhængigheder, installation og konfiguration er beskrevet i SDS XDB Installationsvejledning.
Driftsvejledningen indeholder supplerende information om EMC® Documentum® xDB Version 10.5 med hensyn til:
- Relaterede services: Afhængighed af andre services (relevant i master-replica setups beskrevet i kapitel 14 i XDB Manual)
- Logfiler: Placering af logfiler
- Overvågning af xDB services
- Genstart of service (hvis komponenten ikke er responsiv)
- Oprettelse af database
- Sletning af database
- Backup
- Genskabelse fra backup
- Udskiftning af licensnøgler
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 | 07.11.2017 | KvalitetsIT | Initiel udgave |
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 |
SLF4J | Facade til Java logning (se https://www.slf4j.org/) |
Daglig drift
Dette afsnit beskriver den daglige drift af systemet.
Relaterede services
xDB er en (XML) database og kræver som sådan ikke tilstedeværelsen for andre service.
Der er mulighed for at starte xDB som en federation med en master server (til servicering af skriveoperationer) og een til flere replica nodes (til servicering af læseoperationer).
En replica server er afhængig af, at master serveren kører, for at den kan fungere.
Logfiler
Som standard loggers til stdout. Dette kan ændres ved at konfiguere en SLF4J opsætning. Se side 286 i XDB Manual.
Installationsscripts skal i så fald udvides med en logningskonfiguration (eksempel er at finde i XDB Manual).
xDB har mulighed for at logge mere detaljeret f.eks. logning af alle indkommende beskeder (requests).
Dette er beskrevet på s. 78 i XDB Manual i afsnittet "RPC tracing". RPC tracing er disabled, men kan slåes til ved at sætte følgende systemparameter
Systemparameter | Beskrivelse | Default |
---|---|---|
XHIVE_RPC_TRACING_ON | Slår RPC tracing til, hvis den sættes = true | false |
XHIVE_RPC_TRACING_MODE | standard eller compact se XDB Manual | standard |
XHIVE_RPC_TRACING_FORMAT | text eller XML se XDB Manual | plain |
Da disse parametre er defineres som Java systemvariable er der mulighed for at sætte dem vha installationsscripts (se SDS XDB Installationsvejledning).
SLA-log konfiguration
Da xDB er en standardkomponent, er der ikke mulig at anvende NSP Util til SLA-logning.
Derimod vil RPC tracing (beskrevet ovenfor) kunne anvendes til dette formål. På s. 80 XDB Manual i afsnittet "Sending RPC trace output to console or file" gennemgås, hvorledes det er muligt at sende RPC output til en fil ved at sætte logning op på JVM niveau.
Eksempel fra output fra RPC tracing:
2009-07-31T15:57:50.262 com.xhive.trace.rpc FINEST thread-1 RemoteSession@15a6029 0 REQUEST_AUTHENTICATE 23 msecs 39 bytes sent 13 bytes received 127.0.0.1:1797 127.0.0.1:1794 primary requestAuthenticate(userName=Administrator,password=******, databaseName=MyDatabase,authSession=true,prechecked=false)
Overvågning af service
Til at kontrollere, om xDB er oppe anbefales det, at opsætte en periodisk test af, om xDB porten er tilgængelig.
Dette kan f.eks. klares vha et værktøj som telnet.
Der kan også opsættes overvågning af xDB Systemd servicen (se SDS XDB Installationsvejledning).
Test af versionsnummer
Dette er ikke muligt for xDB.
Genstart af service
xDB er installeret som en Systemd service (se SDS XDB Installationsvejledning), hvorfor anvendelse af systemctl kan anvendes til dette.
Konfiguration
Servicekonfiguration
Al servicekonfiguration sker via Ansible vha installationsscripts. Se SDS XDB Installationsvejledning for en gennemgang.
Standard fejlsøgning
Det skal tjekkes at afviklingen af Ansible installationsscripts ikke gav anledning til fejl.
xDB service kan gestartes som sædvanlig Systemd service
Krav til backup m.m.
Installationsscripts og konfigurationsfiler skal være under source control (SVN).
Derudover gemmer xDB data på disken. Backup af xDB data er er beskrevet i XDB Manual på s. 262.
- Backup kan foretages på SAN niveau, hvis xDB servicen stoppes imens (beskrevet under offline backup) eller
- ved at anvende de i xDB definerede backup tools (i tilfældet, hvor online backup ønskes). Se siderne 262-263 for en detaljeret beskrivelse af kommandolinjeværktøjerne xdb backup og xdb restore
Eksempel på backup af XDS Registry database
Ved en fuld backup anvendes xds backup kommandoen på følgende måde (stå i kataloget på (master) xdb, hvor xdb.properties findes):
xdb backup --password <superuser-pw> --file <backupfil>
Eksempel på restore af backup af XDS Registry database
Ved restore anvendes xds restore kommandoen på følgende måde (stå i kataloget på (master) xdb som root, hvor xdb.properties findes):
xdb restore --overwrite --file <backupfil> --relative-mapper
Test af restore
For at teste, at en backup kan restores kan følgende gøres. Som før anvendes restore kommandoen, men denne gang udpeges et nyt katalog til at oprette en test-federation udfra backup'en
$ rm -rf /path/to/testdir
$ mkdir /path/to/testdir
$ xdb restore --debug --non-interactive --federation /path/to/testdir/testfederation.bootstrap --file /path/to/backup --relative-mapper
Efterfølgende kan det testes, at den restorede backup er i en konsistent tilstand. Dette gøres også via xdb kommandolinjeværktøjet:
$ xdb check-federation \
-y \
--debug \
--federation /path/to/testdir/testfederation.bootstrap \
--check-domnodes \
--check-pagesowner \
--checkbasic-indexes \
--check-indexes \
--check-adminpages \
--check-segments \
--deadobjects checkfederation.deadobjects.txt \
--password 'the_super_user_password' \
2> checkfederation.stderr.txt > checkfederation.stdout.txt
Dette tjekker, at den restored database ikke er korrupt og, at den er klar til brug. For store databaser kan man udføre de enkelte checks (--check-?) som enkelte skridt.
Udskiftning af licensnøgler
Licensnøgler til xDB er tidsbegrænsede. Der kan rekvireres ny licensnøgle via OpenTexts Support system, så længe gældende licens haves.
For at installere ny licensnøgle skal følgende kommando anvendes:
$./xdb configure-federation --licensekey <licensnøgle> --password <adminpassword> --federation <url til federation> (eksempel på url til federation: xhive://localhost:1235)
Oprettelse af xDB database
Oprettelse af databaser sker som en del af installationen (se SDS XDB Installationsvejledning). Der er leveret Ansible scripts til dette formål - dels til initialisering af selve xDB databasen og dels til installation af den systemd service, der bestyrer selve servicen.
Sletning af xDB database
I forbindelse med oprydning af f.eks. tesmiljøer kan det være nyttigt at slette/reinitialisere en xDB database (i produktion anvendes slettejobs - se: Slette-jobs.
xdb clienten anvendes:
$ xdb --database <databasenavn> --federation <url til federation> (eksempel på url til federation: xhive://localhost:1235)
For XDS registry ligger data her:
$ ./registry/objects
Dette kan slettes med en simle "rm *" (pas på )
For XDS repository ligge data i folderne:
BLOBS og XML
også her kan de slettes med en "rm *"