Файлы конфигурации

Файлы конфигурации позволяют настраивать модули TIONIX.

Конфигурационные файлы описывают авторизационные данные для подключения к службам (OpenStack, DB, RabbitMQ и др.), а также параметры работы модулей.

Файлы имеют формат .yaml. С описанием формата можно ознакомиться в соответствующем разделе официальной документации.

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

Все названия секций и ключей в файлах конфигурации являются регистронезависимыми. Также не зависят от регистра значения булевых параметров (TRUE/FALSE) и уровни логирования, остальные параметры чувствительны к регистру.

Виды файлов конфигурации

Конфигурационные файлы продуктов TIONIX делятся на два типа:

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

Расположение файла конфигурации

При установке любого из модулей устанавливаются оба вида конфигурационных файлов: модульный и общий, с расширением .yaml.example в директорию /etc/tionix/.

Общий файл конфигурации

Данный вид файла конфигурации используется всеми модулями, что позволяет настроить сразу все модули в одном файле. Общий файл tionix.yaml находится в директории /etc/tionix/. В файле tionix.yaml.example перечислены секции и их опции. Если в описании параметров не указано иное, значения параметров чувствительны к регистру.

Общий файл конфигурации появляется после установки модуля TIONIX.Client.

Изменение параметров файла конфигурации описано в соответствующем разделе документации.

Содержание файла конфигурации

Файл конфигурации состоит из следующих секций и параметров:

Секция или параметр Описание
CINDER_VERSION Версия CinderClient для подключения к службе Cinder.
KEYSTONE Настройки аутентификации в службе Keystone.
DB Настройки подключения к базе данных.
JOURNAL_API_LISTEN IP-адрес, на котором будет запущена служба Journal API.
JOURNAL_API_LISTEN_PORT Порт, на котором будет запущена служба Journal API.
JOURNAL_API_LOGFILE Путь до лог файла службы Journal API.
JOURNAL_KEYSTONE_LISTENER_LOGFILE Путь до лог файла службы Keystone listener.
JOURNAL_LISTENER_LOGFILE Путь до лог файла службы Journal listener.
JOURNAL_NOVA_LISTENER_LOGFILE Путь до лог файла службы Nova listener.
NEUTRON_VERSION Поддерживаемая версия Neutron API.
SENTRY Настройки системы Sentry.
RABBIT_QUEUES Настройки сервиса выполнения асинхронных задач.
LOG_LEVEL Уровень логирования. По умолчанию INFO.
NOVA_RABBIT_VHOST Виртуальный хост RabbitMQ службы Nova.
KEYSTONE_RABBIT_VHOST Виртуальный хост RabbitMQ службы Keystone.
BLOCKED_ROLES Cписок ролей платформы OpenStack, которые необходимо заблокировать на этапе авторизации в модулях Тионикс.

Дополнительные параметры:

Параметр Описание Значение по умолчанию
TRACEBACK_ENABLED

Параметр для вывода трассировки ошибки при логировании. Возможные значения:

  • True;
  • False.

Значения являются регистронезависимыми.

False

Секция CINDER_VERSION

Указывает версию установленной службы Cinder.

Секция KEYSTONE

Состоит из следующих опций:

Опция Описание
auth_url URL авторизации в службе Keystone.
auth_version Версия клиента для авторизации в службе Keystone.
auth_user Имя пользователя.
auth_password Пароль пользователя.
auth_tenant Название проекта OpenStack.
compute_service_name Тип службы Nova (по умолчанию compute).
volume_service_name Тип службы Cinder (по умолчанию volume).
ceilometer_service_name Тип службы Ceilometer (по умолчанию metering).
user_domain_name Название домена пользователя.
project_domain_name Название домена проекта.
service_user Имя сервисного пользователя.
service_password Пароль сервисного пользователя.
service_project Название проекта сервисного пользователя.
service_user_domain_name Доменное имя сервисного пользователя.
service_project_domain_name Доменное имя проекта сервисного пользователя.

Секция DB

Состоит из следующих опций:

Опция Описание
ENGINE Тип базы данных.
USER Пользователь базы данных.
PASSWORD Пароль к базе данных.
HOST Хост, на котором запущена база данных.
PORT Порт, на котором запущена база данных.
MAX_POOL_SIZE Максимальное количество открытых подключений в пуле.
MAX_OVERFLOW Максимальный размер переполнения пула.
POOL_RECYCLE Таймаут превышения соединения. Если превышен, соединение будет закрыто и заменено вновь открытым соединением.
POOL_TIMEOUT Время ожидания отказа от возврата соединения.

Секция RABBIT_QUEUES

Состоит из следующих опций:

Опция Описание
broker_type Тип брокера для передачи сообщений.
host Хост, на котором расположен брокер сообщений.
port Порт, на котором расположен брокер сообщений.
username Имя пользователя.
password Пароль пользователя.
durable

Режим сохранения состояния очередей при перезапуске RabbitMQ. Возможные значения:

  • True;
  • False.

Секция SENTRY

Состоит из следующих опций:

Опция Описание
DSN Адрес, на который отправляются сообщения о событиях системой мониторинга ошибок Sentry.
ENABLED

Параметр, включающий систему мониторинга ошибок Sentry. Допустимые значения:

  • True;
  • False.

По умолчанию False.

LOG_LEVEL Уровень логирования системы мониторинга ошибок Sentry.

Секция LOG_LEVEL

Указывает установленный уровень логирования. Подробное описание уровней доступно в разделе "Уровни логирования".

Секция BLOCKED_ROLES

Описывает список ролей платформы OpenStack, которые необходимо заблокировать на этапе авторизации в модулях Тионикс.

Изменение параметров файла конфигурации

Важно

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

Скопируйте образец конфигурационного файла:

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

После выполнения команды вы можете редактировать файл, его можно найти в директории /etc/tionix/.

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

systemctl restart httpd
systemctl restart tionix-*

Модульный файл конфигурации

Данный вид файлов используется конкретным модулем. Файл конфигурации находится в директории /etc/tionix/. Название файла соответствует названию модуля.

Подробное описание конфигурационных файлов доступно в соответствующем разделе модулей: