Skip to content

Latest commit

 

History

History
253 lines (181 loc) · 12.3 KB

compose.md

File metadata and controls

253 lines (181 loc) · 12.3 KB
Raw

nscale Standard Container mit Docker Compose

In dieser Dokumentation finden Sie Informationen wie Sie nscale mit Docker Compose betreiben können können.
Weitere Information zu Docker Compose finden Sie unter https://docs.docker.com/compose/reference/.

Der Betrieb von nscale Standard Container mit Docker Compose hat folgende Vorteile:

  • sehr einfache Installation im Single-Server-Betrieb
  • ideal für die Entwicklung mit nscale
  • schnelles Erzeugen eines Demo- bzw. Test-Systems

Bitte beachten Sie, dass es sich bei den Konfigurationen in diesem Repository um Beispielkonfigurationen handelt.
Für Produktivsysteme müssen Sie ggf. Anpassungen an den vorliegenden Konfigurationen vornehmen.

Inhalt

Quick Start Guide

Dieses Beispiel berücksichtigt den Betrieb mit Linux.
Wenn Sie mit Windows arbeiten, müssen Sie unter Umständen die Dateipfade aus diesem Beispiel ändern.
Die Ceyoniq Technology GmbH übernimmt keine Gewährleistung und Haftung für die Funktionsfähigkeit, Verfügbarkeit, Stabilität und Zuverlässigkeit von Software von Drittanbietern, die nicht Teil der nscale Standard Container ist.

Stellen Sie vor dem Start der nscale Standard Container mit Docker Compose sicher, dass Sie die folgenden Voraussetzungen erfüllt haben:

  • Sie haben eine lauffähige Docker-Installation (ab Version 20.10.2)
  • Sie haben Docker Compose (ab Version 2.10) installiert
  • Sie besitzen eine gültige Lizenzdatei
  • Sie haben Login-Daten für die Container-Registry ceyoniq.azurecr.io

Starten Sie die nscale Standard Container:

  1. Melden Sie sich mit Ihren Login-Daten bei der Ceyoniq Container Registry ceyoniq.azurecr.io
docker login ceyoniq.azurecr.io
  1. Kopieren Sie Ihre Lizenzdatei license.xml in den Ordner compose/nscale.
  2. Im Ordner compose/nscale kopieren Sie die Datei docker-compose.example.env nach .env.
  3. Führen Sie im Ordner compose/nscale folgende Kommandos aus:
docker compose up -d
  1. Fertig!
    Sie können nun unter http://localhost auf Ihr nscale zugreifen.

Bei der ersten Anmeldung können Sie die Standard-Anmeldedaten verwenden, die beim Start eines neuen nscale Systems automatisch erstellt werden. Ändern Sie diese Anmeldedaten für den Produktivbetrieb umgehend. Die Standard-Anmeldedaten lauten:

User: admin
Password: admin

Grundlagen

Dies ist eine Beispielkonfiguration. Für Produktivsysteme müssen Sie andere angepasste Varianten konfigurieren.

Compose ist ein Werkzeug zur Definition und Ausführung von Multi-Container-Docker-Anwendungen. Mit Compose verwenden Sie eine YAML-Datei, um die Dienste Ihrer Anwendung zu konfigurieren. Sie können dann mit einem einzigen Befehl alle Dienste aus Ihrer Konfiguration starten.

Weitere Informationen zu Docker Compose finden Sie hier: https://docs.docker.com/compose/reference/

Weitere Information zu den nscale Standard Containern finden Sie hier:

Die Ceyoniq Technology GmbH übernimmt keine Gewährleistung und Haftung für die Funktionsfähigkeit, Verfügbarkeit, Stabilität und Zuverlässigkeit von Software von Drittanbietern, die nicht Teil der oben aufgelisteten nscale Standard Container ist. Weiter erfolgt der Einsatz von Software von Drittanbietern wie Loki, Grafana, Prometheus, etc. hier zum Zweck der Darstellung innerhalb einer Beispielkonfiguration.

Container-Registry

