¶ Wekan Producer
Микросервис для выгрузки данных из Wekan в Kafka
- Информация по вебхукам, которые присылает wekan на различные действия:
https://github.com/wekan/wekan/wiki/Webhook-data
¶ Сборка
- Через Gitlab CI/CD
-
Перейти в Gitlab репозиторий на вкладку CI/CD и запустить пайплайн на ветку master. При запуске пайплайна необходимо указать переменную RELEASE_VERSION (например, wp-latest)
-
Далее, после того, как пайплайн отработает - на вкладке container registry появится созданный docker-образ.
- Сборка docker образа локально
- Склонировать Gitlab репозиторий на компьютер
- В папке с проектом выполнить команду:
sudo make package
- Локальная сборка из исходников
- Склонировать Gitlab репозиторий на компьютер
- В папке с проектом выполнить команду:
sudo make build
- После того как команда отработает, в папке с проектом появится 2 бинарных файла, интересующий нас - под именем wekan-producer
¶ Запуск
Приложение конфигурируется с помощью файла конфигурации conf.yaml, расположенного в папке configs, или с помощью переменных среды
Описание представлено ниже:
| Переменная | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| WEBHOOK_SERVER_PORT | - | Порт сервера приема вебхуков | 8080 |
| WEBHOOK_SERVER_PATH | - | Путь по которому сервер ждёт вебхук | /event |
| KAFKA_BOOTSTRAP_SERVERS | + | Брокеры Kafka через запятую | localhost:9092 |
| KAFKA_TOPIC | + | Топик Kafka в который будут отправляться сообщения | data-bus.wekan.events |
| KAFKA_LOGIN | + | Логин к Kafka (необходим, если настроена авторизация на Kafka) | - |
| KAFKA_PASSWORD | + | Пароль к Kafka (необходим, если настроена авторизация на Kafka) | - |
- Запуск контейнера, собранного в CI/CD
- Для запуска образа на своей машине нужно выполнить команду:
sudo docker login https://git.miem.hse.ru/300/wekan-producer/container_registry
- После авторизации в интерактивном режиме, можно запускать контейнер, расположенный в gitlab. Конечный путь будет зависеть от значения переменной RELEASE_VERSION, в нашем примере:
https://registry.miem.hse.ru/300/wekan-producer:wp-latest
- Запуск контейнера, собранного локально
- После того как команда
sudo make packageотработает, контейнер с именем wekan-producer:latest будет готов к запуску
Для корректной работы приложения через docker контейнер, необходимо указать ему переменные среды штатными средствами docker (аргумент --env/--env-file, либо создание файла docker-compose, в котором необходимо указать путь до контейнера и необходимые переменные среды)
- Запуск бинарного файла, собранного из исходников
После сборки проекта командойsudo make buildисходный бинарный файл будет готов к запуску. Для конфигурирования параметров необходимо открыть конфигурационный файл (configs/conf.yaml), в котором установлены значения по умолчанию, и установить свои параметры
Далее необходимо просто запустить собранный файл с помощью команды./wekan-producer
¶ Механизм работы
Для работы сервиса необходимо настроить на досках Wekan отправку вебхуков.
-
Это можно сделать через UI - для этого надо зайти в настройки на какую-нибудь свою доску, перейти в раздел Outgoing Webhooks
-
В поле URL вписать адрес, на котором развернут сервис
После чего wekan начнет отправлять вебхуки о событиях на указанный URL, а сервис Wekan Producer записывать их в Kafka
- Или воспользоваться нашей утилитой wekan-webhook
Информация по вебхукам, которые присылает wekan на различные действия по ссылке