Описание файла конфигурации vision_core (config.yml)
Когда в столбце “Secrets Vault” указан +, это означает, что в файле конфигурации vision_core указывается только ссылка на реальное значение (имя ключа), которое хранится в зашифрованном файле хранилища секретов Ansible Vault.
Глобальные параметры vision_core#
Имя ключа раздела конфигурации: general.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| verify_ssl | boolean | Глобальный параметр, устанавливающий необходимость проверки сертификата при HTTPS-запросах. | |
| request_timeout | integer | Глобальный параметр, устанавливающий таймаут HTTP-запросов в секундах. | |
| product_type | Тип продукта. Может принимать значения vision или genom. | ||
| vision_version_path | 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 | Запускать Мониторинг.Сервер в режиме демо-стенда. | |
| query_validator_bin_filepath | string | Путь до бинарного файла vmagent на Мониторинг.Сервере. | |
| python_filepath | string | Путь до интерпретатора python, используемый в Vision Core. |
Аутентификация при запросах к API vision_core#
Имя ключа раздела конфигурации: auth.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| enabled | boolean | Включает OAuth2 аутентификацию. | |
| auth_type | string | Тип аутентификации. | |
| auth_server | string | URL провайдера OAuth2. | |
| admin_server | string | URL административной части OAuth2 провайдера. В случае пустой строки, будет использоваться auth_server. Если заполнен пустой строкой, то в качестве значения будет использоваться auth_server. | |
| realm | string | Имя realm провайдера OAuth2. | |
| client_id | string | Идентификатор клиента, предоставленный приложением OAuth2. | |
| client_secret | string | Секрет клиента, предоставленный приложением OAuth2. | + |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах. | |
| request_timeout | integer | Таймаут HTTP-запросов в секундах. | |
| admin_role_codes | Конфигурация кодов ролей администраторов |
Конфигурация iamsyncer для использования ее в vision_core#
Имя ключа раздела конфигурации: iamsyncer.
| Ключ параметра | Тип | Описание | 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 | Роут для проверки состояния компонента. | |
| user_update_enabled | boolean | Включает механизм синхронизации пользователей/получателей с IAM. | |
| tech_auth_client_id | string | Идентификатор технического клиента, предоставленный приложением OAuth2. | |
| tech_auth_client_secret | string | Секрет технического клиента, предоставленный приложением OAuth2. | + |
| tech_auth_username | string | Имя технической учетной записи IAM. | |
| tech_auth_password | string | Пароль технической учетной записи IAM. | + |
| fetch_interval | integer | Периодичность запроса получателей из IAM, в секундах | |
| web_config_file | string | Путь до файла веб-конфигурации компонента. | |
| env_filepath | string | Путь до файла с ключами запуска компонента. |
Параметры 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_ca_file | string | Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту. | |
| tls_cert_file | string | Путь к файлу с сертификатом TLS сервера. | |
| tls_key_file | string | Путь к файлу с ключом TLS сервера. | |
| config_filepath | string | Основной файл конфигурации Vision Core. |
Подключение 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 | Имя БД. |
Взаимодействие 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 | Роут для проверки состояния компонента. | |
| admin_username | string | Имя администратора Grafana. | |
| admin_password | string | Пароль администратора Grafana. | + |
| datasources_filepath | string | Путь к YAML-файлу источников данных Grafana. | |
| config_ini_filepath | string | Путь к INI-файлу конфигурации Grafana. | |
| config_yaml_filepath | string | Путь к YAML-файлу для создания INI-файла конфигурации Grafana. | |
| user_cache_ttl | integer | Время кеширования информации о пользователе в Grafana. | |
| user_cache_maxsize | integer | Размер кеша в записях. |
Взаимодействие 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 | Роут для проверки состояния компонента. | |
| internal_port | integer | Порт для внутренних HTTP-запросов к компоненту. | |
| query_max_series | integer | Максимально допустимое серий в запросе к VictoriaMetrics через эндпоинт /vision/api/v1/query_range, используемый конструктором выражений в интерфейсе. | |
| config_filepath | string | Путь до файла конфигурации VictoriaMetrics. | |
| env_filepath | string | Путь до файла переменных запуска VictoriaMetrics. | |
| binary_filepath | string | Путь до бинарного файла VictoriaMetrics (не используется). | |
| paks_config_dirpath | string | Путь до файла директории для файлов таргетов объектов ПАК (ноды, вм) для опроса plagent’а VictoriaMetrics. | |
| retention_period | string | Период хранения данных. |
Взаимодействие vision_core с VictoriaLogs#
Имя ключа раздела конфигурации: victorialogs.
| Ключ параметра | Тип | Описание | 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 | Роут для проверки состояния компонента. | |
| internal_port | integer | Порт для внутренних HTTP-запросов к компоненту. | |
| syslog_port | integer | Порт для приёма сообщений от rsyslog. |
Взаимодействие vision_core с vmalert_st (VictoriaMetrics)#
Имя ключа раздела конфигурации: 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 | Роут для проверки состояния компонента. | |
| rules_dir | string | Директория правил записи и оповещения VMAlert. | |
| alerting_rules_filename | string | Первая часть имени файла для правил оповещения. | |
| recording_rules_filename | string | Первая часть имени файла для правил записи. | |
| evaluation_interval | integer | Интервал оценки правил в секундах. | |
| binary_filepath | string | Путь до бинарного файла VMAlert. | |
| api_reload_postfix | string | Роут перезагрузки компонента. | |
| config_files | |||
| logging |
Взаимодействие vision_core с vmalert_vl (VictoriaLogs)#
Имя ключа раздела конфигурации: vmalert_vl.
| Ключ параметра | Тип | Описание | 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 | Роут для проверки состояния компонента. | |
| rules_dir | string | Директория правил записи и оповещения VMAlert. | |
| alerting_rules_filename | string | Первая часть имени файла для правил оповещения. | |
| recording_rules_filename | string | Первая часть имени файла для правил записи. | |
| evaluation_interval | integer | Интервал оценки правил в секундах. | |
| binary_filepath | string | Путь до бинарного файла VMAlert. | |
| api_reload_postfix | string | Роут перезагрузки компонента. | |
| config_files | |||
| logging |
Взаимодействие 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 | Роут для проверки состояния компонента. | |
| external_url | string | URL, который указывается в рассылке (флаг web.external-url). | |
| config_files | |||
| templates | array | Файлы, из которых загружаются определения пользовательских шаблонов уведомлений AlertManager. Последний компонент пути может содержать шаблон с подстановкой, например: ’templates/*.tmpl'. | |
| route | |||
| api_firing_path | string | Путь до API для отправки алертов от vmalert. |
Конфигурация 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).Если заполнено null, авторизация не требуется. | |
| smtp_auth_password | string | Пароль пользователя для подключения к SMTP-серверу (LOGIN и PLAIN). Если значение в хранилище заполнено null, авторизация не требуется. | + |
| smtp_require_tls | boolean | Требование SMTP TLS по умолчанию. | |
| smtp_test_timeout | integer | Таймаут отправки тестового письма к SMTP-серверу. |
Конфигурация компонента TaskDaemon#
Имя ключа раздела конфигурации: task_daemon.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| version | string | Версия компонента. | |
| tasks_check_period_sec | integer | Периодичность проверки TaskDaemon наличия новых задач. | |
| http_request_executor_timeout | integer | Таймаут в секундах HTTP-запросов при выполнении задач http_request TaskDaemon. |
|
| systemd_service | string | Имя сервиса systemd компонента. |
Конфигурация удаленных компонентов (агенты и прокси)#
Имя ключа раздела конфигурации: remote_components.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| metric_agent | |||
| metric_proxy | |||
| log_agent | |||
| log_proxy |
Взаимодействие vision_core с агентом Платформы (plagent)#
Имя ключа раздела конфигурации: platform_agent.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| component_name | string | Имя компонента. | |
| port | integer | Порт для HTTP-запросов к компоненту. | |
| protocol | string | Порт для HTTP-запросов к компоненту. | |
| tls_insecure_skip_verify | boolean | Пропускать ли проверку tls при HTTP-запросах. | |
| token | string | Токен аутентификации для HTTP-запросов к компоненту. | + |
Конфигурация компонента 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 ловушки. |
Взаимодействие 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 на стороне клиента, который будет использоваться при подключении к компоненту. |
Взаимодействие 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 на стороне клиента, который будет использоваться при подключении к компоненту. |
Конфигурация PlatformUI#
Имя ключа раздела конфигурации: platform_ui.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| dashboards |
Взаимодействие vision_core с компонентом резервного копирования#
Имя ключа раздела конфигурации: backup.
| Ключ параметра | Тип | Описание | 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_templates | |||
| config_files | |||
| schedule | |||
| backup_directory | string | Директория для хранения резервных копий. | |
| internal_timeout | integer | Внутренний таймаут на выполнение операций. |
Конфигурация utilizer для использования ее в vision_core#
Имя ключа раздела конфигурации: utilizer.
| Ключ параметра | Тип | Описание | 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 | Путь до файла конфигурации компонента. | |
| env_filepath | string | Путь до файла с ключами запуска компонента. | |
| web_config_file | string | Путь до файла конфигурации web.yml компонента. |
Взаимодействие vision_core с AlertCollector#
Имя ключа раздела конфигурации: alertcollector.
| Ключ параметра | Тип | Описание | 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_files | |||
| logging | |||
| api_firing_path | string | Путь до API для отправки алертов от vmalert. |
Раздел конфигурации внешней интеграции vmalert#
Имя ключа раздела конфигурации: vmalert_external_integration.
| Ключ параметра | Тип | Описание | Secrets Vault |
|---|---|---|---|
| enabled | boolean | Включение/выключение внешней интеграции vmalert. | |
| url | string | Полный URL для отправки оповещений до эндпоинта API v2 Alertmanager (или аналогичного). Например, https://127.0.0.1:9999/vision/alertmanager/api/v2/alerts | |
| tls | Параметры TLS | ||
| auth | Параметры аутентификации |