Описание

Менеджер Управления Конфигурацией (МУК) – сервис, предназначенный для обновления серверов SetCentrum, SetRetail и касс (клавиатурные, SetTouch, SCO, CSI K).

МУК входит в состав серверной части SetCentrum/SetRetail.

Функциональность и возможности

• Использование собственного веб-приложения для обновления компонентов продукта.
• Управление обновление через любой веб-браузер: Google Chrome, Microsoft Edge, Mozilla Firefox, Opera, Safari.
• Обеспечение пользователя информацией о текущей версии серверов и касс.
• Централизованное обновление версии серверов и касс.
• Возможность проведения удаленного обновления.
• Возможность проведения отложенного по времени обновления. Например: планирование автоматического обновления на часы, в зависимости от наименьшей загрузки кассового узла.
• Полностью контролируемый процесс обновления.
• Автоматизированная проверка первого запуска компонентов системы.
• Полноценный откат к предыдущей версии с уведомлением пользователя в случае проблем при обновлении (например: обрыв связи).
• Удаленная перезагрузка кассового узла (начиная с версии 10.3.27.0).

Вход на страницу МУК

1. Наберите в браузере адрес в формате http://IP-адрес сервера SetRetail10:8092 → нажмите Enter.

2. Введите данные для входа → нажмите клавишу Enter.

• Учетная запись по умолчанию:
  • Имя пользователя: manager
  • Пароль: password

3. Откроется страница МУК с сервером и кассами.

Интерфейс

Основные элементы управления на странице

Статусы касс и сервера

Столбцы списка

Фильтры поиска касс

Форма управления обновлением

Функциональность	Описание
Версия	Выбирается версия, на которую будет обновлен сервер или касса. После подкладывания патчей в папку обновления ../acm/updates МУК производит валидацию целостности патча. Если CRC, архив "битый" или файл патча пустой, то он не появится в списке обновлений
Загрузить изменения прямо сейчас	Загрузить и обновить кассу/сервер сразу после нажатия на кнопку .
Загрузить изменение по расписанию	Запланировать обновление по расписанию.
Создать резервную копию баз данных при обновлении	Если база данных сервера достаточно объемна, то данная функциональность позволит сэкономить время при его обновлении, так как в этом случае будут выполнены только обновления основных компонентов SetRetail10: базы данных и программные файлы. При этом в случае неудачи, произойдет откат базы данных и программных файлов на предыдущую версию.
Автоматически обновить кассы, если она простаивает	Сократить время на обновление касс, за которыми не работают кассиры, можно с помощью данной опции. Обновление неактивной кассы произойдет автоматически.

Окно состояния кассы

Также можно скопировать или сохранить текст ошибки для отправки в службу поддержки.

Служба МУК

Служба МУК устанавливается вместе с сервером SetRetail/SetCentrum.

Управление службой МУК

Windows

В оснастке служб Windows за МУК отвечает сервис SETv10 Configuration Manager.

Linux

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

• service SCM_SVC start - запустить службу МУК.
• service SCM_SVC stop - остановить службу МУК.
• service SCM_SVC restart - перезапустить службу МУК.

Файловая структура 

Папка МУК

Windows: {Disk}\{SetRetail10}\acm

Linux

Windows: /var/lib/jboss/acm

Назначение папок и файлов

