Voraussetzungen
Sie benötigen einen laufenden Linux-Server mit installiertem Docker (
Dimensionierung). Um Docker zu installieren, folgen Sie bitte der offiziellen Dokumentation Ihrer Distribution, z. B.:
- Ubuntu: https://docs.docker.com/engine/install/ubuntu/
- Red Hat Enterprise Linux: https://docs.docker.com/engine/install/rhel/
- Das Docker Compose-Plugin ist installiert
- Docker-Version mindestens 20.10.17
- Gültiges TLS-Zertifikat (einschließlich Chain) für HTTPS
Schritt 1 – Installieren Sie das Docker Compose-Plugin
Wenn Sie den folgenden Befehl nicht ausführen können
docker compose
Ihre Installation ist zu alt oder das Compose-Plugin fehlt.
Die offizielle Dokumentation zur Installation von Docker einschließlich des Compose-Plugins ist https://docs.docker.com/engine/install/ Sie können auch Ihre distributionsspezifischen Repositories überprüfen.
Für Ubuntu ist docker compose Teil des Docker-Repositorys, das in den meisten Fällen standardmäßig aktiviert ist.
Sie können es installieren mit:
sudo apt install docker-compose-plugin
Wenn Ihre Distribution kein Paket bereitstellt, können Sie die Docker-Engine per Skript herunterladen.
Schritt 2 – Überprüfen Sie die Servergröße
In jeder größeren Version werden wir zusätzliche erstaunliche Funktionen hinzufügen, aber dies erfordert auch eine Anpassung der Ressourcengröße des Simplifier-Hostsystems.
Bevor Sie das Upgrade planen, informieren Sie sich bitte über die Größenparameter.
Schritt 3 – Vorbereiten des Hostsystems
Optional: Wenn Sie sich nicht sicher sind, welche Pfade auf Ihrem Host aktuell von Ihrem Setup verwendet werden, können Sie mit den folgenden Befehlen alle verwendeten Mounts der aktuell laufenden Container anzeigen:
for contId in `docker ps -q`; do echo "Container Name: " `docker ps -f "id=$contId" | awk '{print $NF}' | grep -v NAMES`; echo "Container Volume: " `docker inspect -f '{{.Config.Volumes}}' $contId`; docker inspect -f '{{ json .Mounts }}' $contId | jq '.[]'; printf "\n"; done
Merken Sie sich den Lautstärkepfad, um ihn anzupassen, bevor Sie auf die Hauptversion aktualisieren.
Schritt 4: Datenbank aktualisieren (nur 6.5/7.0 auf 8.0)
Wenn Sie ein Upgrade von 7.1 auf 8.0 durchführen, können Sie diesen Schritt überspringen.
Simplifier 7.1 führte Änderungen für KeyValue Store- und JSON Store-Plugins ein.
Ab 7.1 verwenden diese Plugins eine relationale Datenbank als Backend.
Standardmäßig wird der Haupt-Simplifier-Datenbankserver für die Plugins verwendet.
Wenn Sie ein anderes Datenbank-Backend verwenden möchten, lesen Sie bitte die ausführliche Dokumentation zum Plugin-Upgrade hier.
In dieser allgemeinen Upgrade-Anleitung wird die Standardkonfiguration erläutert.
Erstellen Sie zunächst eine Sicherung der vorhandenen dateibasierten Backend-Dateien.
Sie sind benannt und befinden sich hier:
${SIMPLIFIER_DATA_DIR}/plugins/jsonStore/jsonStore ${SIMPLIFIER_DATA_DIR}/plugins/keyValueStore/kvstore
Sie müssen einige SQL-Befehle als Root-Benutzer ausführen.
Wenn Sie einen MySQL-Client installiert haben, können Sie ihn verwenden.
Wenn nicht, verbinden Sie sich mit dem laufenden MySQL-Docker-Container und verwenden Sie dessen MySQL-Client:
docker exec -it mysql /bin/sh
Innerhalb des Containers:
mysql -u root -p
Geben Sie das Root-Passwort für MySQL ein (Sie finden es in Ihrer .env-Datei) Es ist notwendig, 2 neue Datenbanken zu erstellen und dem Standardbenutzer die erforderlichen Rechte zu gewähren.
Der Standardbenutzer heißt simplifier.
Führen Sie die folgenden Befehle aus:
CREATE DATABASE simplifier_keyvalue; CREATE DATABASE simplifier_jsonstore; GRANT ALL PRIVILEGES ON `simplifier_keyvalue`.* TO `simplifier`@`%`; GRANT ALL PRIVILEGES ON `simplifier_jsonstore`.* TO `simplifier`@`%`; FLUSH PRIVILEGES;
Beenden Sie den MySQL-Client
\q
Beenden Sie den Docker-Container:
exit
Schritt 5 – Herunterfahren der Simplifier-Instanz
Wechseln Sie in das Verzeichnis, in dem Sie die docker-compose-Datei abgelegt haben.
In diesen Ordner wechseln:
cd docker-compose
Um Simplifier zu beenden, führen Sie
docker compose -f simplifier-standalone.yml down
Schritt 6 – Holen Sie sich die Simplifier-Setup-Dateien
Wechseln Sie in das Verzeichnis, in dem Sie das docker-compose-Repository geklont haben.
Wenn dies nicht /var/lib/simplifier/bin ist, sollten Sie es dorthin verschieben:
mkdir -p /var/lib/simplifier/bin mv docker-compose /var/lib/simplifier/bin/
Wechseln Sie nun in dieses Verzeichnis
cd /var/lib/simplifier/bin/docker-compose
Voraussetzung: simplifier-standalone.yml nicht geändert wird, hat nur die .env-Datei manuelle Einträge. Wenn dies nicht der Fall ist, erstellen Sie auf die gleiche Weise auch ein Backup von simplifier-standalone.yml. Erstellen Sie eine Sicherungskopie Ihrer .env-Datei und Ihrer security.toml-Datei
cp .env ../env_old cp security.toml ../security.toml_old
. Änderungen rückgängig machen:
git restore security.toml git restore .env
Dies kann zu einer Fehlermeldung führen: “Fehler: Pfadspezifikation ‘.env’ stimmte mit keiner Datei(en) überein, die Git bekannt ist”.
Das ist kein Problem, es hängt davon ab, wie alt Ihre Kopie des Projektarchivs ist.
Wenn Sie diesen Fehler erhalten, verwenden Sie bereits eine neuere Version.
Jetzt sollten Sie keine geänderten Dateien mehr haben, die unter Versionskontrolle stehen.
Um dies zu überprüfen, geben Sie
git status
Die Ausgabe sollte ähnlich aussehen wie, aber nicht mehr ein:
On branch release/7.0 Your branch is up to date with 'origin/release/7.0'. nothing to commit, working tree clean
Insbesondere sollte es keinen Teil in der Ausgabe geben wie:
Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git restore <file>..." to discard changes in working directory)
Wenn Sie dies in Ihrer Ausgabe sehen, haben Sie immer noch geänderte Dateien, die nach dieser Meldung aufgelistet werden. Bitte erstellen Sie eine Kopie und stellen Sie diese Dateien wieder her, wie für security.toml und .env beschrieben. Wenn Sie ein erfahrener Git-Benutzer sind, können Sie Ihre Änderungen auch speichern und nach dem Abrufen anwenden. Aktualisieren Sie den Inhalt, und wechseln Sie zum neuen Release-Zweig:
git pull git checkout --track origin/release/8.0
Überprüfen Sie den neuen Inhalt
ls -a
Sie sollten mindestens die folgenden Einträge sehen:
- .env.template
- sicherheit.toml
- simplifier-standalone.yml
- MySQL (Englisch)
.env.template ist eine Vorlagendatei, die die Umgebung in Bezug auf Variablenwerte definiert. Diese Dateien müssen als .env kopiert und geändert werden. Es gibt keine .env mehr im Repository. Dies wird zukünftige Updates erleichtern. security.toml.template definiert Sicherheitseinstellungen, insbesondere TLS-Zertifikate. Es ist optional, aber in den meisten Fällen möchten Sie es verwenden. Dies hat die Sicherheitseinstellungen im Vergleich zur alten Version verbessert. Es gibt keine security.toml mehr. Kopieren Sie die Vorlage, dies erleichtert zukünftige Updates. simplifier-standalone.yml handelt es sich um die docker-compose-Datei, die die notwendigen Dienste definiert. Es definiert die folgenden 8 Dienste:
- mysql: Datenbank-Backend für Simplifier
- Traefik: Reverse-Proxy-Server
- Vereinfacher: Anwendungsserver
- Launchpad: Simplifier Launchpad (neu in 7.1)
- workflow-runtime: Laufzeitmodul für die Workflow-Engine (neu in 8.0)
- workflow-designtime: Designtime-Modul für die Workflow-Engine (neu in 8.0)
- Wachtturm: Automatisierte Updates
- mysqlinit: initiale Datenbankkonfiguration (neu in 7.1/8.0)
In den meisten Fällen können Sie diese Datei unverändert lassen.
Schritt 7 – Vorbereiten der Umgebung
Mit Release 8 gibt es eine Menge neuer Variablen. Es ist einfacher, immer die neue Vorlage zu verwenden und nur die Werte zu übernehmen, anstatt die neuen Variablen zur alten .env-Datei hinzuzufügen. Nach den vorherigen Schritten haben Sie nun eine Kopie Ihrer env-Datei als env_old im übergeordneten Verzeichnis, das aktuelle Verzeichnis hat keine .env-Datei. Bitte überprüfen Sie dies. Erstellen Sie nach der Überprüfung eine Kopie unseres neuen .env.template:
cp .env.template .env
Bearbeiten Sie die neue .env-Datei, stellen Sie sicher, dass Sie Ihre env_old lesen können, z.B. in einem anderen Terminalfenster. Mindestens die ersten drei Variablen müssen geändert werden:
# these 3 variables need to be changed SIMPLIFIER_HOSTNAME=example.simplifier.cloud DB_PASSWORD=MySecret123 DB_ROOT_PASSWORD=MySuperSecret
Diese Variablen müssen den gleichen Wert wie Ihre vorherige Installation haben.
Falls Sie ein Upgrade von 6.5 oder 7.0 durchführen:
Mit 7.1 wurde eine neue Variable hinzugefügt: HOST_DATA_PATH.
Er definiert den Stammpfad für alle permanenten Speicher.
In einer Standardkonfiguration ist dies /var/lib/simplifier.
Wenn Sie einen anderen Pfad verwendet haben, verschieben Sie entweder Ihre Daten nach /var/lib/simplifier, um unserer Empfehlung zu folgen, oder passen Sie diese Variable so an, dass sie auf Ihr Stammverzeichnis verweist, in dem alle anderen Simplifier-Datenverzeichnisse gespeichert sind.
Vorsicht: In den folgenden Eingabeaufforderungen wird /var/lib/simplifier verwendet. Bitte tauschen Sie diesen immer mit Ihrem Root-Standort (dem Wert von HOST_DATA_PATH) aus, wenn Sie einen anderen Pfad verwenden. Jetzt können Sie die .env-Datei speichern und schließen. Das neue Simplier Lanchpad benötigt einen Lagerplatz. Erstellen Sie einen neuen Unterordner in /var/lib/simplifier:
mkdir -p /var/lib/simplifier/launchpad
Um die Einrichtung und Sicherung zu vereinfachen, wurde der Pfad zum Speichern von TLS-Zertifikaten und der Reverse-Proxy-Konfiguration (traefik) geändert und befindet sich nun ebenfalls unter /var/lib/simplifier.
Erstellen Sie ein neues Verzeichnis und verschieben Sie Ihre vorhandenen Dateien dorthin:
mkdir -p /var/lib/simplifier/traefik mv /etc/simplifier/traefik/* /var/lib/simplifier/traefik/
Falls Sie ein Upgrade von 7.1 durchführen:
Stellen Sie sicher, dass HOST_DATA_PATH den gleichen Wert wie in der vorherigen Einrichtung hat.
Vorsicht: In den folgenden Eingabeaufforderungen wird /var/lib/simplifier verwendet. Bitte tauschen Sie diesen immer mit Ihrem Root-Standort (dem Wert von HOST_DATA_PATH) aus, wenn Sie einen anderen Pfad verwenden. Jetzt können Sie die .env-Datei speichern und schließen. Wenn Sie ein Upgrade von 6.5/7.0 auf 7.1 und jetzt auf 8.0 durchgeführt haben, erwarten wir, dass Sie der Anleitung gefolgt sind und Ihre Traefik-Konfiguration nach /var/lib/simplifier/traefik (oder $ {HOST_DATA_PATH}/traefik, um genau zu sein).
Wenn nicht, solltest du das jetzt wirklich ändern.
Weitere Informationen finden Sie im Abschnitt “Vorschau” mit Upgrade-Anweisungen von 6.5/7.0.
Für alle Upgrade-Pfade:
mkdir -p /var/lib/simplifier/workflowRuntime mkdir -p /var/lib/simplifier/workflowDesigntime chown 1000:1000 /var/lib/simplifier/workflowDesigntime
Optional: eine Liste aller env-Variablen mit einer kurzen Beschreibung:
SIMPLIFIER_HOSTNAME
|
Simplifier Hostname, FQDN, ohne Protokoll. Um auf Simplifer zugreifen zu können, muss https://${SIMPLIFIER_HOSTNAME} verwendet werden |
DB_PASSWORD
|
Passwort für die MySQL-Datenbank |
DB_ROOT_PASSWORD
|
Passwort für den MySQL-Root-Benutzer |
DB_NAME
|
Datenbankname für die Simplifier-Datenbank. Wird als Präfix für alle Plugin-/Moduldatenbanken verwendet. |
SIMPLIFIER_VERSION
|
Version von Simplifier, die Sie installieren möchten. Daran sollten Sie nichts ändern. Wenn Sie eine andere Simplifier-Version haben möchten, schauen Sie sich bitte stattdessen den entsprechenden Zweig an |
HOST_DATA_PATH
|
Pfad, in dem alle Daten auf dem Host gespeichert sind. |
PLUGIN-LISTE
|
Liste aller Plugins, die gestartet werden sollen. Technisch gesehen handelt es sich bei der Workflow Engine nicht um ein Plugin, daher wird sie hier nicht erwähnt |
SIMPLIFIER_JVM_HEAP_GB
|
Wie viel Heap-Speicherplatz für Simplier App Server in GB |
DB_PREFIX
|
Legen Sie diesen Wert auf den gleichen Wert wie DB_NAME |
TZ
|
Zeitzone. Wird nur im Workflow-Kontext verwendet |
WF_RT_JVM_HEAP_GB
|
Wie viel Heap-Speicherplatz für Workflow Runtime in GB |
WF_ARCHIVE_ENABLED
|
Informationen zu archivbezogenen Einstellungen finden Sie in dieser Dokumentation. |
WF_ARCHIVE_INTERVAL
|
|
WF_ARCHIVE_MAX_AGE_COMPLETED
|
|
WF_ARCHIVE_TIME
|
|
WF_DT_JVM_HEAP_GB
|
Wie viel Heap-Speicherplatz für Workflow Designtime in GB |
LAUNCHPAD_JVM_HEAP_GB
|
Wie viel Heap-Speicherplatz für Launchpad in GB |
Schritt 8 – JVM-Parameter
Dieser Schritt ist nur notwendig, wenn Sie eine jvm.arg-Datei verwendet haben, um die JVM-Parameter anzupassen, z.B. um den Speicher zu erweitern, den Simplifier verbrauchen darf. Mit dem aktuellen Setup wird der Inhalt der Datei jvm.arg ignoriert. Sie können den zulässigen Speicher anpassen. Ändern Sie dazu den Wert von SIMPLIFIER_JVM_HEAP_GB in Ihrer .env-Datei. Die Zahl bezieht sich auf die Menge an Arbeitsspeicher, die Gigabyte Simplifier App Server verwenden darf. Dies bezieht sich auf den Parameter -Xmx in der Datei jvm.arg. Legen Sie diese Variable auf den Wert fest, den Sie in der Datei jvm.arg definiert haben. Um Irritationen zu vermeiden, empfehlen wir, jvm.arg zu löschen, da es nicht verwendet wird. Wenn einer der anderen Werte in der Datei jvm.arg von der Empfehlung abweicht, die Sie von Customer Success erhalten haben, wenden Sie sich bitte an Customer Success oder erstellen Sie ein Ticket in unserem Support-Portal, um Ihre Einrichtung zu klären.
Schritt 9 – Einrichten von TLS (allgemein als SSL bezeichnet)
Es gab keine Änderungen an der Einrichtung von TLS mit der Version 7.1 oder 8.0.
Wenn Sie bereits über ein Setup verfügen, das auf unserer bereitgestellten Docker-Compose-Vorlage basiert, sind keine Änderungen erforderlich.
Wenn Sie von einem anderen Installationstyp migrieren, befolgen Sie bitte die Schritte 5 und 6, wie hier in unserer Installationsanleitung beschrieben.
Schritt 10 – Starten des Simplifiers
Bisher ist alles vorbereitet und Simplifier kann gestartet werden.
Wechseln Sie zurück zu dem Ordner, in dem Sie die simplifer-standalone.yml Datei gespeichert haben.
Um alle Dienste zu starten, die in der Datei definiert sind, führen Sie Folgendes aus:
docker compose -f simplifier-standalone.yml up -d
Öffnen Sie nun von Ihrem Desktop-Computer aus einen neuen Browser-Tab und navigieren Sie zum Server.
Sie sollten eine einfache Website sehen, auf der Sie aufgefordert werden, eine Simplifer-Lizenz einzufügen.
Kopieren Sie den gesamten Inhalt der Lizenzdatei, die Sie vom Simplifier Customer Success Team erhalten haben, und fügen Sie ihn in das Webformular ein.
Drücken Sie Speichern.
Der Browser leitet Sie nun auf die Simplifier-Anmeldeseite weiter.
Melden Sie sich mit Ihren bekannten Zugangsdaten oder einem externen Login-Anbieter an.
Schritt 11 – Standardinhalt aktualisieren Laden Sie hier den aktuellen Standardinhalt herunter und importieren Sie ihn (Dokumentation).
Denken Sie daran, den Schalter Überschreiben zu aktivieren.
Schritt 12 Wenn Sie überprüft haben, dass alles wie erwartet funktioniert, entfernen Sie Ihre Sicherungsdatei
rm /var/lib/simplifier/env_old