Zum Hauptinhalt springen

Installationshandbuch

Herzlichen Dank, dass Sie sich für die contagt-Produktpalette entschieden haben. Im Folgenden wird erklärt, wie das contagt-System installiert werden kann.

Anpassungen​

Im Installationspaket sind einige wenige Parameter zu konfigurieren. Zum einen enthält der Ordner conf die API-Internen Konfigurationsdateien. In diesen kann das generelle Verhalten der API konfiguriert werden.

Darüber hinaus enthält das Script install.sh die folgenden Parameter:

  • LOG_LEVEL definiert das API-Log Level. 5 = Verbose -> 1 = Error Only
  • LOCAL_PORT_API definiert den Bind-Port der API an den localhost.
  • LOCAL_PORT_API_SNAKEOIL definiert den Bind-Port (SSL) der API an den localhost.
  • LOCAL_PORT_CONTENT_EDITOR definiert den Bind-Port des Content Editors an den localhost.
  • LOCAL_PORT_CONTENT_EDITOR_SNAKEOIL definiert den Bind-Port (SSL) des Content Editors an den localhost.
  • PUBLIC_API_PROTOCOL definiert das öffentliche Protokoll der API. In aktiven Umgebungen sollte hier immer https gewählt werden.
  • PUBLIC_API_URI definiert die lokale URI der API
  • REPLICAS_EDITOR definiert wie viele Instanzen vom Editor über das Swarm Cluster verteilt werden sollen.
  • REPLICAS_API definiert wie viele Instanzen der API über das Swarm Cluster verteilt werden sollen.
  • REPLICAS_JOBS definiert wie viele Instanzen der Jobs-API über das Swarm Cluster verteilt werden sollen.
  • SQL_USER Der Standard MySQL Benutzer
  • SQL_PASSWORD Das Standard MySQL Passwort
  • SQL_HOST Der MySQL Host Qualifier

Installation​

Zuerst muss Docker auf dem System installiert werden, falls dies noch nicht der Fall ist.

Unter Ubuntu/Debian geschieht dies mit:

apt install docker

Danach muss der Docker-Daemon in die contagt-Registry eingeloggt werden, um die Abhängigkeiten herunterladen zu können:

docker login --username=<username> --password=<password> <repo>

Falls Docker frisch installiert wurde, muss Swarm gestartet werden:

docker swarm init

Wenn in Testszenarien keine weiteren Swarm-Features verwendet werden, ist es nicht notwendig weitere Konfigurationen an dieser Stelle vorzunehmen.

Für weitere Informationen siehe: https://docs.docker.com/engine/reference/commandline/swarm_init/

In der Datei install.sh können die lokalen Ports der Instanzen für einen direkten Zugriff angegeben werden, da in Testumgebungen typischerweise kein Loadbalancer im lokalen VLAN zur Verfügung steht.

Jetzt kann das Setup gestartet werden:

./install.sh

Nachdem alle Container gestartet wurden und in den Zustand (healthy) gewechselt sind, ist das System einsatzbereit.

Übersicht​

Sie können den Zustand des Clusters einsehen mit:

docker service ls

Editor​

Der Editor kann danach unter http://localhost:8099 geöffnet werden. Die Standard-Login-Daten lauten admin:admin.

Diese können nach dem Login geändert werden.

Fehlerbehebung​

Sollte beim Import unerwartet ein Fehler aufgetreten sein (z.B. weil Abhängigkeiten nicht schnell genug gebootet haben), kann im ersten Schritt die install.sh noch einmal ausgeführt werden.

Sollte es beim Importieren der Basisdaten zu einem Fehler gekommen sein, müssen folgende Punkte in Betracht gezogen werden:

Zuerst sollten mit docker container stop $(docker container ls -q --filter name=db-installer*) alle Container gestoppt werden.

Danach sollten mit docker service rm $(docker service ls --filter name=db-demo) alle Services entfernt werden.

Danach sollten mit docker rm $(docker ps -a -q --filter name=db-installer*) alle Container gelöscht werden.

docker image ls listet die Images.

Um einen "echten" Clean-Build des Importers zu erzeugen, muss dessen Image gelöscht werden:

docker rmi db-installer_database-importer

docker system prune löscht alle freigegebenen Volumes.

Hiernach kann der Import-Prozess "sauber" neugestartet werden.