Папка/файл	Описание
backups	Папка для резервных копий файлов и папок сервера Резервная копия баз данных сохраняется только при установленном флажке Создать резервную копию баз данных при обновлении.
bin	Системные файлы службы МУК.
conf	Конфигурационные файлы.
history	Файлы статусов обновлений.
logs	Логирование событий работы службы и обновлений.
script_after_update	Папка для обработки SQL-скриптов обновления баз данных PostgreSQL.
script_for_revert	Папка для обработки SQL-скриптов отката баз данных PostgreSQL.
updates	Папка для обновлений (файлов патчей).
web	Папка страниц веб-версии МУК.
mook.jar	Приложение службы МУК.
updater.jar	Приложение службы МУК для процесса обновления.
update.status	Статус работы службы МУК. Файл может быть пересоздан после перезапуска службы. Список статусов: BACKUP_DB – выполнение процесса резервного копирования баз данных; BACKUP_FILES – выполнение процесса резервного копирования файлов; DOWNGRADE_ERROR – ошибка отката версии, откат к текущей версии произвести не удалось; DOWNGRADE_RUNNING – идет процесс отката версии; IN_WORK – сервер/касса работает; TEST_UPDATE – проверка работоспособности сервера/кассы после обновления; UNZIP – распаковка файлов; UPDATE_FILES – обновление файлов; UPDATE_RUNNING – производится обновление; UPGRADE_ERROR – ошибка обновления, откат произвести не удалось; UPGRADE_ERROR_WITH_DOWNGRADE – ошибка обновления или отката версии, удалось произвести откат к текущей версии; WAIT – ожидание (не запущено обновление на сервере); WAIT_CASH_FOR_REBOOT – ожидание перезагрузки кассы.
topology.structure	Данные по топологии. Файл может быть пересоздан после перезапуска службы. Пример файла: #Thu May 20 22:32:25 MSK 2021 status=UPDATE_RUNNING patches=retail_10.2.98.0_10.2.98.1 shiftMustBeClosed=false makeDBBackup=false

Обновление

Загрузка патчей

Для загрузки патчей перейдите в раздел портала поддержки.

Копирование патчей в папку МУК

Скопируйте патчи сервера и касс в папку для обновления на сервер SetCentrum/SetRetail.

Windows: {Disk}\{SetRetail10}\acm\updates

Linux: /var/lib/jboss/acm/updates

Патчи для SetCentrum

Структура файлов патчей

Подготовка к обновлению и рекомендации

Перед обновлением

Обновление сервера

1. Установите флажок  → кликните .

2. Выберите версию, на которую требуется обновить сервер → установите переключатель , в зависимости от того когда требуется произвести обновление, а также флажок , если требуется создать резервную копию баз данных (Внимание! Резервное копирование баз данных сервера может занять продолжительное время) → кликните.

3. Появится надпись о планировании обновления. Если по каким-либо причинам, обновление не должно проводится, тогда кликните по ссылке Отменить.

4. Служба МУК сервера, как правило перезапускается, и появляется соответствующее сообщение. Не закрывайте окно браузера и дождитесь её перезапуска.

5. После того, как служба МУК перезапущена, появится соответствующий статус.

6. Начнутся процессы разархивирования и сохранения текущих настроек сервера.

7. Во время применения обновления, если патчей несколько, в столбце Текущая версия будет происходить смена номеров версий сервера.

8. После того как сервер обновлен, будет произведен тестовый запуск.

9. Если тестовый запуск прошел успешно, номер версии сервера изменится на новую.

10. Также для просмотра состояния сервера можно кликнуть по его названию.

Обновление касс

1. Установите флажок  напротив требуемых касс → кликните .

2. Выберите версию, на которую требуется обновить кассы → установите переключатель , в зависимости от того когда требуется произвести обновление, а также флажок , если требуется создать резервную копию баз данных (Внимание! Резервное копирование баз данных сервера может занять продолжительное время), или обновить кассы, если на них никто не работает → кликните.

3. Появится надпись о планировании обновления. Если по каким-либо причинам, обновление не должно проводится, тогда кликните по ссылке Отменить.

4. Начнется загрузка файлов на кассы.

5. Обратите внимание, что после загрузки файлов, будет перезапущена служба МУК на кассе, или она сама. В это время значки будут отображать недоступность кассы и кассовой службы МУК.

6. Начнутся процессы разархивирования и сохранения текущих настроек касс.

7. После того, как произойдет разархивирование патча, нужно перезагрузить кассы для применения обновления, если не был установлен флажок Автоматически обновить кассы, если они простаивают.

Во время применения обновления, если патчей несколько, в столбце Текущая версия будет происходить смена номеров версий сервера.

8. В случае успешного обновления касса изменит номер версии на последний.

9. То же самое произойдет и с остальными кассами.

