Создание файла с базовой конфигурацией#

Необходимо создать пустой файл с расширением .yml, в котором требуется прописать следующие параметры и их значения (содержимое конфигурационного файла является группой):

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

  • version

    В значении параметра указывается текущая версия нотации YML. Значение параметра version представляет собой три, разделенных точками, целых числа. Данное значение может отличаться от версии конфигуратора, для которого создается конфигурационный файл. Если версия отличается, то запускается механизм нормализации.

    version: 2.0.3
    

    Версию конфигуратора можно посмотреть, используя CLI команду:

    sowa-config --version
    

    Тип параметра: текстовое значение.

  • profile

    В значении параметра profile определяется имя профиля, для которого создается конфигурация.

    profile: my_profile
    

    Тип параметра: строковое значение.

  • system

    В значении параметра system определяются настройки системных параметров SOWA.

    Тип параметра: группа параметров и их значения.

    • wrk_count

      В значении параметра определяется число рабочих процессов.

      wrk_count: auto
      

      При использовании SOWA в системе контейнеризации Platform V (K8S или Openshift), требуется установить значение, равное "1".

      Для остальных случаев рекомендуется установить значение "auto".

      Тип параметра: текстовое значение.

      Обязательность параметра: нет.

    • conn_count

      В значении параметра определяется максимальное число соединений, которые одновременно может открыть рабочий процесс.

      Следует иметь в виду, что в это число входят все соединения (в том числе, например, соединения с проксируемыми серверами), а не только соединения с клиентами.

      По умолчанию "4096".

      conn_count: 30000
      

      Тип параметра: целочисленное значение.

      Обязательность параметра: нет.

    • optional

      Группа optional используется в параметре system для:

      • определения пользователя и группы, с правами которого будут работать рабочие процессы;

      • указания уровня логирования;

      • вкл./откл. мониторинга статистики;

      • и др.

      Группа, включающая в себя параметры, описанные в разделе "Базовая конфигурация - optional".

  • service

    В группе service определяются типы и количество используемых сервисов.

    • service_http_proxy;

    • service_web_socket_proxy;

    • service_rest_proxy;

    • service_web_service_proxy;

    • service_file_transfer;

    • service_http_mq_proxy;

    • service_http_kafka_proxy;

    • service_stub_file_receiver;

    • service_stub_web_socket;

    • service_stub_http;

    • service_main_proxy;

    • service_static;

    • service_cache;

    • service_gost_proxy;

    • service_sowa_ipa.

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

  • profile_version

    В значении параметра указывается текущая версия профиля. Значение параметра должно соответствовать паттерну:

    ^[A-Za-z0-9\.\-]+$
    
    profile_version: XXX        
    

    Тип параметра: текстовое значение.

  • sowa_version

    В значении параметра указывается минимальная версия СПО части дистрибутива для корректного взаимодействия с ППО.

    sowa_version: D-2.5-5501-8
    

    Тип параметра: текстовое значение.

  • is_outgoing

    Флаг сигнализирует о том, что запросы идут из доверенной зоны во вне контура банка.

    В этом случае не заполняются по умолчанию заголовки Forwarded и X-Real-Ip.

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

    • true;

    • false.

    По умолчанию:

    is_outgoing: false
    

Пример настройки базовой конфигурации:

version: 2.0.3
profile_version: XXX
profile: uko_web
system:
  wrk_count: 4
  conn_count: 4096
  optional:
    thread_pools:
      - id: mq_logger_pool
        threads_num: 1
        max_queue: 100
      - id: uko_web_async_io_pool
        threads_num: 32
        max_queue: 65536
    async_io:
      directio_threshold: 4k
      write: true
      thread_pool_id: uko_web_async_io_pool
    wrk_user: sowactl
    underscores_in_headers: true
    log_level: debug
service:
  service_main_proxy:
    - id: 1
      ...