Платформа Камунда
8.6+gen4
Этот репозиторий содержит ссылки на ресурсы Camunda Platform 8, официальные артефакты выпуска (двоичные файлы) и вспомогательные файлы конфигурации для запуска Docker Compose в качестве варианта локальной разработки.
Мы рекомендуем использовать SaaS или Helm/Kubernetes для разработки.
Дополнительную информацию о самостоятельном управлении, включая дополнительные варианты установки для разработки, см. в нашей документации.
Для производственных настроек мы рекомендуем использовать диаграммы Helm, которые можно найти на сайте helm.camunda.io.
Файл docker-compose в этом репозитории использует последнюю спецификацию Compose, которая была представлена в Docker Compose версии 1.27.0+. Обязательно используйте актуальную версию Docker Compose.
Требуется Docker 20.10.16+.
Для поддержки обновления токена и выхода из системы на вашем локальном компьютере необходимо разрешить
keycloakдо127.0.0.1, а для переменнойKEYCLOAK_HOSTнеобходимо установитьkeycloakв файле.env.
Чтобы развернуть полную самоуправляемую среду Camunda Platform 8 локально, можно использовать файл docker-compose.yaml в этом репозитории.
Полная среда содержит следующие компоненты:
Web Modeler не включен по умолчанию. Пожалуйста, следуйте инструкциям ниже, чтобы установить его.
Клонируйте этот репозиторий и введите следующую команду, чтобы запустить среду:
docker compose up -d
Подождите несколько минут, пока среда запустится и успокоится. Отслеживайте журналы, особенно журнал контейнера Keycloak, чтобы убедиться, что компоненты запущены.
Теперь вы можете перейти к различным веб-приложениям и войти в систему, используя demo пользователя и demo -пароль:
Keycloak используется для управления пользователями. Здесь вы можете войти в систему с пользователем admin и паролем admin
Механизм рабочего процесса Zeebe доступен с использованием gRPC по адресу localhost:26500 .
Чтобы снести всю среду, выполните следующую команду:
docker compose down -v
Zeebe, Operate, Tasklist и Optimize требуют отдельной сети от Identity, как вы увидите в файле docker-compose.
Если Optimize, Identity и Keycloak не нужны, вы можете вместо этого использовать docker-compose-core.yaml, который не включает эти компоненты:
docker compose -f docker-compose-core.yaml up -d
ИЛИ
Установите параметр SEARCH_DB=opensearch в файле .env если вы хотите использовать OpenSearch вместо ElasticSearch.
docker compose -f docker-compose-core.yaml --profile opensearch up -d
В дополнение к настройке локальной среды с помощью Docker Compose используйте Camunda Desktop Modeler для локального моделирования диаграмм BPMN для выполнения и непосредственного развертывания их в локальной среде. Как корпоративный клиент, вы можете использовать Web Modeler.
Обратная связь и обновления приветствуются!
По умолчанию API Zeebe GRPC общедоступен и не требует каких-либо учетных данных клиента для целей разработки.
Однако вы можете включить аутентификацию запросов GRPC в Zeebe, установив для переменной среды ZEEBE_AUTHENTICATION_MODE identity , например, выполнив:
ZEEBE_AUTHENTICATION_MODE=identity docker compose up -d
или изменив значение по умолчанию в файле .env .
Оба файла docker-compose содержат наши готовые коннекторы.
Подробные сведения о том, как предоставить соответствующие шаблоны соединителей для моделирования, см. в руководстве по установке соединителя.
Чтобы внедрить секреты в среду выполнения Connector, их можно добавить в файл connector-secrets.txt внутри репозитория в формате NAME=VALUE для каждой строки. После этого секреты будут доступны в среде выполнения Connector в формате secrets.NAME .
Чтобы добавить пользовательские соединители, создайте новый образ Docker, объединив их, как описано здесь.
Кроме того, вы можете смонтировать новые JAR-файлы соединителя как тома в папку /opt/app , добавив их в файл docker-compose. Имейте в виду, что JAR-файлы соединителя должны содержать все необходимые зависимости внутри JAR.
Профиль kibana доступен в предоставленных файлах создания Docker для поддержки проверки и исследования данных Camunda Platform 8 в Elasticsearch. Его можно включить, добавив --profile kibana в команду создания Docker. Помимо других компонентов, этот профиль раскручивает Кибану. Kibana можно использовать для изучения записей, экспортированных Zeebe в Elasticsearch, или для обнаружения данных в Elasticsearch, используемых другими компонентами (например, Operate).
Вы можете перейти к веб-приложению Kibana и начать изучать данные без учетных данных для входа:
Примечание. Прежде чем вы сможете исследовать данные, вам необходимо настроить шаблоны индексов в Kibana.
- Перейдите в
Management > Stack Management > Kibana > Index Patterns.- Создайте новый шаблон индекса. Например,
zeebe-record-*соответствует экспортированным записям.
- Если вы не видите никаких индексов, сначала обязательно экспортируйте некоторые данные (например, разверните процесс). Индексы записей создаются при экспорте первой записи этого типа.
- Перейдите в
Analytics > Discoverи выберите шаблон индекса.
Desktop Modeler имеет открытый исходный код, его можно использовать бесплатно.
Загрузите Desktop Modeler и начните моделировать формы BPMN, DMN и Camunda на своем локальном компьютере.
Когда вы будете готовы к развертыванию или выполнению процессов, используйте эти настройки для развертывания на локальном экземпляре Zeebe:
Nonehttp://localhost:26500 Если вы включили аутентификацию для запросов GRPC в Zeebe, вам необходимо предоставить учетные данные клиента при развертывании и выполнении процессов:
OAuthhttp://localhost:26500zeebezecrethttp://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/tokenzeebe-api Web Modeler Self-Managed доступен только корпоративным клиентам Camunda.
Образы Docker для Web Modeler доступны в частном реестре. Корпоративные клиенты либо уже имеют учетные данные для этого реестра, либо могут запросить доступ к этому реестру через своего представителя CSM в Камунде.
Чтобы запустить платформу Camunda с самоуправляемым Web Modeler, клонируйте этот репозиторий и введите следующие команды:
$ docker login registry.camunda.cloud
Username: your_username
Password: ******
Login Succeeded
.env и установите параметр SEARCH_DB=elasticserach (значение по умолчанию). $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml up -d
ElasticSearch выполните следующую команду: $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml down -v
Если вы хотите удалить все (включая любые созданные вами данные). В качестве альтернативы, если вы хотите сохранить данные:
$ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml down
Чтобы запустить платформу Camunda с OpenSearch выполните следующие команды:
.env и установите параметр SEARCH_DB=opensearch $ 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
Вы можете получить доступ к самостоятельному управлению Web Modeler и войти в систему с demo пользователя и demo -паролем по адресу http://localhost:8070.
Когда вы будете готовы к развертыванию или выполнению процессов, используйте эти настройки для развертывания на локальном экземпляре Zeebe:
Nonehttp://zeebe:26500 Если вы включили аутентификацию для запросов GRPC в Zeebe, вам необходимо предоставить учетные данные клиента при развертывании и выполнении процессов:
OAuthhttp://zeebe:26500zeebezecrethttp://keycloak:18080/auth/realms/camunda-platform/protocol/openid-connect/tokenzeebe-apiВ установку включен Mailpit в качестве тестового SMTP-сервера. Он фиксирует все электронные письма, отправленные Web Modeler, но не пересылает их фактическим получателям.
Вы можете получить доступ к электронной почте через веб-интерфейс Mailpit по адресу http://localhost:8075.
Отправляя проблему в этот репозиторий, убедитесь, что ваша проблема связана с методом развертывания Docker Compose на платформе Camunda. Все вопросы, касающиеся функциональности веб-приложений, следует задавать на форуме Camunda. Это лучший способ для пользователей запросить существующие ответы, с которыми уже сталкивались другие. На этом форуме также есть категория, посвященная темам, связанным с развертыванием.
При использовании оборудования на базе Arm64, такого как Mac M1 или M2, контейнер Keycloak может не запуститься, поскольку Bitnami предоставляет образы на основе amd64 только для версий <22. Вы можете создать и пометить образ на основе Arm локально, используя следующую команду. После создания и присвоения тегов образу вы можете запустить среду, как описано в разделе «Использование docker-compose».
$ DOCKER_BUILDKIT=0 docker build -t bitnami/keycloak:19.0.3 "https://github.com/camunda/camunda-platform.git#8.2.15:.keycloak/"
Вы можете контролировать доступ к определенным процессам и таблицам решений в Operate и Tasklist с помощью авторизации на основе ресурсов.
Эта функция отключена по умолчанию, но ее можно включить, установив для RESOURCE_AUTHORIZATIONS_ENABLED значение true либо через файл .env , либо через командную строку:
RESOURCE_AUTHORIZATIONS_ENABLED=true docker compose up -d
Вы можете использовать мультитенантность для достижения изоляции на основе арендаторов.
Эта функция отключена по умолчанию, но ее можно включить, установив для MULTI_TENANCY_ENABLED значение true либо через файл .env , либо через командную строку:
ZEEBE_AUTHENICATION_MODE=identity MULTI_TENANCY_ENABLED=true docker compose up -d
Как видно выше, эта функция также требует, чтобы вы использовали identity в качестве поставщика аутентификации.
Убедитесь, что вы настроили удостоверение клиентов после запуска платформы.
Ищете информацию о платформе Camunda 7? Проверьте ссылки ниже:
