Настройка с помощью scada-setup

Под Windows процессы Сервера устанавливаются и настраиваются программой scada-setup из состава установщика. Она сама создает файлы параметров %ProgramData%\Telecontrol\SCADA Server\<процесс>\server.json из шаблонов, конфигурационные БД, сертификат Сервера и службы Windows. Папка процесса называется так же, как процесс в параметре --tiers (config, proxy, historian, iec104…), кроме scada-filesystem: его папка — filestore. Ключи --install / --uninstall исполняемых файлов нужны только при ручной настройке без scada-setup; службы, созданные scada-setup, ими не изменяйте и не удаляйте — для этого есть scada-setup apply и scada-setup remove. Пошаговая установка описана в разделе Начало работы. Под Linux scada-setup делает то же со службами systemd — смотрите Развертывание под Linux.

Эта версия scada-setup еще не проверялась на объекте под Windows. Если результат какой-либо команды расходится с описанием на этой странице, сообщите в ООО «Телеконтроль» (mail@telecontrol.ru).

Запускайте scada-setup из командной строки с правами администратора (кроме generate и migrate без --execute; status тоже нужны права администратора — папка данных закрыта для остальных пользователей):

"C:\Program Files\Telecontrol SCADA\bin\scada-setup.exe" <команда> <параметры>

Установщик не добавляет папку программы в переменную PATH, поэтому вне этой папки вызывайте программу по полному пути. Свои шаблоны scada-setup находит в папке установки, над той, где лежит scada-setup.exe, откуда бы ее ни вызвали.

Команда Действие Права администратора
apply Создать файлы параметров, БД и, если его нет, сертификат Сервера, зарегистрировать и запустить службы процессов да
status Сведения о лицензии, сертификате компьютера и состояние служб процессов да
start / stop Запуск / остановка служб компьютера в нужном порядке да
remove [--purge-data] Остановить и удалить службы (с --purge-data — и данные процессов, перечисленных в --tiers, смотрите Удаление служб и данных) да
generate --tiers <список> --output <папка> Только создать файлы параметров, для просмотра нет
migrate [--execute] Перенести данные Сервера версии 2.5 — смотрите Переход с версии 2.5 с --execute — да
set-password Сменить пароль svc и (или) root на этом компьютере и перезапустить его службы — смотрите Смена пароля svc да

В своих сообщениях scada-setup называет процессы Сервера словом tier: например, status выводит строку Entitled tiers: config filesystem historian … — процессы, разрешенные лицензией, в алфавитном порядке, — а при ошибках пишет --tiers must name at least one tier или the license does not entitle tier(s) …. Имена в этих сообщениях — те же, что в параметре --tiers.

Новая установка начинается с пустого проекта. Конфигурационные БД, которые создает apply, не содержат объектов, устройств, связей и пользователей — только служебную учетную запись svc; войти можно встроенной учетной записью root. С ключом --demo первый apply создает их из демонстрационной конфигурации из состава установщика (объекты с эмуляцией, связи МЭК 60870-5-104, пользователи без паролей) и копирует демонстрационные мнемосхемы — только для ознакомления, смотрите Подготовка проекта. Существующие БД apply не заменяет ни с --demo, ни без него. Конфигурация хранится в одной копии — у scada-config; остальные процессы, в том числе scada-proxy, читают ее у scada-config, поэтому изменения, внесенные в Клиенте, действуют во всех процессах.

