Dieses Repository enthält Links zu Camunda Platform 8-Ressourcen, den offiziellen Release-Artefakten (Binärdateien) und unterstützenden Konfigurationsdateien für die Ausführung von Docker Compose als lokale Entwicklungsoption.
Wir empfehlen die Verwendung von SaaS oder Helm/Kubernetes für die Entwicklung.
Weitere Informationen zu Self-Managed, einschließlich zusätzlicher Entwicklungsinstallationsoptionen, finden Sie in unserer Dokumentation.
Für Produktions-Setups empfehlen wir die Verwendung von Helm-Charts, die unter helm.camunda.io zu finden sind.
Die Docker-Compose-Datei in diesem Repository verwendet die neueste Compose-Spezifikation, die mit Docker Compose Version 1.27.0+ eingeführt wurde. Bitte stellen Sie sicher, dass Sie eine aktuelle Docker-Compose-Version verwenden.
Docker 20.10.16+ ist erforderlich.
Um die Aktualisierung und Abmeldung von Token zu unterstützen, muss Ihr lokaler Computer
keycloak
auf127.0.0.1
auflösen und die VariableKEYCLOAK_HOST
muss in der.env
Datei aufkeycloak
gesetzt sein.
Um eine vollständige Camunda Platform 8 Self-Managed-Umgebung lokal einzurichten, kann die Datei docker-compose.yaml in diesem Repository verwendet werden.
Die vollständige Umgebung enthält diese Komponenten:
Web Modeler ist standardmäßig nicht enthalten. Bitte befolgen Sie die nachstehenden Anweisungen, um es zu installieren.
Klonen Sie dieses Repo und geben Sie den folgenden Befehl aus, um Ihre Umgebung zu starten:
docker compose up -d
Warten Sie einige Minuten, bis die Umgebung anspringt und sich beruhigt. Überwachen Sie die Protokolle, insbesondere das Keycloak-Containerprotokoll, um sicherzustellen, dass die Komponenten gestartet wurden.
Jetzt können Sie zu den verschiedenen Web-Apps navigieren und sich mit der Benutzer demo
und Passwort- demo
anmelden:
Keycloak dient der Benutzerverwaltung. Hier können Sie sich mit dem Benutzer admin
und dem Passwort admin
anmelden
Die Workflow-Engine Zeebe ist über gRPC unter localhost:26500
verfügbar.
Um die gesamte Umgebung herunterzufahren, führen Sie den folgenden Befehl aus:
docker compose down -v
Zeebe, Operate, Tasklist und Optimize erfordern ein von Identity getrenntes Netzwerk, wie Sie in der Docker-Compose-Datei sehen.
Wenn Optimize, Identity und Keycloak nicht benötigt werden, können Sie stattdessen docker-compose-core.yaml verwenden, das diese Komponenten nicht enthält:
docker compose -f docker-compose-core.yaml up -d
ODER
Setzen Sie den Parameter SEARCH_DB=opensearch
in der Datei .env
wenn Sie OpenSearch anstelle von ElasticSearch verwenden möchten
docker compose -f docker-compose-core.yaml --profile opensearch up -d
Zusätzlich zur Einrichtung der lokalen Umgebung mit Docker Compose können Sie den Camunda Desktop Modeler verwenden, um BPMN-Diagramme lokal für die Ausführung zu modellieren und sie direkt in Ihrer lokalen Umgebung bereitzustellen. Als Unternehmenskunde können Sie Web Modeler nutzen.
Feedback und Updates sind willkommen!
Standardmäßig ist die Zeebe GRPC-API öffentlich zugänglich, ohne dass für Entwicklungszwecke Client-Anmeldeinformationen erforderlich sind.
Sie können jedoch die Authentifizierung von GRPC-Anfragen in Zeebe aktivieren, indem Sie die Umgebungsvariable ZEEBE_AUTHENTICATION_MODE
auf identity
setzen, z. B. durch Ausführen von:
ZEEBE_AUTHENTICATION_MODE=identity docker compose up -d
oder durch Ändern des Standardwerts in der .env
Datei.
Beide Docker-Compose-Dateien enthalten unsere sofort einsatzbereiten Connectors.
Einzelheiten zur Bereitstellung der zugehörigen Connector-Vorlagen für die Modellierung finden Sie im Connector-Installationshandbuch.
Um Geheimnisse in die Connector-Laufzeit einzuschleusen, können sie der Datei connector-secrets.txt
im Repository im Format NAME=VALUE
pro Zeile hinzugefügt werden. Die Geheimnisse stehen dann in der Connector-Laufzeit im Format secrets.NAME
zur Verfügung.
Um benutzerdefinierte Connectors hinzuzufügen, erstellen Sie entweder ein neues Docker-Image und bündeln Sie diese wie hier beschrieben.
Alternativ können Sie neue Connector-JARs als Volumes im Ordner /opt/app
bereitstellen, indem Sie diese zur Docker-Compose-Datei hinzufügen. Beachten Sie, dass die Connector-JARs alle notwendigen Abhängigkeiten innerhalb der JAR mitbringen müssen.
In den bereitgestellten Docker-Compose-Dateien ist ein kibana
-Profil verfügbar, um die Inspektion und Erkundung der Camunda Platform 8-Daten in Elasticsearch zu unterstützen. Es kann aktiviert werden, indem Sie --profile kibana
zu Ihrem Docker-Compose-Befehl hinzufügen. Zusätzlich zu den anderen Komponenten startet dieses Profil Kibana. Kibana kann verwendet werden, um die von Zeebe in Elasticsearch exportierten Datensätze zu durchsuchen oder um die Daten in Elasticsearch zu ermitteln, die von den anderen Komponenten (z. B. Operate) verwendet werden.
Sie können zur Kibana-Web-App navigieren und mit der Erkundung der Daten ohne Anmeldeinformationen beginnen:
Hinweis: Sie müssen die Indexmuster in Kibana konfigurieren, bevor Sie die Daten untersuchen können.
- Gehen Sie zu
Management > Stack Management > Kibana > Index Patterns
.- Erstellen Sie ein neues Indexmuster. Beispielsweise stimmt
zeebe-record-*
mit den exportierten Datensätzen überein.
- Wenn Sie keine Indizes sehen, exportieren Sie unbedingt zuerst einige Daten (z. B. stellen Sie einen Prozess bereit). Die Indizes der Datensätze werden erstellt, wenn der erste Datensatz dieses Typs exportiert wird.
- Gehen Sie zu
Analytics > Discover
und wählen Sie das Indexmuster aus.
Der Desktop Modeler ist Open Source und kann kostenlos verwendet werden.
Laden Sie den Desktop Modeler herunter und beginnen Sie mit der Modellierung von BPMN, DMN und Camunda Forms auf Ihrem lokalen Computer.
Sobald Sie bereit sind, Prozesse bereitzustellen oder auszuführen, verwenden Sie diese Einstellungen, um sie auf der lokalen Zeebe-Instanz bereitzustellen:
None
http://localhost:26500
Wenn Sie die Authentifizierung für GRPC-Anfragen auf Zeebe aktiviert haben, müssen Sie beim Bereitstellen und Ausführen von Prozessen Client-Anmeldeinformationen angeben:
OAuth
http://localhost:26500
zeebe
zecret
http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token
zeebe-api
Web Modeler Self-Managed ist nur für Camunda-Unternehmenskunden verfügbar.
Die Docker-Images für Web Modeler sind in einer privaten Registry verfügbar. Unternehmenskunden verfügen entweder bereits über Anmeldeinformationen für dieses Register oder können über ihren CSM-Kontakt bei Camunda Zugriff auf dieses Register anfordern.
Um Camunda Platform mit Web Modeler Self-Managed auszuführen, klonen Sie dieses Repo und geben Sie die folgenden Befehle aus:
$ docker login registry.camunda.cloud
Username: your_username
Password: ******
Login Succeeded
.env
Datei und legen Sie den Parameter SEARCH_DB=elasticserach
fest (dieser Standardwert). $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml up -d
ElasticSearch
herunterzufahren, führen Sie den folgenden Befehl aus $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml down -v
Wenn Sie alles löschen möchten (einschließlich aller von Ihnen erstellten Daten). Alternativ, wenn Sie die Daten weiterhin ausführen möchten:
$ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml down
Um Camunda Platform mit OpenSearch
auszuführen, führen Sie diese Befehle aus
.env
Datei und legen Sie den Parameter SEARCH_DB=opensearch
fest $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml --profile opensearch up -d
$ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml --profile opensearch down -v
Sie können auf Web Modeler Self-Managed zugreifen und sich mit der demo
und Passwort- demo
unter http://localhost:8070 anmelden.
Sobald Sie bereit sind, Prozesse bereitzustellen oder auszuführen, verwenden Sie diese Einstellungen, um sie auf der lokalen Zeebe-Instanz bereitzustellen:
None
http://zeebe:26500
Wenn Sie die Authentifizierung für GRPC-Anfragen auf Zeebe aktiviert haben, müssen Sie beim Bereitstellen und Ausführen von Prozessen Client-Anmeldeinformationen angeben:
OAuth
http://zeebe:26500
zeebe
zecret
http://keycloak:18080/auth/realms/camunda-platform/protocol/openid-connect/token
zeebe-api
Das Setup umfasst Mailpit als Test-SMTP-Server. Es erfasst alle vom Web Modeler versendeten E-Mails, leitet diese jedoch nicht an die tatsächlichen Empfänger weiter.
Sie können auf E-Mails in der Web-Benutzeroberfläche von Mailpit unter http://localhost:8075 zugreifen.
Wenn Sie ein Problem in diesem Repository einreichen, stellen Sie bitte sicher, dass Ihr Problem mit der Docker-Compose-Bereitstellungsmethode der Camunda-Plattform zusammenhängt. Alle Fragen zur Funktionalität der Webanwendungen sollten stattdessen im Camunda-Forum gestellt werden. Dies ist die beste Möglichkeit für Benutzer, nach vorhandenen Antworten zu suchen, auf die andere bereits gestoßen sind. Wir haben in diesem Forum auch eine Kategorie speziell für einsatzbezogene Themen.
Bei Verwendung von arm64-basierter Hardware wie einem M1- oder M2-Mac startet der Keycloak-Container möglicherweise nicht, da Bitnami nur amd64-basierte Images für Versionen < 22 bereitstellt. Mit dem folgenden Befehl können Sie ein arm-basiertes Image lokal erstellen und markieren. Nachdem Sie das Image erstellt und mit Tags versehen haben, können Sie die Umgebung wie unter „Verwenden von Docker-Compose“ beschrieben starten.
$ DOCKER_BUILDKIT=0 docker build -t bitnami/keycloak:19.0.3 "https://github.com/camunda/camunda-platform.git#8.2.15:.keycloak/"
Sie können den Zugriff auf bestimmte Prozesse und Entscheidungstabellen in Operate und Tasklist mit ressourcenbasierter Autorisierung steuern.
Diese Funktion ist standardmäßig deaktiviert und kann aktiviert werden, indem RESOURCE_AUTHORIZATIONS_ENABLED
entweder über die .env
Datei oder über die Befehlszeile auf true
gesetzt wird:
RESOURCE_AUTHORIZATIONS_ENABLED=true docker compose up -d
Mithilfe der Mandantenfähigkeit können Sie eine mandantenbasierte Isolierung erreichen.
Diese Funktion ist standardmäßig deaktiviert und kann aktiviert werden, indem MULTI_TENANCY_ENABLED
entweder über die .env
Datei oder über die Befehlszeile auf true
gesetzt wird:
ZEEBE_AUTHENICATION_MODE=identity MULTI_TENANCY_ENABLED=true docker compose up -d
Wie oben gezeigt, erfordert die Funktion auch die Verwendung identity
als Authentifizierungsanbieter.
Stellen Sie sicher, dass Sie nach dem Start der Plattform Mandanten in der Identität einrichten.
Suchen Sie Informationen zu Camunda Platform 7? Schauen Sie sich die folgenden Links an: