Руководтсво администратора/разработчика

Документация

Начало работы

Запуск/настройка


Через интерфейс Workplace

Для запуска/остановки проектов используется панель управления проектами.

Вы можете управлять состоянием сервисов как всего проекта, так и каждого из сервисов проекта.

При редактировании объекта проекта в нижней части находятся кнопки "Остановки" и "Запуска" проекта.

Также для перезапуска сервисов в рамках работающего проекта, вы можете воспользоваться кнопками перезагрузки в верхней части меню:


Через терминал (CLI)

Для запуска сервера Buildbox на выделенном сервере/компьютере необходимо существует набор команда:

buildbox команда опции

команда - операции как с текущим проектом, так и с запущенными сервисами

  • run
  • start
  • stop
  • destroy
  • service

опции - зависят от объекта управления

  • --config -c - идентификатор конфигурации, используемой для запуска.
  • --action -a - операция start/stop (для команды service)
  • --name -n - имя запускаемого сервиса (для команды service)

Внимание! Для команды service существует возможност не указывать --config, если вам необходимо запустить системный сервис, либо сервис, который имеет один экзепляр конфигурации (была создана конфигурация в одном экземпляре). В этом случае происходит сканирование всех конфигурационных файлов на предмет совпадения названия сервиса с указанного в команде в пути файла запуска указанного в конфигурации. В случае нахождения, сервис будет запущен с первым найденных конфигурационным файлом, в котором произошло совпадение.


Через REST-запросы

Через REST API возможно управлять состоянием запущенного проекта/сервиса и осуществлять следущие операции:

  • запуск;
  • остановка;
  • перезапуск.

 

Операции с сервисами

Проект включает в себя набор сервисов, количество которых зависит от выбранных настроект проекта. По-умолчанию, в одном экземпляре стартуют сервисы Database (взаимодействие с базой данных) и Workplace (графический редатор проекта). Также могут быть запущены другие системные сервисы (такие как Proxy, Auth и т.д).

 

Остановка/перезапуск сервиса 

GET http://адрес_сервера/service?action=значение&config=значение&domain=значение&alias=значение

где:

  • адрес_сервиса - адрес вашей хостовой машины (например: http://mysite.com/)
  • action - операция над сервисом (start/stop/reload, соответственно запустить/остановить/перезагрузить)
  • config - идентификатор конфигурации (фактически это название файла в папке с конфигурациями (см.ниже)
  • domain - название домена (для проекта может быть указан как сокращенный путь (например: buildbox) - будет включать все сервисы проекта, или полный (например: buildbox/gui) - конкретный сервис проекта
  • alias - вторую часть имени домена можно указывать отдельно в данном параметре (например: gui)

При созании сервиса создается конфигурационный файл, который автоматически получает имя равное - идентификатор_сервиса.json (например: 2019-03-03T03-46-27Z-40a5c1,json).

Конфигурационные файлы сохраняются в директории /ini и хранят текущие настройки, которые будут обработаны при запуске сервиса. После изменения настроек объекта в Workplace сохраните изменения в конфигурационный файл (нажмите "Сохранить конфигурацию")

В случае запуска дополнительных системных сервисов (например API), настройки которых сохранены в конфигурационном файла проекта, данные настройки будут прочитаны из общего конфигурационного файла проекта.

 

Например

http://mysite.com/service?action=reload&domain=buildbox/gui  - перезапуск сервиса Workplace для проекта Buildbox

http://mysite.com/service?action=reload&domain=buildbox  - перезапуск всех сервисов для проекта buildbox

http://mysite.com/service?action=reload&config=123-123123-1223123-13123  - запуск проекта Buildbox

Обратите внимание! При передачи параметров желательно понимать порядок их применения.

  • Запуск проекта возможен как полностью так и частично (часть сервисов, например только сервис Database), для этого при запуске укажите домен и алиас неоходимого для запуска сервиса (указание конфигурации обязательно только для запуска)
  • Для остановки/перезагрузки сервисов конфигурация указывать необязательно.
  • Если сервис не запущен, то он не может быть перезапущен.