Параметры

  • --tiers <список> — процессы этого компьютера через запятую. Если параметр не задан, apply, start и migrate берут все процессы из лицензии, а stop, status, remove и set-password — все службы Сервера, которые есть на компьютере. Для generate параметр обязателен. Под Linux процессы scada-opc и scada-vidicon, которые работают только под Windows, в набор по умолчанию не входят. Указанные в --tiers команд apply, start и migrate (в том числе без --execute), они вызывают отказ … runs on Windows only, and this computer is not Windows; nothing was changed; stop, status, remove и generate их принимают.
  • --central <адрес> — адрес центрального компьютера; обязателен для apply, migrate и generate на компьютере без scada-config.
  • --advertise <адрес> — адрес этого компьютера для остальных. Без него компьютер, настроенный с --central, сообщает свое имя компьютера, и scada-proxy подключается к нему по этому имени: указывайте адрес IP, если центральный компьютер это имя не разрешает. Решите это до первого apply: сертификат Сервера запоминает адрес только при создании. На центральном компьютере указывайте адрес, по которому к нему обращаются остальные компьютеры: они сверяют его с сертификатом центрального компьютера и не подключаются, если его там нет.
  • --license <путь> — файл лицензии; по умолчанию license.json в папке данных (%ProgramData%\Telecontrol\SCADA Server\license.json, под Linux — /var/lib/scada/license.json). Его проверяют apply, start, migrate и status. start и status без --license проверяют файл, путь к которому apply записал в параметры процессов, поэтому указывать --license нужно только в apply и migrate. Указывайте полный путь (под Windows — начиная с буквы диска): процессы получают путь так, как он записан. Под Linux файл должен быть доступен на чтение учетной записи scada и не должен лежать в /home, /root или /run/user: службы эти папки не видят, и apply и start с таким путем не работают.
  • --svc-password <пароль> (или переменная окружения SCADA_SETUP_SVC_PASSWORD) — пароль учетной записи svc, обязателен для apply и migrate --execute; в set-password — новый пароль. Длина пароля — не больше 64 байт, иначе scada-setup отказывается работать: латинская буква или цифра занимает один байт, а русская буква — два (пароли сохраняются в кодировке UTF-8 и под Windows, и под Linux; под Windows scada-setup на объекте еще не проверялся), поэтому пароль из одних русских букв — не длиннее 32 знаков.
  • --root-password <пароль> (или переменная окружения SCADA_SETUP_ROOT_PASSWORD) — пароль root, обязателен для apply и migrate --execute на компьютере с scada-config или scada-filesystem.
  • --demo — только для apply: создать конфигурационные БД, которых еще нет, из демонстрационного проекта, а не пустыми (смотрите Демонстрационный проект).
  • --assigned-links-only — процессы протокольного уровня этого компьютера обслуживают только направления, в свойстве «Компьютер» которых указан этот компьютер, а направления без компьютера оставляют компьютеру, на котором apply выполнен без этого параметра (смотрите Выбор процессов Сервера).
  • --central-fingerprint <отпечаток> — на компьютере без scada-config: отпечаток сертификата центрального компьютера, как его выводят apply и scada-setup status на центральном компьютере. С ним компьютер подключается к объекту: получает сертификат от удостоверяющего центра объекта, и его процессы подключаются к остальным с шифрованием. Требует --svc-password. Отпечаток нужен только для первого подключения и после того, как центральный компьютер получил новый удостоверяющий центр (например, программу на нем переустановили с удалением центра): тогда apply с новым отпечатком сам заменяет сертификат этого компьютера. Уже подключенный компьютер узнает центральный по удостоверяющему центру, поэтому замена сертификата центрального компьютера отпечаток в его параметрах не затрагивает (смотрите Отпечаток центрального компьютера изменился).
  • --insecure-links — процессы подключаются друг к другу без шифрования, как в прежних версиях: удостоверяющий центр не создается, каждый компьютер получает самоподписанный сертификат. Защитой тогда служит только брандмауэр (смотрите Сервер OPC UA).
  • --allow-anonymous-opcua — на компьютере с scada-proxy: порт 4840 принимает и незащищенные соединения (политика None), и анонимный вход — для внешних систем OPC UA, которые не умеют ни того, ни другого (смотрите Подключение внешней системы). Без него на объекте с шифрованием порт 4840 принимает только защищенные соединения с входом по имени пользователя.
  • --data-root — папка данных, если она не стандартная (по умолчанию %ProgramData%\Telecontrol\SCADA Server, под Linux — /var/lib/scada).
  • --install-root — папка установки. Указывать не нужно: по умолчанию это папка над той, где лежит scada-setup.exe. Под Linux ни папка данных, ни папка установки не может лежать в /home, /root или /run/user: службы эти папки не видят, и apply и start откажутся работать. Поэтому архив .tar.gz не распаковывайте в домашнюю папку.

  • --host-name <имя> — имя этого компьютера вместо имени компьютера Windows: его scada-setup записывает в файлы параметров и сертификат, и его же указывают в свойстве «Компьютер» направлений (смотрите Выбор процессов Сервера).