10. Также для просмотра состояния кассы можно кликнуть по её названию.

Откат

Если по каким-либо причинам, необходимо вернуться к предыдущей версии конфигурации, следует проделать те же шаги, что и на стадии обновления, заведомо указав предыдущую версию сервера или кассы.

Пример отката кассы:

1. Установите флажок  напротив требуемых касс или сервера → кликните .

2. Выберите версию, на которую требуется откатить кассы → установите переключатель , в зависимости от того когда требуется произвести откат, а также флажок , если требуется создать резервную копию баз данных (Внимание! Резервное копирование баз данных сервера может занять продолжительное время), или откатить кассы, если на них никто не работает → кликните.

3. Появится надпись о планировании обновления отката на предыдущую версию. Если по каким-либо причинам обновление отката не должно проводиться, тогда кликните по ссылке Отменить.

4. Начнутся процессы разархивирования и сохранения текущих настроек касс.

5. В случае с кассой, после того, как произойдет разархивирование патча, нужно перезагрузить кассы для применения обновления отката, если не был установлен флажок Автоматически обновить кассы, если они простаивают.

Во время применения обновления отката, если патчей несколько, в столбце Текущая версия будет происходить смена номеров версий сервера.

6. Произойдет сохранение текущих настроек кассы или сервера.

7. Произойдет тестовый запуск после процесса отката.

8. Версия изменит номер на предыдущий.

Перезагрузка касс

1. Отметьте кассы или несколько узлов, которые требуется перезагрузить → кликните → выберите Дополнительная перезагрузка.

2. Выберите один из двух вариантов перезагрузки → кликните ВЫПОЛНИТЬ.

Перезагрузка кассы в момент простоя - касса будет перезагружена, когда кассир на ней не работает.

3. Перезагрузить по расписанию - касса будет перезагружена в определенный момент времени в независимости от того, работает на ней кассир или нет.

Дополнительная функциональность

Сохранить список касс в csv-файл 

1. Кликните  → в диалоговом окне кликните Сохранить (Save).

2. Откройте файл, например с помощью Microsoft Excel.

Изменить пароль входа на страницу МУК

1. Откройте на сервере в любом текстовом редакторе файле application.properties.

Windows: {Disk}\{Папка SetRetail}\acm\conf\application.properties.

Linux: /var/lib/jboss/acm/conf/application.properties.

2. Измените логин и пароль для следующих параметров → сохраните файл.

• http_user - логин пользователя для входа в МУК. Только английский алфавит или дополнительные символы.
• http_pass - пароль пользователя для входа в МУК. Только английский алфавит или дополнительные символы.

3. Для применения изменения логина и пароля перезапустите службу МУК.

Windows:

Linux:

service SCM_SVC restart

Дополнительные параметры для обновления крупных торговых сетей и настройке конфигурации scm.settings

Файл конфигурации находится в папке /var/lib/jboss/acm/scm.settings

Содержание файла:

Централизованная доставка файлов патчей

Планирование обновлений

Начиная с версии 10.2.44.0 есть возможность выполнять запланированные обновления магазинов и касс.

1. При переключении на обновление к требуемой версии установите флажок  напротив требуемых касс или сервера → кликните .

2. Выберите пункт Загрузить обновление по расписанию → выберите дату, введите время → кликните  → кликните 

3. Появится надпись о том, что обновление запланировано. 

В назначенное время служба МУК его запустит.

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

Появится статус Обновление было отменено.

Целостность патчей

Описание технических процессов работы МУК

Какие скрипты и процессы выполняет МУК в процессе обновления?

• SH/BAT скрипты;
• копирование файлов;
• выполнение *.sql скриптов;
• обновление *.xml файлов
• обновление *.properties файлов;
• выполнение исполняемых *.jar файлов;
• запуск/перезапуск служб: JBOSS, SVC_SCM, nginx.

Процесс работы МУК на кассе

Кассовый МУК состоит из 2-х частей:

