Описание файла конфигурации vision_core (config.yml)
Когда в столбце “Secrets Vault” указан +, это означает, что в файле конфигурации vision_core указывается только ссылка на реальное значение (имя ключа), которое хранится в зашифрованном файле хранилища секретов Ansible Vault.
1. Глобальные параметры vision_core#
Имя ключа раздела конфигурации: general.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| verify_ssl | boolean | Глобальный параметр, устанавливающий необходимость проверки сертификата при HTTPS-запросах. | |
| request_timeout | integer | Глобальный параметр, устанавливающий таймаут HTTP-запросов в секундах. | |
| vision_version | string | Версия Визиона. Устанавливается дистрибутивом. | |
| cookie_secret_key | string | Секретный ключ для cookies. | + |
| plugins_directory | string | Директория с плагинами Визиона. | |
| agent_directory | string | Директория Визион.Агента. | |
| agent_etc_directory | string | Директория с файлами конфигурации Визион.Агента. | |
| agent_log_directory | string | Директория хранения логов Визион.Агента. | |
| agent_audit_directory | string | Директория хранения логов аудита Визион.Агента. | |
| proxy_directory | string | Директория Визион.Прокси. | |
| proxy_etc_directory | string | Директория с файлами конфигурации Визион.Прокси. | |
| proxy_log_directory | string | Директория хранения логов Визион.Прокси. | |
| is_demo_stand | boolean | Запускать Визион.Сервер в режиме демо-стенда. |
2. Аутентификация при запросах к API vision_core#
Имя ключа раздела конфигурации: auth.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| enabled | boolean | Включает OAuth2 аутентификацию. | |
| auth_type | string | Тип аутентификации.auth_serverstringURL провайдера OAuth2.realmstringИмя realm провайдера OAuth2.client_idstringИдентификатор клиента, предоставленный приложением OAuth2. | |
| client_secret | string | Секрет клиента, предоставленный приложением OAuth2. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах. | |
| request_timeout | integer | Таймаут HTTP-запросов в секундах. |
3. Параметры API vision_core#
Имя ключа раздела конфигурации: vision_api.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| systemd_service | string | Имя сервиса | |
| systemd.protocol | string | Протокол запуска сервера. | |
| port | integer | Порт для прослушивания входящих HTTP-запросов. | |
| host | string | Адрес для прослушивания входящих HTTP-запросов. | |
| route_prefix | string | Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером. | |
| reload | boolean | Авто перезагрузка Uvicorn. | |
| task_completion_postfix | string | Путь для уведомлений от TaskDaemon о завершенных задачах. | |
| tls_cert_file | string | Путь к файлу с сертификатом TLS сервера. | |
| tls_key_file | string | Путь к файлу с ключом TLS сервера. |
4. Подключение vision_core к служебной базе данных PostgreSQL#
Имя ключа раздела конфигурации: database.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| systemd_service | string | Имя сервиса systemd. | |
| version | string | Версия компонента. | |
| host | string | Адрес для обращения к БД. | |
| port | integer | Порт БД. | |
| username | string | Имя пользователя для подключения к БД. | |
| password | string | Пароль пользователя для подключения к БД. | + |
| name | string | Имя БД. |
5. Взаимодействие vision_core с Grafana#
Имя ключа раздела конфигурации: grafana.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| api_health_postfix | string | Роут для проверки состояния компонента. |
6. Взаимодействие vision_core с VictoriaMetrics#
Имя ключа раздела конфигурации: victoriametrics.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| api_health_postfix | string | Роут для проверки состояния компонента. | |
| query_max_number_points | integer | Максимально допустимое количество данных в запросе к VictoriaMetrics через эндпоинт API vision_core /vision/api/v1/query_range. | |
| config_filepath | string | Путь до файла конфигурации VictoriaMetrics (не используется). | |
| binary_filepath | string | Путь до бинарного файла VictoriaMetrics (не используется). |
7. Взаимодействие vision_core с VMAlert#
Имя ключа раздела конфигурации: vmalert.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| api_health_postfix | string | Роут для проверки состояния компонента. | |
| api_reload_postfix string | Роут перезагрузки компонента. | ||
| rules_dir | string | Директория правил записи и оповещения VMAlert. | |
| binary_filepath | string | Путь до бинарного файла VMAlert. | |
| alerting_rules_filename | string | Первая часть имени файла для правил оповещения. | |
| recording_rules_filename | string | Первая часть имени файла для правил записи. | |
| utlz_rules_filename | string | Первая часть имени файла для правил записи утилизации (не используется). |
8. Взаимодействие vision_core с AlertManager#
Имя ключа раздела конфигурации: alertmanager.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| api_health_postfix | string | Роут для проверки состояния компонента. | |
| config_filepath | string | Путь до файла конфигурации отправки уведомлений AlertManager. | |
| amtool_binary_filepath | string | Путь до бинарного файла amtool (не используется). |
9. Конфигурация SMTP-шлюза для отправки уведомлений#
Имя ключа раздела конфигурации: smtp_config.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| default_receiver_email | string | Email адрея для отправки уведомлений, которые не имеют ни одного другого получателя, согласно параметрам групп получателей в интерфейсе Визиона. | |
| smtp_host | string | Хост SMTP, используемый для отправки уведомлений. | |
| smtp_port | string | Порт SMTP-сервера. | |
| smtp_from | string | Email отправителя сообщений для поля заголовка SMTP From. | |
| smtp_auth_username | string | Имя пользователя для подключения к SMTP-серверу (LOGIN и PLAIN). | |
| smtp_auth_password | string | Пароль пользователя для подключения к SMTP-серверу (LOGIN и PLAIN). | + |
| smtp_require_tls | boolean | Требование SMTP TLS по умолчанию. |
10. Конфигурация компонента TaskDaemon#
Имя ключа раздела конфигурации: task_daemon.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| tasks_check_period_sec | integer | Периодичность проверки TaskDaemon наличия новых задач. | |
| systemd_service | string | Имя сервиса systemd компонента. |
11. Конфигурация компонента vmagent_agent#
Имя ключа раздела конфигурации: comp_agent.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| repo_bin_filepath | string | Путь до бинарного файла vmagent на Визион.Сервере. | |
| remote_bin_filepath | string | Путь для размещения бинарного файла vmagent на удаленном сервере. | |
| port | integer | Порт для прослушивания входящих HTTP-запросов. | |
| protocol | string | Протокол запуска HTTP-сервера компонента. | |
| route_prefix | string | Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером. | |
| log_filepath | string | Путь для файлов логов на удаленном сервере. | |
| basic_auth_username | string | Имя пользователя для BasicAuth HTTP-сервера. | |
| basic_auth_password | string | Пароль для BasicAuth HTTP-сервера. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу с сертификатом TLS HTTP-сервера. | |
| tls_key_file | string | Путь к файлу с ключом TLS сервера. | |
| tls_min_version | string | Минимальная версия TLS компонента. | |
| audit_filepath | string | Путь для файлов логов аудита на удаленном сервере. | |
| audit_component_name | string | Имя компонента, используемое в логах аудита. |
12. Конфигурация компонента vmagent_proxy#
Имя ключа раздела конфигурации: comp_proxy.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| repo_bin_filepath | string | Путь до бинарного файла vmagent на Визион.Сервере. | |
| remote_bin_filepath | string | Путь для размещения бинарного файла vmagent на удаленном сервере. | |
| port | integer | Порт | для прослушивания входящих HTTP-запросов. |
| protocol | string | Протокол запуска HTTP-сервера компонента. | |
| route_prefix | string | Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером. | |
| log_filepath | string | Путь для файлов логов на удаленном сервере. | |
| basic_auth_username | string | Имя пользователя для BasicAuth HTTP-сервера. | |
| basic_auth_password | string | Пароль для BasicAuth HTTP-сервера. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу с сертификатом TLS HTTP-сервера. | |
| tls_key_file | string | Путь к файлу с ключом TLS сервера. | |
| tls_min_version | string | Минимальная версия TLS компонента. | |
| audit_filepath | string | Путь для файлов логов аудита на удаленном сервере. | |
| audit_component_name | string | Имя компонента, используемое в логах аудита. |
13. Взаимодействие vision_core с агентом Платформы (plagent)#
Имя ключа раздела конфигурации: platform_agent.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| protocol | string | Порт для HTTP-запросов к компоненту. | |
| token | string | Токен аутентификации для HTTP-запросов к компоненту. | + |
14. Конфигурация компонента SnmpNotifier#
Имя ключа раздела конфигурации: snmp_notifier_config.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| snmp_version | string | Версия SNMP. Допустимые значения: V2c, V3. Значение задаётся через API. | |
| snmp_destination | string | Адресат сообщений. Значение задаётся через API. | |
| snmp_retries | integer | Количество повторных посылок сообщения SNMP. Значение задаётся через API. | |
| snmp_trap_default_oid | string | OID ловушки, если он не найден в метках сработавшего правила. Значение задаётся через API. | |
| snmp_timeout_sec | integer | Длительность таймаута в секундах. Значение задаётся через API. | |
| snmp_community | string | Комьюнити SNMP (только V2c). Значение задаётся через API. | |
| snmp_authentication_protocol | string | Протокол шифрования пароля (только V3). Допустимые значения: MD5, SHA. Значение задаётся через API. | |
| snmp_authentication_username | string | Имя пользователя аутентификации SNMP (только V3). Обязательное поле, когда указан snmp_authentication_protocol. Значение задаётся через API. | |
| snmp_authentication_password | string | Пароль аутентификации SNMP (только для V3). Значение секрета задаётся через API. | + |
| snmp_private_protocol | string | Протокол передачи данных SNMP (только V3). Допустимые значения: DES, AES. Значение задаётся через API. | |
| snmp_private_password | string | пароль шифрования SNMP (только для V3). Значение секрета задаётся через API. | + |
| snmp_security_engine_id | string | ID механизма безопасности SNMP (только V3). Значение задаётся через API. | |
| snmp_context_engine_id | string | ID механизма контекста (только V3). Значение задаётся через API. | |
| snmp_context_name | string | Имя контекста. (только V3). Значение задаётся через API. | |
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| systemd_service | string | Имя сервиса systemd компонента. | |
| api_health_postfix | string | Роут для проверки состояния компонента. | |
| env_file | string | Путь до файла с ключами запуска SnmpNotifier. | |
| web_config_file | string | Путь до файла веб-конфигурации компонента. | |
| snmp_trap_description_template | string | Путь до файла шаблона сообщения SNMP. | |
| snmp_trap_oid_label | string | Метка, содержащая OID ловушки. |
15. Взаимодействие vision_core с FoliageAPI#
Имя ключа раздела конфигурации: foliage_api.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. |
16. Взаимодействие vision_core с FoliageUI#
Имя ключа раздела конфигурации: foliage_ui.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| request_timeout | integer | Таймаут HTTP-запросов к компоненту в секундах. | |
| protocol | string | Протокол HTTP-сервера компонента. | |
| host | string | Адрес для HTTP-запросов к компоненту. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| route_prefix | string | Префикс для HTTP-запросов к компоненту. | |
| basic_auth_username | string | Имя пользователя BasicAuth для HTTP-запросов к компоненту. | |
| basic_auth_password | string | Пароль BasicAuth для HTTP-запросов к компоненту. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах к компоненту. | |
| tls_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. | |
| tls_key_file | string | Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту. |