scada-setup запоминает только путь к лицензии и папку данных. Остальные параметры он не запоминает. Запишите --tiers, --central, --advertise, --license, отпечаток центрального компьютера (--central-fingerprint) и, если вы их задавали, --host-name, --assigned-links-only, --insecure-links, --allow-anonymous-opcua и --data-root каждого компьютера при установке и указывайте их в каждой команде apply (а --tiers — и в start; --central команде start не нужен) на нем, в том числе при обновлении и восстановлении (start, status, stop, remove и set-password без --data-root берут папку данных из установленных служб):

  • start без --tiers берет все процессы из лицензии, запускает те, службы которых есть на компьютере, и про остальные выводит Skipped <процесс>: not installed on this host; если на компьютере нет ни одной из этих служб, start завершается ошибкой none of the requested tier services is installed on this host;
  • apply без --tiers устанавливает на компьютер все процессы из лицензии. Лишние службы удаляет команда remove --tiers <лишние процессы> (без --purge-data данные остаются);
  • apply без --license записывает путь по умолчанию только в файлы параметров, но не в службы;
  • apply без --assigned-links-only на компьютере, где он был задан, делает этот компьютер обслуживающим направления без компьютера — и два компьютера открывают одни и те же направления;
  • apply без --host-name на компьютере, где он был задан, записывает в файлы параметров имя компьютера Windows, и направления, назначенные прежнему имени, этот компьютер больше не обслуживает;
  • на объекте, установленном с --insecure-links, apply без этого параметра на центральном компьютере создает удостоверяющий центр объекта и переводит соединения центрального компьютера на шифрование — остальные компьютеры перестают с ним связываться, пока их не подключат с --central-fingerprint (смотрите Удостоверяющий центр объекта);
  • apply без --allow-anonymous-opcua на компьютере с scada-proxy, где он был задан, закрывает порт 4840 для незащищенных соединений и анонимного входа, и внешние системы, которые подключались так, перестают подключаться.

apply можно выполнять повторно: он заново создает файлы параметров и регистрирует службы с новыми параметрами, не трогая данные.

Повторный apply на работающих процессах

Процесс читает свой файл параметров, пароли svc и root и путь к лицензии только при запуске. Поэтому apply перезапускает работающую службу, если что-либо из этого изменилось — например, после нового --root-password, другого --license, другого --central или --advertise — вместе со службами этого компьютера, которые от нее зависят (от Telecontrol SCADA Config зависят все остальные). Службы, у которых ничего не изменилось, продолжают работать. Останавливать процессы перед apply не нужно:

"C:\Program Files\Telecontrol SCADA\bin\scada-setup.exe" apply --tiers <процессы этого компьютера> [--central <адрес>] [--advertise <адрес>] [--license <путь>] --svc-password <пароль> --root-password <пароль root>

Добавьте к команде и остальные записанные параметры компьютера — --central-fingerprint, --host-name, --assigned-links-only, --insecure-links, --allow-anonymous-opcua, --data-root, — если они были заданы при установке.

Так выполняется добавление процесса на компьютер. Пароли svc и root меняет команда set-password, которая сама перезапускает службы (смотрите Смена пароля svc). Перезапуск службы на время прерывает ее работу: пока перезапускается scada-proxy, Клиенты теряют связь с Сервером. Если на этом компьютере нет scada-proxy (только процессы протокольного уровня), Клиенты связь не теряют: объекты этих процессов на время перезапуска помечаются как недостоверные, а затем снова обновляются и архивируются сами — смотрите Перезапуск процесса протокольного уровня.

Работающий процесс не дает изменять свою конфигурационную БД. Обычно повторному apply менять в ней нечего, но если служебная учетная запись svc была изменена, apply сообщает can't update the configuration DB of <процесс>: database is locked и останавливается, не запустив службы: остановите службы командой scada-setup stop и выполните apply еще раз.

Удаление служб и данных

remove останавливает и удаляет службы; данные процессов при этом остаются.

С --purge-data команда безвозвратно удаляет, без запроса подтверждения, и папки данных процессов, перечисленных в --tiers (config, proxy, historian, filestore и т.д. в %ProgramData%\Telecontrol\SCADA Server) — конфигурацию, пароли пользователей, архивы, файлы мнемосхем и журналы. Без --tiers remove --purge-data ничего не делает и сообщает об ошибке. Перед --purge-data сделайте резервную копию.