Um auf die nscale Standard Container zugreifen zu können, benötigen Sie einen Zugang für die Ceyoniq Container Registry ceyoniq.azurecr.io.
Weitere Informationen erhalten Sie vom Ceyoniq Service.

Um sich bei der Ceyoniq Container Registry anmelden zu können, verwenden Sie Ihren username und Ihr token.

docker login ceyoniq.azurecr.io -u [username] -p [token]

docker compose Beispielszenarien

Im Ordner nscale befinden sich die Basis-Docker Compose-Datei (docker-compose.yml) und andere ergänzende Compose-Dateien. Wenn diese Dateien kombiniert werden, führt das Kommando docker compose up die Dateien zusammen und führt ein Deployment durch. In der Datei docker-compose.example.env finden Sie verschiedene Möglichkeiten, nscale zu betreiben.

Hinweis: Mit dem Überlagern der COMPOSE_PROJECT_NAME Variable können Sie parallel mehrere Installation auf der Grundlage einer geteilten Konfiguration betreiben.

docker-compose.setup.yml
Initialisierung von nscale mit einem default Dokumenten Bereich.

docker-compose.health.yml
Health Check für die Standard nscale Container.

docker-compose.proxy.yml
Diese Konfiguration bietet eine Unterstützung von Traefik (https://docs.traefik.io) als Reverse Proxy.
So können Sie nscale Server Application Layer Web, nscale Server Application Layer und nscale Console über den Port 80 erreichen.

docker-compose.proxy-with-ssl.yml
Diese Konfiguration bietet eine Unterstützung von Traefik (https://docs.traefik.io) als Reverse Proxy und SSL mit Let's Encrypt. So können Sie nscale Server Application Layer Web, nscale Server Application Layer und nscale Console über den Port 443 erreichen. Beachten Sie, dass der Rechner, auf dem Sie nscale installieren wollen, aus dem Internet erreichbar sein muss, um ein Zertifikat zu erhalten.

docker-compose.default-ports.yml
Mit dieser Konfiguration werden alle nscale default Ports freigegeben. Diese Ports sind: 5432 (Postgres), 3005, 8080, 8443, 8090, 8091, 8086, 8087, 8387, 8388, 8192 und 8193.

docker-compose.modeler.yml
In dieser Konfiguration wird nscale Process Automation Modeler verwendet.

docker-compose.pipeliner.yml
In dieser Konfiguration wird nscale Pipeliner verwendet.

docker-compose.connectors.yml
In dieser Konfiguration werden die nscale Konnektoren eingebunden.

docker-compose.analytics.yml
Diese Konfiguration bietet Grafana, Prometheus und Loki Unterstützung.
Für Loki werden Treiber für Docker benötigt, eine Liste dieser Treiber finden Sie unter Log Aggregation.

Weitere Compose-Szenarien
Außerdem haben Sie die Möglichkeit, eigene YAML-Dateien zu erstellen und so eine Konfiguration zu erstellen, die auf Ihre Bedürfnisse abgestimmt ist.

Zugriff mit nscale Administrator

Sie benötigen nscale Administrator ab Version 8.0.5000.

Für den Zugriff mit nscale Administrator auf Ihre nscale-Installation innerhalb Docker Compose steht Ihnen der kein RMS-Modus (RMS = nscale Remote Management Service) zur Verfügung. Erzeugen Sie eine neue Komponenten-Gruppe in nscale Administrator, um den kein RMS-Modus zu verwenden und auf die jeweiligen nscale-Komponenten zugreifen zu können.

Wenn Sie die Konfigurationsdatei docker-compose.proxy.yml verwenden, ist nscale Server Application Layer auf localhost zu erreichen.
Wenn Sie die Konfigurationsdatei docker-compose.default-ports.yml verwenden, ist nscale Server Application Layer zusätzlich auf localhost:8080 zu erreichen.

nscale Pipeliner

Damit Sie nscale Pipeliner verwenden können, muss in der .env-Datei die Konfigurationsdatei docker-compose.pipeliner.yml verwendet werden. In der dort hinterlegten Standardkonfiguration kann nscale Pipeliner nicht starten, sondern muss zuerst konfiguriert werden. Wenn nscale Pipeliner nicht startet, können Sie mit Hilfe dieser Anleitung die Konfiguration von nscale Pipeliner anpassen. Wenn Sie das Kommando docker compose up -d ausführen, können Sie nscale Pipeliner nach einer Konfigurationsänderung neu starten. Anschließend können Sie mit dem Kommando docker compose logs pipeliner überprüfen, ob nscale Pipeliner erfolgreich gestartet wurde.

Weitere Informationen zum Pipeliner: Pipeliner

Log Aggregation mit Loki

Sie können den Loki-Protokollierungstreiber hinzufügen, um Log-Aggregation durch Loki und Grafana verwenden zu können. Verwenden Sie dazu die folgenden Kommandos:

docker plugin install grafana/loki-docker-driver:latest --alias loki --grant-all-permissions

Starten Sie anschließend den Docker-Daemon neu.

Weitere Informationen zu Loki und Grafana im Docker-Umfeld finden Sie unter: https://github.com/grafana/loki/blob/master/docs/sources/clients/docker-driver/_index.md.

Logs exportieren

Die Log-Dateien der einzelnen Komponenten können aus Loki exportiert werden. Dazu ist es notwendig, das Kommandozeilentool LogCLI nachzuinstallieren. Verwenden Sie die folgenden Kommandos:

# Tool installieren
wget https://github.com/grafana/loki/releases/latest/download/logcli-linux-amd64.zip
unzip logcli-linux-amd64.zip
sudo mv logcli-linux-amd64 /usr/local/bin/logcli
rm logcli-linux-amd64.zip

Mit diesem Tool können die Logs der Container abgefragt werden.

# loki Adresse
export LOKI_ADDR=http://localhost:3100/

# Labels anzeigen
logcli labels
logcli labels container_name
# application layer logs
logcli query '{container_name="nscale_application-layer_1"}'
# application layer web Warnungslogs
logcli query '{compose_service="application-layer-web"} |= "WARNING"'
# Logs von einem spezifischen Zeitraum exportieren
logcli query '{compose_service="application-layer"}' --from=2020-12-07T08:06:09Z --to=2020-12-07T12:06:26Z --quiet > /tmp/log.txt

Alternativ können Sie LogCLI mit dem Container grafana/logcli verwenden. Verwenden Sie dazu die folgenden Kommandos:

# verbindet sich mit dem Loki Endpoint im nscale Netzwerk 
# und zeigt die verfügbaren Labels
docker run --rm -it \
--network=nscale_nscale \
--env LOKI_ADDR=http://loki:3100 \
grafana/logcli:master-72b4c01-amd64 \
labels

Prometheus Anbindung

Auch im Container-Betrieb werden die nscale-Komponenten über nscale Monitoring Console überwacht, die als Container in Compose mit gestartet wird. Die Integration der nscale-Komponenten als Ressource wird wie bisher über nscale Administrator verwaltet.

Für Prometheus stehen zwei Endpunkte zur Verfügung. Beide sind über Basic-Auth geschützt und brauchen deshalb ein Kennwort für nscale Monitoring Console. Die Zugangskontenverwaltung ist über nscale Administrator verfügbar.

Der erste Endpunkt liefert Informationen zur nscale Monitoring Console, während der zweite Endpunkt Metriken der eingebundenen nscale-Komponenten als Prometheus Sensoren zur Verfügung stellt.

  • /nscalemc/rest/metrics
  • /nscalemc/rest/metrics/nscale

Limitierungen

Bitte beachten Sie, dass eine Clusterbildung mit Docker Compose nicht möglich ist. Wenn Sie mehrere Maschinen einsetzen wollen, um nscale zu betreiben, empfehlen wir Ihnen den Einsatz in Kubernetes.

Informationen zu weiteren Limitierungen finden Sie hier:
limitation.md

FAQ

Die FAQ finden Sie hier:
faq.md