• jar-файлы мониторинга: /home/tc/crystal-cash/modules/ccm/*.jar 
• приложения МУК для обновления /home/tc/crystal-conf/updater.jar

1. Кассовая часть постоянно опрашивает (раз в минуту) сервер на предмет наличия патчей.
2. При наличии патчей, сервер в определенный момент отвечает ей, и передает этот список, касса начинает работу.

Далее следует алгоритм работы обновления по статусам:

1. UPGRADE_PLANING - обновление запланировано, проставляется на сервере для кассы и держится, пока касса в следующий раз не обратилась за списком патчей.
2. UPGRADE_DOWNLOADING - проставляется кассовой частью МУКа, пока все патчи скачиваются на кассу (делается это автоматически при работающей кассе).
3. UNZIP_FILES - разархивирование патчей.
4. UPGRADE_WAIT_FOR_REBOOT - касса скачала все необходимое и приготовилась обновляться, для этого необходим перезапуск кассового модуля.
5. CCM_UPDATE_RESTART - далее следует алгоритм работы МУКа: если в любом патче списка обновления есть новый МУК, то обновляться касса будем именно им. Для этого новый МУК подкладывается взамен старого и необходим технический рестарт обновления. Именно для этого процесса и нужен данный статус.
6. CHECK_PERMISSIONS - проверяется папка и файлы кассы, которая будет обновляться.
7. BACKUP - выполняется полный бэкап, если установлен флажок (файлы в папке кассы, МУК, база данных). Запаковывается в архив в crystal-conf/backups. Если файл резервной копии создался, то он рабочий на 100%. Хранится последние 10 бэкапов.
   1. Если произошла ошибка до этого момента, то отката не будет, так как с кассой еще ничего не сделали, при ошибке в последующих шагах, будет выполнен быстрый откат.
8. APPLY_PATCH - выполнение патчей.
9. TEST_START - после того как все патчи успешно завершились запускаем кассу и убеждаемся, что касса запустилась (проставляется этот статус, когда кассовая часть поднимется вместе с кассой, она проставит IN_WORK, если в конечном итоге запустилась). Таким образом первая проверка, что касса запускается после обновления.
10. FAST_REVERT - если в процессе обновления произошли ошибки или тестовый запуск не удался, то проставляется этот статус и начинается быстрый откат. Происходит восстановление из бэкапа (базу данных, файлы, настройки так как еще ничего не успело поменяться).
11. UPGRADE_ERROR_WITH_DOWNGRADE - этот статус стоит у кассы в штатном режиме, когда не удалось обновиться, статус выделен в отдельный, чтобы на визуализации была информация о неудачном обновлении, но касса в обычном работоспособном состоянии.
12. IN_WORK - обычное штатное состояние кассы

Процесс работы МУК на сервере

Серверный МУК чуть посложней и состоит из 3-х частей:

• Сервер для всех клиентов, который собственно раздает обновления и работает с визуализацией ../acm/mook.jar.
• Приложение для обновления сервера. Независимый jar-клиент ../acm/updater.jar.
• Специальный bean в классе ServerStartupListener - служит для того, чтобы как только сервер поднялся - он проверил статус обновления и поменял его (если нужно) с TEST_START на IN_WORK. Так сервер сам решает, что он запустиелся.

На сервере нет функциональности по опросу обновлений как в кассе, так как оба сервиса установлены на одном сервере. При переключении и подтверждении обновления на новую версию, mook.jar меняет содержимое файла update.status сервера и перезапускает службу сервера, далее сервер сам себя обновляет по алгоритму, описанному в кассе (у всех клиентов МУКа единый алгоритм обновления).

Дозагрузка патчей кассы в случае обрыва связи

В случае обрыва связи с сервером при копировании патчей кассой при копировании необходимо реализована автоматическую докачка оставшихся файлов обновления, включая перезапись файла на копировании которого произошёл обрыв связи. 

• Если файл докачался, но не прошел проверку чексуммы, то он удаляется и закачивается заново, а также на сервере был заменён патч в процессе обновления торговой сети.
• Если прозощел обрыв связи, то после возобновления файл докачивается.

Допустимы ли расхождения в версиях кассы и сервера?

"Тупиковые" патчи