3.4 Установка и настройка модуля TIONIX.PointMeter

Пакет, содержащий ПО модуля TIONIX.PointMeter, устанавливается на УУ, из предварительно настроенного репозитория (Раздел 3.2.3).

Подключитесь к УУ (по SSH) и выполните команду:

dnf install -y python3-tionix_point_meter

Выполните первичную настройку, настройку связи с интрерфейсом управления, а также настройку параметров рассылки и автозапуска модуля. Подробные инструкции изложены ниже (Раздел 3.4.1, Раздел 3.4.2, Раздел 3.4.5, Раздел 3.4.4).

3.4.1 Первичная настройка

После (успешной) установки пакета выполните команду конфигурирования модуля:

sudo openstack tnx configure -n tnx_point_meter

В ОС должна появиться системная служба tionix-point-meter-api.service. Проверьте статус службы:

sudo systemctl status tionix-point-meter-api.service -l

Создайте каталог для сохранения журнала, назначьте права:

mkdir -p /var/log/tionix/pointmeter
chown -R tionix:tionix /var/log/tionix/pointmeter

Примечание.

Детализация вывода (логируемой) информации зависит от настроек (конфигурации).

Скопируйте образец конфигурационного файла, содержащий стандартные параметры, в конфигурационный файл модуля:

cp /etc/tionix/point_meter.yaml.example /etc/tionix/point_meter.yaml

Отредактируйте конфигурационный файл с учетом актуальной инфраструктуры. Подробное описание параметров доступно в технической документации.

3.4.3 Проверка статуса работы службы

Если служба не была настроена на автоматический запуск, то следует запустить её вручную. Для этого выполните команду:

sudo systemctl start tionix-point-meter-api.service

После выполнения запуска службы проверьте её статус:

sudo systemctl status tionix-point-meter-api.service

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

tionix-point-meter-api.service - TIONIX.PointMeter API service
Loaded: loaded (/usr/lib/systemd/system/tionix-point-meter-api.service; disabled; vendor preset: disabled)
Active: active (running) since Ср 2020-10-07 01:16:18 UTC; 4s ago
Main PID: 20235 (tnx-point-meter)
Tasks: 1
CGroup: /system.slice/tionix-point-meter-api.service
...
<дата_лога> доменное_имя_узла tnx-point-meter-api[20235]: (20235) wsgi starting up on http://0.0.0.0:9367

3.4.4 Настройка автоматического запуска

Для настройки автоматического запуска (при загрузке ОС) службы выполните команду:

sudo systemctl enable tionix-point-meter-api.service

Для отключения авто-запуска (в особых случаях) используйте команду:

sudo systemctl disable tionix-point-meter-api.service

ВАЖНО.

Особенности настройки службы в кластерной конфигурации изложены в документе Руководство по эксплуатации ОП TIONIX.

3.4.5 Настройка параметров рассылки

В папке, хранящей конфигурационные файлы – /etc/tionix, после установки модуля появится файл point_meter.yaml.example. Переименуйте или скопируйте его в /etc/tionix/point_meter.yaml.

Внимание.

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

Выполните команды:

cd /etc/tionix
cp point_meter.yaml.example point_meter.yaml

Отредактируйте файл конфигурации модуля. Поправьте нём параметры настроек почтового сервера, используемого для рассылки.

Зона часового пояса задается параметром TIME_ZONE.

По-умолчанию, для рассылки используется предварительно настроенный электронный почтовый ящик:

С помощью параметра „TIONIX_MAIL“ адрес почтового ящика может быть изменен. Введите адрес электронного почтового ящика (E-mail), на который должны доставляться статистические отчеты.

Если необходимо рассылать копии отчетов на другие почтовые ящики, настройте дополнительный параметр – „TIONIX_CLIENTS“. Остальные параметры служат для настройки почтового сервера, через который будут отправляться отчеты.

3.4.5.1 Расписание отправки отчетов

По умолчанию, служба (Pointmeter) отправляет 1-го числа каждого месяца статистический отчет (электронную таблицу) об использовании ресурсов, составленный за предыдущий месяц.

Примечание.

Отправка отчета, из соображений безопасности, производится в зашифрованном виде.

Расписание отправки задается с помощью конфигурации crontab [1] в формате, заданном параметром CRON_SCHEDULE.

[1]https://losst.ru/nastrojka-cron

3.4.5.2 Пример конфигурационного файла

Ниже показан пример содержимого файла /etc/tionix/point_meter.yaml, задающего параметры работы модуля:

MAIL_SERVER: smtp.yandex.ru
MAIL_PORT: 587
MAIL_USE_TLS: True
MAIL_USE_SSL: False
MAIL_USERNAME: 'test@yandex.ru'
MAIL_PASSWORD: '*******'
MAIL_ASCII_ATTACHMENTS: True

