Параметры развёртывания

Чтобы настроить параметры развёртывания:

Запустите установщик:
```
./platform-1.0.0-4f0558.run
```
Выберите пункт Сгенерировать конфигурацию деплоя.
Установщик создаст в директории distrib/ файл конфигурации деплоя platform-config-<version>-<date>-<time>.yml.

Здесь:
- <version> — версия установщика;
- <date> — дата создания файла в формате ГГГГММДД;
- <time> — время создания файла в формате ЧЧММСС.
Введите no и нажмите Enter.
Выберите пункт Выход.
Внесите в созданный файл изменения, соответствующие выбранной конфигурации.

api_gateway

Параметры API Gateway платформы.

api_gateway.logging

Секция api_gateway.logging содержит настройки журналирования.

api_gateway.logging.level

Уровень подробности журналирования работы API Gateway.

api_gateway.cors

Параметры CORS.

api_gateway.cors.allowedOrigins

Список адресов, с которых разрешён доступ к API Gateway.

api_gateway.csrf

Секция api_gateway.csrf содержит настройки CSRF.

api_gateway.csrf.enabled

Состояние защиты CSRF.

Возможные значения:

true — включена (по умолчанию);
false — выключена.

api_gateway.routes

Список маршрутов.

Описание маршрута состоит из следующих полей:

Поле Описание

Поле	Описание
`backend`	URL бэкенда
`bearerToken`	Токен, созданный на этапе Генерация токена
`id`	Идентификатор маршрута. Должен быть уникальным целым числом
`pattern`	URI маршрута
`preserveUrl`	Сохранение исходного URL при обращении к бэкенду
`skipTLS`	Пропуск проверки TLS

backend

URL бэкенда

bearerToken

Токен, созданный на этапе Генерация токена

id

Идентификатор маршрута. Должен быть уникальным целым числом

pattern

URI маршрута

preserveUrl

Сохранение исходного URL при обращении к бэкенду

skipTLS

Пропуск проверки TLS

Поля backend, id и pattern обязательны для заполнения.

auth_service

Секция auth_service содержит настройки службы аутентификации.

auth_service.iam

Секция auth_service.iam содержит настройки подключения к IAM.

auth_service.iam.auth_server

URL сервера IAM, например:

---
# ...
auth_service:
  iam:
    auth_server: http://192.168.0.1:8080

auth_service.iam.client_id

Идентификатор клиента IAM.

auth_service.iam.client_secret

Секрет клиента IAM.

auth_service.iam.provider

Название провайдера идентификации.

Возможные значения:

avanpost — FAM Avanpost;
bvs — Basis Virtual Security;
keycloak — Keycloak.

auth_service.iam.realm

Название пространства (REALM) в IAM.

auth_service.iam.request_timeout

Период ожидания при выполнении запросов к IAM.

auth_service.iam.tls_insecure_skip_verify

Пропуск проверки сертификата TLS при подключении к IAM.

Значение по умолчанию: false (проверка включена).

auth_service.sync

Секция auth_service.sync содержит настройки синхронизации службы аутентификации с IAM.

auth_service.sync.enabled

Состояние синхронизации.

Значение по умолчанию: true (включена).

auth_service.sync.fetch_interval

Длительность периода между циклами синхронизации.

auth_service.sync.tech_auth_client_id

Идентификатор клиента синхронизации.

auth_service.sync.tech_auth_client_secret

Секрет клиента синхронизации.

auth_service.sync.tech_auth_password

Пароль клиента сихнронизации.

auth_service.sync.tech_auth_username

Имя пользователя, используемое клиентом синхронизации.

auth_service.token_introspection

Параметры интроспекции токена IAM.

auth_service.token_introspection.enabled

Состояние интроспекции токена IAM.

Значение по умолчанию: true (включена).

auth_service.token_introspection.interval

Длительность периода между интроспекциями токена.

authz_service

Параметры службы авторизации.

authz_service.logging

Настройки журналирования службы авторизации.

authz_service.logging.level

Уровень подробности журналирования работы службы авторизации.

common

Секция common содержит общие настройки развёртывания платформы.

common.auth_server_host

IP-адрес или доменное имя сервера аутентификации.

Значение по умолчанию: localhost.

common.deployment_directory

Путь к директории для установки файлов платформы.

Значение по умолчанию: /opt/skala-r/platform-services.

common.logs_directory

Путь к директории для хранения логов сервисов.

Значение по умолчанию: /opt/skala-r/platform-services/logs.

common.ports

Секция содержит список внешних портов контейнеров.

common.ports.api_gateway

Порт API Gateway.

Значение по умолчанию: 3000.

common.ports.frontend_http

HTTP-порт фронтэнда.

Значение по умолчанию: 80.

common.ports.frontend_https

HTTPS-порт фронтэнда.

Значение по умолчанию: 443.

common.ports.mgmt

Порт подсистемы управления.

common.ports.wssh_alt_ssh

