1       Introduktion

1.1           Formål

Formålet med dette dokument er at beskrive hvordan installations- og konfigurationsscripts til OpenText XDS Registry kan vedligeholdes og videreudvikles.


1.2           Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for xDB. Denne er tilgængelig her: OpenText XDS Registry.

1.3           Læsevejledning

Læser forventes at have kendskab til Ansible scripting sproget.

Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for installations- og konfigurationsscripts.

1.4           Dokumenthistorik



Version

Dato

Ansvarlig

Beskrivelse





1.5           Definitioner og referencer

Definition

Beskrivelse



2       Introduktion til installations- og konfigurationsscripts for XDS Registry

Scripts til installation og konfiguration af standardkomponenten xDB fra OpenText er implementeret i Ansible.

Scriptenes ansvar er fokuseret på installation og konfiguration af komponenten. Byg og pakning af basissoftwaren ligger udenfor dette, men en vejledning hertil kan findes i dokumentationen: OpenText XDS Registry.

Afviklingen af scriptsene danner basis for beskrivelserne i dokumenterne SDS XDS Registry Installationsvejledning og SDS XDS Registry Driftsvejledning.

3       Opsætning af udviklingsmiljø

I det følgende antages at koden er hentet ned fra nspop SVN.

3.1           Krav til software

For at kunne afvikle installations- og konfigurationsscriptsene kræves Ansible version 2.2+.


4       Afvikling af scripts

Der henvises til installationsvejledningen  SDS XDS Registry Installationsvejledning for nærmere instrukser.

4.1           Udviklers workstation

Under arbejdet med installations- og konfigurationsscripts kan det være en fordel løbende at afvikle dem mod en lokal virtuel maskine (se f.eks Download VirtualBox for Linux Hosts for at få en lokal Ubuntu instans).

5       Beskrivelse af systemdesign

Installations- og konfigurationsscripts er bygge op vha en rolle (se f.eks. Creating Reusable Playbooks).

Dette er valgt for at øge genbrugeligheden henover miljøerne. En konkret playbook kæder den genbrugelige rolle sammen med miljøspecifikke variable i inventories (se Variables Defined in Inventory).


6        Beskrivelse af kildekodens strukturering og design

6.1           Kodestrukturering

Kildekoden er bygget op efter standard Ansible praksis. Bemærk at nedenstående er det udsnit af installations- og konfigurationsscripts, der angår XDS Registry. Installationsscripts til xDB og XDS Repository ligger i samme SVN, men disse beskrives andetsteds.

ansible

├── inventories

│   ├── aws

│   ├── first-repository

│   ├── group_vars

│   │   ├── all

│   │   ├── local

│   │   ├── tomcat

│   │   └── udv

│   ├── host_vars

│   │   ├── local-xdb-registry-replica1

│   │   ├── local-xdb-repository-replica1

│   │   ├── udv-aws

│   │   └── udv-xds

│   ├── staging

│   └── udv

├── roles

│   ├── hip-config

│   │   ├── defaults

│   │   │   └── main.yml

│   │   ├── tasks

│   │   │   └── main.yml

│   │   └── templates

│   │       ├── registry

│   │       │   ├── hip.env

│   │       │   ├── hip-ppic-mapping.properties

│   │       │   ├── logback.xml

│   │       │   ├── README

│   │       │   ├── registry-config.xml

│   │       │   ├── registry-context-extension.xml

│   │       │   ├── registry.properties

│   │       │   ├── server.xml

│   │       │   ├── serviceKeystore.properties

│   │       │   └── ws-policy.xml

│   ├── hip-deploy

│   │   ├── defaults

│   │   │   └── main.yml

│   │   └── tasks

│   │       └── main.yml

├── site-prod.yml

├── site-udv.yml

├── tomcat.yml

├── xds-registry.yml

└── xds-repository.yml

6.2      Generelt design af Installations- og konfigurationsscripts

En forudsætning for afviklingen af XDS Registry er installationen af en passende servlet engine. Efter anbefalingerne fra OpenText er dette implementeret som en playbook tomcat.yml, der installerer en Tomcat server som en systemd service og konfigureres i henhold til anbefalingerne i OpenText XDS Registry.

Rollerne hip-config og hip-deploy indeholder det, der skal til for at installere hhv konfigurere et XDS Registry.

hip-config opretter konfigurationsfoldere på target host og opretter passende konfigurationsfiler i henhold til konfigurationen. Dette kan ses i playbook xds-registry.yml, der anvender rollen under hensyntagen til en mængde konfigurationsvariable.

Rollen hip-deploy sørger for at deploy standardsoftwaren på en eksisternde tomcat servlet engine.


7       Beskrivelse af testsetup

Test af scripts foregår via driften, der tester det mod testmiljø. Hvis en afvikling af scriptet giver anledning til fejl, vil Ansible rapportere dette.

  • No labels