Shepher — это инструмент для управления ZooKeeper. В компании Xiaomi мы используем его как центр управления конфигурацией.

Особенности

• Визуализация операций с узлами ZooKeeper.
• Управление снимками узлов ZooKeeper.
• Функции Diff и Review для сравнения изменений в узлах ZooKeeper.
• Уведомления по электронной почте об операциях с узлами ZooKeeper.
• Интеграция с CAS и LDAP для аутентификации.
• Система управления правами доступа (см. «Управление правами доступа»).

Сравнение функций с аналогичными продуктами

Скриншоты системы

• Главная страница:

  • Home

• Просмотр узла:

  • Node view

Установка

Требования к среде

• JDK 1.8.
• Maven 3.2+.
• MySQL 5.6.

Базовая конфигурация

• Измените INSERT INTO user VALUES (1,'youradmin',now()); в файле db/init.sql, заменив youradmin на имя пользователя администратора.
• Настройте параметры, следуя указаниям в разделе «Параметры конфигурации». Если вы используете CAS для входа, измените соответствующие настройки CAS и установите server.login.type в значение CAS. Если вы используете LDAP, настройте соответствующие параметры LDAP и установите server.login.type в значение LDAP.

Развёртывание в среде разработки

Развёртывание включает локальную компиляцию и развёртывание с помощью Docker. Пользователи могут выбрать подходящий способ в зависимости от своих предпочтений.

Компиляция

1. Измените параметры конфигурации в файле conf/application-default.properties, следуя указаниям раздела «Параметры конфигурации».
2. Выполните локальную компиляцию:

   $ mvn clean package
   $ cd shepher-packaging/target/shepher-packaging-{version}-bin
   $ ls
   bin/(все сценарии оболочки)
   conf/(файлы конфигурации)
   db/init.sql
   lib(необходимые файлы jar)
   Dockerfile
   docker-compose.yml
   CHANGES.txt
   NOTICE.txt
   README.md
   README-zh.md
   VERSION

Здесь {version} обозначает текущую версию Shepher.

Локальное развёртывание

1. Импортируйте файл db/init.sql в MySQL.
2. Перейдите в каталог установки:

   $ cd shepher-packaging/target/shepher-packaging-{version}-bin
3. Запустите скрипт для запуска службы Shepher:

   $ sh bin/run.sh start
4. Откройте URL http://localhost:8089 или пользовательский server.url (см. раздел «Параметры конфигурации») в браузере.

Развёртывание с использованием Docker

Использование Docker для развёртывания автоматически объединяет MySQL и ZooKeeper и автоматически импортирует db/init.sql в MySQL, что избавляет от необходимости самостоятельной установки.

1. Установите Docker, например, на Ubuntu, установив docker engine и docker-compose.
2. Переместитесь в каталог установки:

   $ cd shepher-packaging/target/shepher-packaging-{version}-bin
3. Запустите сценарий для запуска службы Shepher и дождитесь завершения запуска контейнеров Docker:

   $ sh bin/docker-run.sh start
4. Откройте URL http://localhost:8089 или пользовательский server.url (см. раздел «Параметры конфигурации») в браузере.

Развёртывание в рабочей среде

Процесс развёртывания в рабочей среде похож на локальное развёртывание, но основное внимание уделяется настройке источника данных, CAS/LDAP и доменного имени. Кроме того, поскольку почтовые службы в большинстве компаний закрыты, необходимо реализовать класс CustomMailSender при использовании Shepher в сети и установить mail.sender=customMailSender в shepher-web/src/main/resources/application.properties, чтобы служба Shepher могла использовать почтовую службу.

1. Импортируйте db/init.sql в MySQL.
2. Создайте файл conf/application-online.properties и добавьте или измените настройки, следуя указаниям раздела «Параметры конфигурации».
3. В корневом каталоге Shepher выполните команду:

   $ mvn clean package
4. Скопируйте каталог установки shepher-packaging/target/shepher-packaging-{version}-bin на сервер и перейдите в этот каталог:

   $ cd shepher-packaging/target/shepher-packaging-{version}-bin
5. Выполните следующую команду для запуска Shepher:

   $ sh bin/run.sh -c conf/application.properties,conf/application-online.properties start
6. Откройте URL http://localhost:8089 или пользовательский server.url (см. раздел «Параметры конфигурации») в браузере.

Авторы

Long Xie (@xielong), Jinliang Ou (@oujinliang), Chuanyu Ban (@banchuanyu), Chuyang Wei (@brianway), Peng Zhang (@monsters-peng), Yaoli Liu (@iloayuil)