CRON_SCHEDULE: '0 3 1 */1 *'
TIONIX_MAIL: 'points@tionix.ru'
TIME_ZONE: 'Europe/Moscow'

DEBUG: False

В приведенном примере подразумевается простой случай использования почтового сервера, в котором имя почтового ящика (каталога писем) и имя учетной записи совпадают.

Внимание.

Параметр DEBUG следует устанавливать в True только на этапе ввода в эксплуатацию и/или для выявлении сбоев в работе модуля (неотправлении отчета и т.п.).

3.4.5.3 Различные конфигурации рассылки

Если в используемом почтовом сервере для авторизации используется имя учетной записи, не совпадающее с именем почтового ящика, то потребуется указать три параметра (авторизации):

MAIL_USERNAME: 'user'
MAIL_PASSWORD: '*******'
MAIL_DEFAULT_SENDER: 'test@yandex.ru'

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

MAIL_USERNAME: '<имя_домена>\<имя_почтового_ящика>'
MAIL_PASSWORD: '*******'
MAIL_DEFAULT_SENDER: 'адрес_электронной_почты'

где

имя_домена – название домена (Microsoft AD);

адрес_электронной_почты – в формате <имя_почтового_ящика>@<доменное_имя_сервера>.

Внимание.

Не следует связывать доменное_имя_сервера с именем домена, в котором заведена учетная запись Exchange. Это – два разных понятия. доменное_имя_сервера – это запись ресурса в DNS, логически заменяющая IP-адрес почтового сервера.

3.4.6 Настройка интерфейсной связи (виджета)

На УУ с установленным модулем TIONIX.Dashboard настройте связь с интерфейсным виджетом (PointMeter).

Для того, чтобы между интерфейсом управления появилась интерфейсная связь, модуль TIONIX.PointMeter содержит виджет (средство визуализации и интерактивного взаимодействия). Виджет встраивается во вкладку «Тионикс - Обзор» при (пере)запуске модуля TIONIX.Dashboard.

Для активации виджета следует выполнить дополнительную настройку конфигурации модуля TIONIX.Dashboard. Для этого в файле конфигурации /etc/tionix/dashboard.yaml найдите и пропишите параметр „POINT_METER_API_URL“, указав в качестве значения параметра адрес узла, на котором установлена и выполняется служба.

Примечания.

Сервис поддерживает два языка: русский и английский.

При смене языка в Dashboard сообщения от сервиса автоматически переключаются на тот же язык.

Порт, используемый для взаимодействия с API службы – стандартный (tcp/9367).

Пример файла /etc/tionix/dashboard.yaml:

DB:
    ENGINE: django.db.backends.mysql
    NAME: tionix_dash
KEYSTONE:
    identity_service_name: identity
    network_service_name: network
MIN_RESERVE_VM: null
NEUTRON_VERSION: 2
SENTRY:
    ENABLED: false
    LOG_LEVEL: ERROR
POINT_METER_API_URL: http://127.0.0.1:9367/

После внесения изменений (в конфигурационный файл) перезапустите службу веб-сервера и TIONIX.PointMeter:

systemctl restart httpd tionix-point-meter-*

Виджет будет отображаться (на вкладке «Обзор») при условии, что:

  • система запущена с поддержкой сбора usage статистики;
  • пользователь имеет роль admin и текущий домен – default;
  • установлена и функционирует служба tionix-point-meter-api.service;
  • адрес указан корректно (параметр POINT_METER_API_URL).

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

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

  1. В виджете по умолчанию выставляется период и выводится информация по потреблению за прошлый месяц.
  2. Задав временной период и нажав кнопку «Отправить», можно посмотреть потребление за выбранный период (загрузка публичного ключа не требуется).

3.4.6.1 Загрузка публичного ключа

Нажмите кнопку «Добавить ключ», выберите файл, содержащий публичный ключ, и загрузите его. Система распознает загруженный файл. Если он содержит корректный ключ, то появится информационное сообщение об этом.

Если был загружен файл неверного формата, то система уведомит об ошибке.

Примечание.

После загрузки публичного ключа станет возможным скачивание отчета по баллам (см. документ Руководство по эксплуатации ОП TIONIX, Проверка работоспособности облачной платформы).

3.4.6.2 Удаление службы (модуля)

Для полного удаления службы (модуля TIONIX.PointMeter) из системы следует выполнить следующие команды:

sudo systemctl stop tionix-point-meter-api.service
sudo systemctl disable tionix-point-meter-api.service

sudo rm /etc/systemd/system/multi-user.target.wants/tionix-point-meter-api.service
sudo rm /usr/lib/systemd/system/tionix-point-meter-api.service

sudo systemctl daemon-reload
sudo systemctl reset-failed