Свои параметры: server.override.json

ВНИМАНИЕ: apply создает каждый файл server.json заново из шаблона — при каждом apply, в том числе при каждом обновлении, — поэтому не правьте server.json. Свои параметры (например, размеры журналов) записывайте в файл server.override.json в той же папке процесса: apply никогда его не изменяет и при каждом создании server.json накладывает его поверх шаблона. Блоки (объекты JSON) объединяются по ключам, любое другое значение (строка, число, список) заменяет значение шаблона целиком, а значение null удаляет параметр. Например, чтобы увеличить размер файлов журнала, достаточно файла

{ "log": { "max_file_size": 50 } }

Ошибка в server.override.json останавливает apply с сообщением, в котором указан файл. Если существующий server.json отличается от создаваемого (например, его правили вручную), apply сохраняет прежний файл как server.json.bak — перенесите из него свои изменения в server.override.json. После изменения server.override.json выполните apply: если файл параметров процесса от этого изменился, apply перезапускает его службу (смотрите Повторный apply).

Где хранятся пароли

Пароли svc и root, переданные apply или set-password, хранятся в файле %ProgramData%\Telecontrol\SCADA Server\secrets\service-secrets.dat. Файл зашифрован средствами Windows (DPAPI) и привязан к компьютеру: на другом компьютере он не расшифровывается. Открыть папку secrets могут только системная учетная запись, под которой работают службы, и администраторы компьютера. Службы находят файл по переменной SCADA_SECRETS_FILE в своих параметрах, а в реестре паролей больше нет.

  • Администратор компьютера может прочитать эти пароли. Не давайте прав администратора на компьютерах Сервера посторонним.
  • Пароли из этого файла меняет только scada-setup set-password. Смена пароля root или svc из Клиента Сервер отклоняет (смотрите Пароль root и Учетная запись svc).
  • Сервер, установленный предварительной сборкой версии 2.6, может хранить пароли открытым текстом — в значениях Environment разделов реестра HKLM\SYSTEM\CurrentControlSet\Services\TelecontrolScada<Процесс>, где их может прочитать любой, кто входит в Windows на этом компьютере. Первый apply или set-password после обновления переносит их в файл и удаляет из реестра.
  • После переноса данных на другой компьютер (например, при восстановлении) выполните на нем apply с теми же паролями: скопированный файл паролей там не расшифровывается.

Под Linux пароли хранятся в файле /var/lib/scada/secrets/service-secrets.env: он не зашифрован, но открыть папку secrets и прочитать файл может только root. systemd читает его при запуске каждой службы и передает пароли процессу в переменных окружения; в файлах параметров и файлах служб паролей нет. Не давайте посторонним прав root на компьютерах Сервера и не копируйте этот файл в резервные копии, доступные другим.

Папка данных закрыта для других пользователей компьютера. apply оставляет базу конфигурации (в том числе записи паролей пользователей Клиента), архив и журналы процессов только Серверу. Под Windows доступ к папке данных получают администраторы и системная учетная запись (SYSTEM), от имени которой работают службы, и больше никто — открывайте ее из командной строки, запущенной от имени администратора: если Проводник предложит дать доступ вашей учетной записи, согласие навсегда добавит ее в права папки. Под Linux каждая папка процесса внутри нее принадлежит scada и закрыта для других пользователей (0750), как и все, что процессы создают в ней позже. Сама папка /var/lib/scada остается за root и открыта для чтения: через нее процессы, которые работают от имени scada, находят свои папки и лицензию, поэтому не закрывайте ее.

Если вы уже ограничили доступ к папке сами, apply сохранит ваши настройки: под Windows папка, у которой вы отключили наследование прав и в которую не пускаете обычных пользователей, остается как есть, включая добавленные вами записи; под Linux ни одна папка не становится доступнее, чем вы ее оставили. За вами остается: храните резервные копии и копии папки данных так же закрытыми и не размещайте папку данных в корне диска (D:\) — права целого диска apply не меняет и сообщает об этом.

Не совмещайте Сервер с рабочим местом операторов. Если на компьютер Сервера установлен и пакет Клиента (с пиктограммой на рабочем столе), не давайте операторам работать с ним (смотрите Установка Клиента).