Аргументы конфигурации

В этом разделе приведены все доступные для конфигурации переменные установщика Sage. Некоторые из них обязательны — без них установка невозможна. Остальные являются опциональными, и вы можете изменить их по необходимости.

Обязательные переменные

Следующие переменные обязательны и должны быть определены:

Название переменной	Тип	Описание
sage_admin_password	str	Пароль администратора приложения.
sage_external_domain	str	Внешний домен для доступа к Sage.
sage_certificate_source	str	Источник сертификатов. Разрешенные значения: external, self-signed.
sage_clan	str	Идентификатор клана.
sage_env	str	Название окружения (например, dev, staging, prod).
sage_datacenter	str	Название дата-центра.

---

Опциональные переменные

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

Название переменной	Тип	Описание	Значение по умолчанию
sage_remote_datacenters	list	Список удаленных дата-центров.	[]
sage_additional_providers	list	Дополнительные провайдеры, которые будут использоваться.	[]
sage_auth_provider	str	Провайдер аутентификации, который будет использоваться.	keycloak
sage_keycloak_users	list	Список пользователей Keycloak.	[]
sage_alerts_smtp_login	str	Логин SMTP для уведомлений об алертах.
sage_alerts_smtp_password	str	Пароль SMTP для уведомлений об алертах.
sage_alerts_smtp_from	str	Email-адрес, используемый для отправки уведомлений об алертах.	pager_bot@localhost
sage_alerts_smtp_host	str	Хост SMTP-сервера для отправки уведомлений.	localhost
sage_alerts_smtp_port	str	Порт SMTP-сервера.	25
sage_alerts_smtp_need_auth	bool	Требуется ли аутентификация для SMTP.	False
sage_alerts_smtp_ssl_options	str	Параметры SSL/TLS для SMTP.	StartTlsWhenAvailable
sage_ldap_svc_username	str	Имя пользователя LDAP-учетной записи службы.
sage_ldap_svc_password	str	Пароль LDAP-учетной записи службы.
sage_admin_user	str	Имя администратора.	admin
sage_search_router_cb_minimum_throughput	int	Минимальное количество запросов, необходимое для включения/отключения circuit breaker.	100
sage_search_router_cb_sampling_duration	str	Продолжительность сэмплирования для circuit breaker.	00:00:30
sage_search_router_cb_break_duration	str	Продолжительность, в течение которой circuit breaker будет отключён.	00:00:05
sage_search_router_cb_break_on_status_codes	list	Статус-коды, при которых circuit breaker будет отключён.	[503]
sage_search_router_cb_failure_ratio	float	Процент ошибок, при которых circuit breaker будет отключён.	0.1
sage_alerts_escalation_webhook_secret_storage	str	Тип хранилища секретов вебхуков. Разрешенные значения: LocalAes, None.	None
sage_alerts_webhook_key	str	Ключ для шифрования вебхуков.
sage_spirit_external_domain	str	Домен Spirit.
sage_iam_client_id	str	Client ID для аутентификации в Spirit IAM.
sage_iam_client_secret	str	Client Secret для аутентификации в Spirit IAM.
sage_spirit_oidc_providers	list	Список сторонних OIDC провайдеров для Spirit.
sage_oidc_provider	str	OIDC провайдер для аутентификации в Sage.	keycloak
sage_spirit_login_webhooks	list	Список вебхуков, которые срабатывают при входе пользователя в Spirit.	[]
sage_spirit_registration_webhooks	list	Список вебхуков, которые срабатывают при регистрации пользователя в Spirit.	[]
sage_alerts_email_enabled	bool	Включение healthcheck-а email сервера для отправки алертов.	True
sage_metrics_allow_client_metrics	bool	Флаг позволяет в пользовательском коде алерта передавать статусы таймсерий алерта, и тем самым мы пишем метрики ALERTS, ALERTS_FOR_STATE и пушим их в Sage. Эти метрики необходимы для поддержки обратной совместимости дашбордов Grafana.	False
sage_internal_subdomain	str	Общий поддомен компонент при внутреннем взаимодействии.	internal.
sage_tracing_auth_required	bool	Требуется ли аутентификация для приема трассировок.	False
sage_enable_nginx_aliases	bool	Компоненты Sage начинают взаимодействовать с Nginx через алиасы в docker сети.	False
sage_nginx_enable_proxy_protocol	bool	Включение поддержки proxy protocol для Nginx.	False
sage_search_masking_groups	list	Группы к которым применяется маскирование.	[]
sage_search_masking_regexes	list	Регулярные выражения для маскирования. Формат: [{"name": "Test", "pattern": "\\b[A-Z][a-z]+\\b"}].	[]
sage_celestia_masking_settings_basemask	str	Строка, содержащая подлежащие замене паттерны.
sage_logs_auth_enabled	bool	Включить аутентификацию для записи логов.	False
sage_kafka_version	str	Выбор раскатывания новой и старой версии Kafka.	upgrade
sage_kafka_version_rollback	bool	Флаг для роллбэка версии Kafka в ходе ее обновления.
sage_service_map_pgsql_sslmode	str	Тип подключения Service Map к PostgreSQL.
sage_vector_export_logs_endpoint_uri	str	URI эндпоинта для отправки отфильтрованных логов.
sage_vector_export_logs_endpoint_auth_header	str	Заголовок авторизации для эндпоинта.
sage_vector_export_logs_batch_timeout_secs	int	Таймаут батча в секундах.	1
sage_vector_export_logs_batch_max_events	int	Максимальное количество событий в батче.	100
sage_vector_export_logs_batch_max_bytes	int	Максимальный размер батча в байтах.	1048576
sage_vector_export_logs_retry_max_duration_secs	int	Максимальная длительность retry в секундах.	30
sage_vector_export_logs_retry_initial_backoff_secs	int	Начальная задержка retry в секундах.	1
sage_vector_export_logs_custom_headers	dict	Кастомные заголовки для HTTP endpoint.	{}
sage_vector_export_logs_groups	list	Список групп логов для чтения с фильтрами.	[]
sage_metric_retention_sts	str	Период хранения данных стандартного кластера VictoriaMetrics.	30d
sage_metric_retention_lts	str	Период хранения данных долгосрочного кластера VictoriaMetrics.	1y
sage_images_source	dict	Источник образов для Sage-компонентов.	{'path': 'cr.yandex:443/crp9e7v1gtl8rlvmji4q', 'username': 'json_key', 'password': ''}
sage_crosscluster_jwt_keys	list	Список JWT-ключей для межкластерного взаимодействия.	[]
sage_keycloak_oauth__clientsecret	str	Client Secret для OAuth-аутентификации в Keycloak.
sage_anomaly_caches_max_alerts_count	int	Ожидаемое максимальное количество алертов в системе, обрабатываемых Anomaly Analyzer.	1000
sage_anomaly_caches_max_series_count	int	Ожидаемое максимальное количество временных рядов в системе, обрабатываемых Anomaly Analyzer.	10000
sage_anomaly_postgres_password	str	Пароль для подключения к PostgreSQL базе Anomaly Analyzer.
sage_anomaly_topic_partition_number	int	Количество партиций для топиков anomaly-analyzer.	3
sage_celestia_blocklist	list	Список заблокированных запросов для Celestia.	[]
sage_limits_override	dict	Переопределение лимитов для контейнеров Sage.	{}
sage_elastic_write_queue_size	int	Размер Elasticsearch очереди для write (index, delete, update, bulk) пула потоков.	200
sage_kafka_retention_bytes	int	Максимальный размер файла журнала Kafka перед его удалением.	10737418240
sage_kafka_retention_hours	int	Количество часов хранения файла журнала Kafka перед его удалением (в часах).	24
sage_luna_ssh_username	str	Имя пользователя SSH для Luna (используется для подключения к серверам с Grafana).	ubuntu
sage_frost_rw_kafka_compression	str	Тип сжатия для Kafka клиента.	none
sage_frost_rw_kafka_linger	int	Задержка отправки для frost_remote_write Kafka клиента (мс).	0
sage_notifier_channels_email_enabled	bool	Включение канала доставки Email для отправки алертов Sage Notifier.	False