Конфигурирование переменных файла main.yml
Конфигурационный файл main.yml содержит переменные, предназначеные для настройки установки PGS. Для настройки следует использовать доступные значения и способы заполнения переменных, указанные в таблице.
Параметры переменных необходимо указывать в двойных кавычках. Спецсимволы <> {} | & ; * ? @ ` ! в значениях переменных необходимо экранировать символом \. Для обеспечения безопасности при работе ПО рекомендовано использовать надежные пароли, содержащие спецсимволы и произвольные символы разных регистров.
Доступ к сервисам PGS обеспечивается с помощью переменных:
dev_mode;pgs_cluster;domain_name;domain_env;swarm_network_encryption;api_interface_ext_port.
После заполнения перечисленных переменных будет сформирован адрес: https://pgs-<domain_env>.<domain_name> который служит для обеспечения доступа к сервису. Если переменная <domain_env> не задана, то запись будет https://pgs.<domain_name>
| Переменная | Значение и способ заполнения |
|---|---|
| pgs_cluster | Включение и отключение кластерного режима установки системы. Принимает значения True и False. В шаблоне standalone (contrib/pgs/standalone/group_vars/pgs_setup/main.yml) — False В шаблоне cluster (contrib/pgs/cluster/group_vars/pgs_setup/main.yml) — True |
| domain_name | Зарегистрированный домен установки PGS |
| domain_env | Элемент доменного имени установки, предназначеный для разграничения доступа к сервисам PGS |
| api_interface_ext_port | Порт Nginx для доступа к API интерфейсу, значение по умолчанию — 443. При изменении значения по умолчанию для порта в PGS необходимо учесть новое значение в компоненте CO При включении интеграции с почтовой системой PSN следует изменить порт для доступа к pgs_api в параметрах PSN Почтового сервера (Подробнее см. в документе «Руководство по установке почтового сервера») |
| auth_encryption_key | Ключ-секрет для генерации хэшей пользовательских и операционных данных. Значение в произвольном виде, минимальная длина — 8 символов |
| keycloak_password | Пароль для пользователя PGS в Keycloak (он же Администратор Master Realm). Длина значения не менее 10 символов |
| keycloak_realm_password | Внутренний пароль для администраторов тенантов Keycloak (используется только для сервисного обслуживания системы). Длина значения не менее 10 символов |
| keycloak_postgres_password | Пароль БД PostgreSQL (используется как хранилище для Keycloak). Длина значения не менее 10 символов |
| pgs_observability_mode | Отвечает за выбор систем мониторинга, устанавливаемых при развертывании продукта. Переменная принимает следующие значения: external — устанавливаются только The OpenTelemetry Collector. Для корректной работы необходимо указать значение переменной otel_collector_external_otlp_endpoint internal — устанавливаются только сервисы Prometheus и Grafana. both — устанавливаются Prometheus, Grafana и The OpenTelemetry Collector (используется по умолчанию). Для корректной работы необходимо указать значение переменной otel_collector_external_otlp_endpoint |
| otel_collector_external_otlp_ endpoint | Определяет IP-адрес или доменное имя внешнего сервера, который принимает данные в формате open telemetry. При выборе pgs_observability_mode: "external" используется OpenTelemetry Collector на стороне компонента CO, поэтому в значении переменной otel_collector_external_otlp_endpoint указывается FQDN сервера группы co_infra компонента CO и порт 4317. Пример записи: otel_collector_external_otlp_endpoint: "co-infra-1.installation.example.net:4317" |
| arangodb_password | Пароль пользователя PGS в ArangoDB |
| redis_password | Пароль доступа в Redis |
| patroni_replication_password | Пароль для репликации БД PostgreSQL (только для кластерной установки) |
| grafana_admin_password | Пароль доступа к интерфейсу Grafana в случае установки с переменной pgs_observability_mode со значениями internal или both |
| Блок default_tenant | Блок default_tenant |
| Блок default_tenant | Предназначен для создания тенанта по умолчанию, необходимого для дальнейшей работы с пользователями в веб-интерфейсе PGS |
| admin_password | Пароль для администрирования тенанта (обязательный параметр, при отсутствии значения тенант создан не будет) |
| admin_recovery_ | Почта для восстановления доступа к тенанту (обязательный параметр, при отсутствии значения тенант создан не будет) |
| max_users | Количество пользователей в тенанте, значение по умолчанию — 1000 |
| quota_per_user | Выделенное пользователю место в хранилище, указывается в байтах, значение по умолчанию — 1000000000 (~1 Гбайт) |
| quota_per_group | Выделенное место для хранения общих папок. указывается в байтах, значение по умолчанию — 10737418240 (10 Гбайт) |
| Блок storage | Блок storage |
| Блок storage | Блок настроек системы хранения файлов |
| Блок s3 | Параметры доступа к хранилищу s3. Информацию по заполнению переменных следует запросить у хостинг-провайдера, ниже приведены указания для заполнения при использовании сервиса MinIO |
| minio_used | При использовании внешнего по отношению к продукту s3-хранилища поставить False, при использовании внутреннего хранилища (сервис MinIO) указать — True |
| minio_drives_per_node | Определяет количество дисков для каждого сервера в кластере MinIO. Используется при установке PGS совместно с MinIO Значение по умолчанию: 2 (переменная принимает только целочисленные значения) |
| url | Ссылка для доступа к сетевому хранилищу. При использовании MinIO имеет следующий вид:http://nginx:9002Порт 9002 используется балансировщиком Nginx (компонент PGS) для проксирования запросов к MinIO на порт 9000. При использовании внешнего балансировщика следует настроить проксирование запросов на сервис MinIO по порту 9000, или |
| bucket | Контейнер для хранения объектов в хранилище s3 будет создан во время установки продукта. При использовании хранилища s3 необходимо указать произвольное значение, минимальная длина — 5 символов, в нижнем регистре |
| service_name | При использовании сервиса MinIO указывается значение s3 |
| region_name | При использовании сервиса MinIO указывается значение myoffice |
| acl | Сущность для разграничения прав доступа, в случае с MinIO необязательна к заполнению |
| s3_max_capacity | Параметр, определяющий максимальное пространство, доступное в s3, указывается в байтах. Если параметр не указан, возникает ошибка установки продукта. |
| Блок system | Блок system |
| timezone | Временная зона (часовой пояс) установки в формате базы tz. Значение по умолчанию — "Europe/Moscow" |
Переменные, указанные в таблице, настроены по умолчанию и определяются в процессе установки системы. Не рекомендуется изменять значения переменных без необходимости.
Для изменения значений по умолчанию дополнительным переменным следует открыть файл ~/install_pgs/group_vars/pgs_setup/main.yml и добавить необходимые переменные вручную.
| Переменная | Значение и способ заполнения |
|---|---|
| dev_mode | Developers mode, режим разработчика. Принимает значения True и False. При значении True — открывает порты сервисов для внешнего подключения, в целях организации доступа разработчиков к стенду установки (не используется в работающей с пользователями системе) |
| max_tenants | Задает максимально возможное число тенантов в текущей установке (максимально допустимое значение 100). Значение по умолчанию — 100 |
| iptables_enabled | Устанавливает и настраивает службы межсетевого экрана (опционально). Доступные значения: True и False, по умолчанию — False |
| enable_custom_ca_ connection_s3 | Включает использование самоподписанных сертификатов при подключении к s3 хранилищу. Корневой сертификат УЦ, которым подписан сертификат s3 хранилища, необходимо разместить в директории ~/install_pgs/certificates/ в файле s3_ca.crt. Если переменная отсутствует в файле ~/install_pgs/group_vars/pgs_setup/main.yml, значение по умолчанию — False |
| enable_custom_ca_ connection_ldap | Включает использование самоподписанных сертификатов при подключении к LDAP-серверу. Корневой сертификат УЦ, которым подписан сертификат LDAP-сервера, необходимо разместить в директории ~/install_pgs/certificates/ в файле ldap_ca.crt. Если переменная отсутствует в файле ~/install_pgs/group_vars/pgs_setup/main.yml, значение по умолчанию — False |
| swarm_network_ encryption | Включает шифрование внутренней оверлейной сети Docker swarm, значение по умолчанию — False. Влияет на производительность системы |
| swarm_network_ address | Адресация внутреней сети "pgs-network" в docker swarm, значение по умолчанию "10.0.0.0/24". Используется при пересечении адресации docker swarm с адресацией внутренней сети мест установки |
| swarm_network_gw | Шлюз по умолчанию для внутреней сети "pgs-network", значение по умолчанию "10.0.0.1". Используется при пересечении адресации docker swarm с адресацией внутренней сети мест установки |
| swarm_network_ ingress | Адресация ingress сети в docker swarm, значение по умолчанию, "10.0.1.0/24". Используется при пересечении адресации docker swarm с адресацией внутренней сети мест установки |
| minio_drives_per_node | Определяет количество дисков для каждого сервера в кластере MinIO. Используется при установке PGS совместно с MinIO Значение по умолчанию: 2 (переменная принимает только целочисленные значения) |
| data_path_port | Изменяет порт передачи данных в docker swarm. Значение по умолчанию 9999 |
| log_rotate_days | Определяет количество дней хранения журнала событий всех сервисов системы. Если переменная не задана в конфигурационном файле, то ее значение будет установлено в процессе развертывания, 14 дней. Переменная использует целочисленный формат |
| redis_timeout | Задает интервал в секундах для запуска сервиса redis. Для установки продукта общим количеством свыше 50 тыс. пользователей синхронизация между мастером и репликами в redis может занимать продолжительное время |
| task_tracker_delta _upload_value | Задает интервал в секундах для удаления файла, загрузка которого не завершена. Значение по умолчанию: 43200 секунд (12 часов) |