Руководство пользователя

Управление продуктом производится из веб-интерфейса, находящегося по адресу http://<Ваш IP>:45671 (см. подробнее “Установка CRON manager”).

Вход в систему

Перейдите по адресу http://<Ваш IP>:45671.
В форме авторизации введите логин и пароль, указанные при установке на шаге “Создание учетной записи администратора”:

Главное меню

Главное меню продукта находится в левой части экрана и состоит из следующих разделов:

Информация о текущем пользователе;
Пользователи;
Роли;
Лицензии;
CRON задания;
Результаты выполнения;
Способы оповещения.

Раздел “Информация о текущем пользователе”

Данный раздел позволяет:

выйти из системы;
перейти на страницу редактирования профиля текущего пользователя.

На странице редактирования профиля текущего пользователя имеется возможность изменить логин и email пользователя, сменить пароль текущего пользователя.

Раздел “Пользователи”

Данный раздел позволяет перейти на страницу управления пользователями. На странице управления имеется возможность создать нового пользователя (кнопка “Добавить” сверху страницы), изменить конкретного пользователя (кнопка действия у записи пользователя в таблице, пункт редактировать), удалить конкретного пользователя (кнопка действия у записи пользователя в таблице, пункт удалить).

Создание пользователя:

заполните поля Название (имя пользователя), Электронная почта;
установите пароль для пользователя, введя пароль в поле Пароль;
установите разрешения для пользователя.

Разрешение “Основное” позволяет пользователю входить в панель администрирования и управлять CRON заданиями.

Разрешения из Раздела “Система” отвечают за административные функции такие как управление пользователями, ролями, вложениями.

Раздел “Роли”

Раздел позволяет управлять ролями пользователей. Роли в системе представляют набор разрешений, которые можно одновременно выдать пользователю, присвоив ему роль.

По умолчанию роли в системе не используются и их список пуст.

Раздел “Лицензии”

Раздел содержит список лицензий зависимостей продукта CRON manager.

Раздел “CRON задания”

Данный раздел позволяет управлять периодическими заданиями.

Создание задания

Для создания нового задания нажмите на кнопку “Создать задание” на верхней панели.

Заполните поля:

Название (Ваше название задания, для удобства пользователя);
CRON (crontab - выражение, описывающее периодичность запуска задания подробнее);
Команда (команда которая будет выполнена в интерпретаторе командной строки);
Пользователя (имя пользователя, от имени которого требуется запустить команду);
Максимальное время выполнения (максимальное время, отведенное на выполнение команды. По истечению этого времени команда будет прервана. Если ограничение по времени не трубется, оставьте поле пустым);
Активна (если установлен флаг, тогда команда будет запускаться по расписанию);
Одновременный запуск (если флаг не активен, то команда будет запущена только тогда, когда предыдущий экземпляр команды завершил свою работу);
Описание (описание задания для удобства пользователя).

Список заданий

Список заданий представляет собой таблицу со списком всех заданий, присутствующих в системе. В таблице присутствуют следующие столбцы:

id (уникальный идентификатор задания в системе)
Статус (статус задания)

Галочка означает успешно выполненное задание (успешно выполненным считается задание, завершившееся с нулевым кодом выхода).

Крест означает задание, завершившееся с ошибкой (не нулевой код выхода).

Прочерк означает, что задание еще ни разу не было запущено.

При нажатии на индикатор статуса Вы перейдете к последнему результату выполнения задания (см. Раздел “Результаты выполнения”, подраздел “Просмотр подробной информации о запуске задания”).

Расписание (CRON выражение);
Последний запуск (Дата последнего запуска и завершения задания)
Активность (активирована команда, или нет);
Следующий запуск (Дата следующего запуска задания);
Действия (панель действий, позволяющих изменить и просмотреть задание).

Удаление задания

Нажать на кнопку “View” в столбце “Действия”, затем нажать на кнопку “Удалить задание” на верхней панели.

Ручной запуск задания

Для немедленного ручного запуска задания:

Отметить галочкой задание (перед полем id), нажать на кнопку “Действия” на верхней панели, нажать на пункт “Запустить”.

Прерывание запущенного задания

Для прерывания запущенного задания:

Отметить галочкой задание (перед полем id), нажать на кнопку “Действия” на верхней панели, нажать на пункт “Остановить”.

Удаленный запуск задания

Продукт позволяет запустить задание удаленно, отправив HTTP POST запрос по адресу http://<Ваш IP>:45671/cron/run?token=<Токен задания>.

Токен задания можно найти на странице редактирования задания (Раздел “CRON задания”, столбец “Действия” кнопка “Редактировать”).

Примечание: Если задание должно запускаться удаленно, но не должно запускаться по расписанию, снимите флаг “Активность” у задания.

Раздел “Результаты выполнения”

Раздел содержит список всех запусков заданий с указанием кода выхода, даты запуска, даты завершения заданий.

Поле Pid содержит идентификатор процесса, если задание выполняется в данный момент. Для завершенных заданий данное поле всегда пусто.

Просмотр подробной информации о запуске задания

При нажатии на кнопку “View”, в столбце действия, Вы перейдете на страницу просмотра подробной информации о запуске задания.

Данная страница содержит Информацию о дате запуска, завершения задания, PID, лог задания (вывод комманды в stdout, stderr), а также график использования оперативной памяти и загрузки процессора этим заданием.

Прервать выполнение задания можно, нажав на кнопку “Действия” на верхней панели и выбрав пункт “Остановить”.

Раздел “Способы оповещения”

Данный раздел позволяет настроить оповещения по e-mail или Telegram о заданиях, завершившихся с ошибкой (завершившихся с ненулевым кодом выхода).

Добавление оповещения на e-mail

Убедитесь, что вы правильно настроили переменные окружения MAIL_ при установке продукта (см. “Установка CRON manager”).
Нажмите на кнопку “Создать способ” на верхней панели.

выберите тип E-mail;
Установите флаг Активности;
В поле параметры установите следующее, заменив “<Ваш e-mail>” на ваш e-mail адрес для получения оповещений:

{"to": "<Ваш e-mail>"}

Добавление оповещения в сообщении Telegram

Создайте Telegram бот с помощью @BotFather, скопируйте token бота подробнее;
Узнайте Ваш идентификатор пользователя или группы Telegram.

Пример:

- подключите бота @IDBot
- отправьте боту комманду /getid
- бот пришлет сообщение с Вашим идентификатором

Нажмите на кнопку “Создать способ” на верхней панели.

выберите тип Telegram;
Установите флаг Активности;
В поле параметры установите следующее:

{"to": <ID пользователя / группы>, "token": "<bot token>"}

В поле “token” укажите token вашего Telegram-бота; В поле “to” введите Ваш идентификатор пользователя или группы.

Поддержка

Поддержка пользователей осуществляется по e-mail путем отправки сообщения на адрес mailbox@spheragroup.ru с темой письма “CRON manager. Поддержка”.