Порт WSSH.

Значение по умолчанию: 2222.

common.postgres_host

IP-адрес или доменное имя сервера PostgreSQL.

Значение по умолчанию: localhost.

common.postgres_password

Пароль для подключения к серверу PostgreSQL.

Значение по умолчанию: platform.

common.postgres_port

Номер порта для подключения к серверу PostgreSQL.

Значение по умолчанию: 5432.

common.postgres_username

Имя пользователя для подключения к серверу PostgreSQL.

Значение по умолчанию: platform.

common.tls

Настройки TSL.

common.tls.cert_path

Путь к файлу сертификата TLS.

common.tls.key_path

Путь к файлу приватного ключа сертификата TLS.

common.tls.service_name

Название службы, для которой используется сертификат TLS.

common.vision_ip

IP-адрес сервера подсистемы мониторинга.

Значение по умолчанию: localhost.

foliage_service

Секция foliage_service содержит настройки подключения к подсистеме топологии.

foliage_service.foliage_api.url

URL для доступа к API подсистемы топологии.

foliage_service.foliage_ui.url

URL для доступа к веб-интерфейсу подсистемы топологии.

hosts

Секция hosts описывает топологию кластера и параметры подключения к узлам.

hosts.ansible_ssh_private_key_file

Путь к приватному ключу SSH для подключения к узлам.

hosts.ansible_user

Пользователь, от имени которого Ansible будет подключаться к узлам.

Значение по умолчанию: root.

hosts.manager

Узел, который будет являться менеджером Docker Swarm. Укажите в значении этого параметра IP-адрес установочного узла.

hosts.server_topology

IP-адрес узла, на котором развёрнута подсистема топологии.

hosts.vip

Виртуальный IP-адрес, который будет управляться через keepalived.

Требования к виртуальному IP-адресу:

Должен быть свободен.
Должен принадлежать той же подсети, в которой находятся все узлы кластера.

hosts.vip_interface

Название сетевого интерфейса, которому будет присваиваться виртуальный IP-адрес.

Если значение этого параметра не указано, сетевой интерфейс будет выбран автоматически. Однако, если сетевых интерфейсов несколько, рекомендуется явно указать название нужного.

hosts.vrrp_id

Идентификатор VRRP-группы. Он используется протоколом keepalived для определения принадлежности узлов к одной и той же группе отказоустойчивости.

В пределах одной сети VRRP должен быть уникален.

Возможные значения: от 1 до 255 включительно.

Значение по умолчанию: 51.

hosts.workers

Список воркер-узлов кластера, не менее двух штук. Укажите в значении этого поля перечень IP-адресов узлов.

Не включайте в этот список IP-адрес установочного узла!

migrations

Секция migration содержит настройки миграции данных. Миграции запускаются автоматически при установке и обновлении платформы.

migrations.databases

Список баз данных, к которым нужно применить миграции.

По умолчанию этот список пуст, и миграции применяются ко всем базам данных.

Пример заполнения

# ...
migrations:
  databases:
    - auth_db
    - authz_db

wssh

Секция wssh содержит настройки службы WSSH.

wssh.app

Настройки службы WSSH.

wssh.app.certificate

Путь к файлу сертификата, используемого службой WSSH.

wssh.app.host

IP-адрес, который будет слушать служба WSSH.

Значение по умолчанию: 0.0.0.0 (все IP-адреса узла).

wssh.app.key

Путь к файлу приватного ключа, используемого службой WSSH.

wssh.app.port

Номер порта, который будет слушать служба WSSH.

Значение по умолчанию: 8080.

wssh.app.session_idle_timeout

Время жизни неактивных сессий в секундах.

Значение по умолчанию: 300 (5 минут).

wssh.app.wsport

Номер порта, который будет слушать служба SSH.

Значение по умолчанию: 8022.

wss.jumphost.ca_key

Путь к файлу сертификата, используемого службой SSH на промежуточном узле.

Значение по умолчанию: /etc/ca/private/ca.key.

wssh.jumphost.host_ssh_addr

IP-адрес промежуточного (jump) узла.

wssh.jumphost.host_ssh_port

Номер порта, который будет слушать служба SSH на промежуточном узле.

Значение по умолчанию: 2222.

wssh.jumphost.remote_host_ssh_port

Номер порта, который будет слушать служба SSH на целевых узлах.

Значение по умолчанию: 2222.

wssh.jumphost.ssh_key_dir

Путь к директории с ключами SSH.

Значение по умолчанию: /app/keys.

wssh.logging

Настройки журналирования службы WSSH.

wssh.logging.filepath

Путь к файлу для сохранения журнала работы службы WSSH.

wssh.logging.level

Уровень подробности ведения журнала работы службы WSSH.

wssh.plagent.cert

Использование сертификата при подключении к plagent.

Значение по умолчанию: false (выключено).

wssh.plagent.token

Токен для доступа к агентам платформы.