Сценарии администрирования EVPC#

Предусловия#

Предусловия для выполнения сценария представлены индивидуально для каждого сценария администрирования при необходимости.

Правила эксплуатации#

Не применимо.

Описание механизмов безопасности#

Не применимо.

Последовательность выполнения#

Сценарий 1. Запуск EVPC#

Операция запуска EVPC не производится. Предусмотрена только операция установки, описанная в документе «Руководство по установке» в разделе «Установка EVPC».

Получение данных по установленным компонентам продукта#

Для получения данных по установленным компонентам продукта можно воспользоваться утилитой discovery_component.py.

Если на стороне компонента соответствующий порт для компонента уже занят, то будет открыт следующий первый свободный порт. Утилита discovery_component.py принимает на вход название компонента и опционально IP адрес, маску подсети, discovery порт, значение таймаута и флаг расширенного логирования.

При запуске происходит выборка целевых IP адресов по IP адресу и маске подсети. По каждому IP адресу последовательно производится проверка на доступность интересующего порта и валидность возвращаемого ответа на запрос /discovery. По мере сканирования в стандартный вывод консоли возвращается информация о найденных установленных компонентах.

Для использования утилиты необходимо выполнить команду:

discovery_component.py [-h] --component COMPONENT [--discovery-port DISCOVERY_PORT] [--mask MASK] [--ip IP] [--closed-port-threshold CLOSED_PORT_THRESHOLD] [--timeout TIMEOUT] [--verbose]

Аргументы:

Пример возвращаемых данных компонента EVPC при обращении на discovery порт:

{
    'product': 'EM',
    'component': 'EVPC',
    'version': '3.2.0',
    'cpuCount': '4'
    }

Подробнее с параметрами утилиты можно ознакомиться в файле README.txt, размещенном в папке discovery архива EM-*-metadata-distrib.zip в пакете продукта EM-*-distrib.zip.

Сценарий 2. Остановка EVPC#

Операция остановки EVPC не производится. Предусмотрена только операция удаления, описанная в документе «Руководство по установке» в разделе «Удаление EVPC».

Сценарий 3. Перезапуск EVPC#

Операция перезапуска EVPC не производится. Предусмотрены только операции установки и удаления, описанные в документе «Руководство по установке».

Сценарий 4. Подключение стандарта OpenTelemetry для EVPC#

Подключение стандарта OpenTelemetry выполняется с использованием логической роли «Администратор».

Настройки подключения#

1. При подключении OpenTelemetry используется аргумент запуска обработчика:

2. Для настройки OpenTelemetry необходимо в файле vars.yaml задать параметры:

• название файла (параметр является необязательным):

# Имя файла конфигурации телеметрии
telemetryConfig: "telemetry.json"

• настройки конфигурации (для корректной работы Open Telemetry необходимо указать host экспортера endpoint и имя сервиса service.name):

# Конфигурация для Open Telemetry
  telemetry:
    config:
      file_format: "0.1"
      resource:
        attributes:
          service.name: "<имя сервиса>"
      propagators: [ tracecontext ]
      tracer_provider:
        processors:
          - simple:
             exporter:
                otlp:
                  endpoint: http://<host>:<port>
        sampler:
          always_on: { }

3. При установке компонента EVPC автоматически сформируется файл telemetry.json, в котором задаются параметры endpoint и имя сервиса service.name из файла vars.yaml.

Пример конфигурации Open Telemetry в формате JSON#

{
  "file_format": "0.1",
  "tracer_provider": {
    "processors": [
      {
        "simple": {
          "exporter": {
            "otlp": {
              "endpoint": "http://<host>:<port>"
            }
          }
        }
      }
    ],
    "sampler": {
      "always_on": {}
    }
  },
  "propagators": [
    "tracecontext"
  ],
  "resource": {
    "attributes": {
      "service.name": "<имя сервиса>"
    }
  }
}

Атрибуты трассировки#

Сценарий 5. Создание конфигурационных дистрибутивов для EVPC#

Создание конфигурационных дистрибутивов выполняется с использованием логической роли «Администратор».

При помощи Jenkins#

Создание конфигурационных дистрибутивов осуществляется с помощью задания Jenkins evpc_image_create. Процесс создания задания Jenkins приведен в документе «Руководство по установке», раздел «Создание Jenkins Job для автоматической установки EVPC».

Основные параметры:

• job_config_renew — отвечает за обновление Jenkins Job. При установке приложения должен быть выключен (false). Для обновления текущих параметров и сохранения значений по умолчанию должен быть включен (true);

• nexusDownloadImageRegistry — полный путь до registry, для скачивания базового образа дистрибутива;

• nexusUploadImageRegistry — полный путь до registry, для публикации конфигурационного образа дистрибутива;

• DownloadRegistryUrl — URL registry, определяется автоматически из nexusDownloadImageRegistry, при необходимости заполнить вручную;

• UploadRegistryUrl — URL registry, определяется автоматически из nexusUploadImageRegistry, при необходимости заполнить вручную;

• customChartName — произвольный .Chart.Name (используется в имени манифестов, теге конфигурационного образа и имени дистрибутива ./EVPC-cfg-[version]-distrib.zip);

• nexusDownloadCfgUrl — ссылка на скачивание дистрибутива ./EVPC-cfg-[version]-distrib.zip облачных скриптов развертывания из Nexus;

• nexusUploadCfgUrl — ссылка на пространство, для публикации дистрибутива ./EVPC-cfg-[version]-distrib.zip облачных скриптов развертывания в Nexus;

• istioProxyHash — hach-сумма образа c Istio для фиксации ее в процессе развертывания граничного прокси;

• nexus_user_cred — Jenkins Username With Password Credential ID для скачивания конфигурационного дистрибутива в Nexus. Чтобы получить username и password для Nexus из HashiCorp Vault, необходимо заполнить параметр secman_url в формате: JenkinsCredID |SecManPath:SecManKeys|SecManParams, где:

  • JenkinsСredID — Jenkins Vault App Role Credential ID c реквизитами для подключения к HashiCorp Vault;

  • SecManPath — путь к секретам в HashiCorp Vault;

  • SecManKeys — имена полей для username и password в HashiCorp Vault (через запятую);

  • SecManParams — параметры для подключения к HashiCorp Vault (через точку с запятой). Если данные параметры по умолчанию, то пропускаются вместе с «|». Примеры:

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password;

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password|engineVersion:2;

• nexus_user_cred_download_image — Jenkins Username With Password Credential ID для загрузки исходного образа из Nexus. При указании поля пустым, будет использоваться значение параметра nexus_user_cred. Чтобы получить username и password для Nexus из HashiCorp Vault, необходимо заполнить параметр secman_url в формате: JenkinsCredID |SecManPath:SecManKeys|SecManParams, где:

  • JenkinsСredID — Jenkins Vault App Role Credential ID c реквизитами для подключения к HashiCorp Vault;

  • SecManPath — путь к секретам в HashiCorp Vault;

  • SecManKeys — имена полей для username и password в HashiCorp Vault (через запятую);

  • SecManParams — параметры для подключения к HashiCorp Vault (через точку с запятой). Если данные параметры по умолчанию, то пропускаются вместе с «|». Примеры:

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password;

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password|engineVersion:2;

• nexus_user_cred_upload_image — Jenkins Username With Password Credential ID для публикации нового образа в Nexus. При указании поля пустым, будет использоваться значение параметра nexus_user_cred. Чтобы получить username и password для Nexus из HashiCorp Vault, необходимо заполнить параметр secman_url в формате: JenkinsCredID |SecManPath:SecManKeys|SecManParams, где:

  • JenkinsСredID — Jenkins Vault App Role Credential ID c реквизитами для подключения к HashiCorp Vault;

  • SecManPath — путь к секретам в HashiCorp Vault;

  • SecManKeys — имена полей для username и password в HashiCorp Vault (через запятую);

  • SecManParams — параметры для подключения к HashiCorp Vault (через точку с запятой). Если данные параметры по умолчанию, то пропускаются вместе с «|». Примеры:

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password;

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password|engineVersion:2;

• nexus_user_cred_distr — Jenkins Username With Password Credential ID для публикации нового конфигурационного дистрибутива в Nexus. При указании поля пустым, будет использоваться значение параметра nexus_user_cred. Чтобы получить username и password для Nexus из HashiCorp Vault, необходимо заполнить параметр secman_url в формате: JenkinsCredID |SecManPath:SecManKeys|SecManParams, где:

  • JenkinsСredID — Jenkins Vault App Role Credential ID c реквизитами для подключения к HashiCorp Vault;

  • SecManPath — путь к секретам в HashiCorp Vault;

  • SecManKeys — имена полей для username и password в HashiCorp Vault (через запятую);

  • SecManParams — параметры для подключения к HashiCorp Vault (через точку с запятой). Если данные параметры по умолчанию, то пропускаются вместе с «|». Примеры:

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password;

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password|engineVersion:2;

• configManualUpload — загрузка конфигурационного дистрибутива вручную; если значение «false» то конфигурация будет скачиваться из Git и необходимо заполнить параметры: issueID, gitPath, gitUrl, gitCred, gitBranch;

• issueID — поле для указания номера задачи (пример: XXXX-12345);

• gitPath — путь до файлов конфигурации в репозитории;

• gitUrl — ссылка на репозиторий;

• gitCred — Jenkins Username With Password Credential ID или Jenkins SSH Username With private key Credential ID для выкачивания конфигурационных файлов из Bitbucket. Чтобы получить username и password для Nexus из HashiCorp Vault, необходимо заполнить параметр secman_url в формате: JenkinsCredID|SecManPath:SecManKeys|SecManParams, где:

  • JenkinsCredID — Jenkins Vault App Role Credential ID с реквизитами для подключения к HashiCorp Vault;

  • SecManPath — путь к секретам в HashiCorp Vault;

  • SecManKeys — имена полей для username и password в HashiCorp Vault (через запятую);

  • SecManParams — параметры для подключения к HashiCorp Vault (через точку с запятой). Если данные параметры по умолчанию, то пропускаются вместе с «|». Примеры:

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password;

    • SecManAppRoleCred|/CI01994970_CI02618129_ES/A/DEV/APP/JEN/KV/nexus:username,password|engineVersion:2;

• gitBranch — ветка репозитория;

• secman_url — URL для подключения к HashiCorp Vault;

• ssl_verify — проверка, являются ли сертификаты HashiCorp Vault/Nexus доверенными;

• jenkinsSlaveNode — метка слейвов Jenkins для сборки;

• emailTo — список адресов электронной почты для отправки результатов (письмо исполнителю отправится автоматически);

• ansible_branch — ветка скриптов развертывания (в настройках Jenkins указать ${ansible_branch}).

В процессе выполнения задания Jenkins выходит сообщение «Необходимо загрузить архив с конфигурациями обработчика», после чего в поле для отправки архивов необходимо загрузить архив с конфигурацией обработчика.

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

Задание Jenkins автоматически прописывает пути до конфигураций обработчиков, полученных из архива, в конфигурационный дистрибутив.

Сценарий 6. Просмотр событий системного журнала и событий мониторинга для EVPC#

Просмотр событий системного журнала и событий мониторинга выполняется с использованием логической роли «Администратор».

Просмотр событий мониторинга#

Подробнее в разделе Мониторинг EVPC.

Просмотр событий системного журнала#

Подробнее в разделе Системный журнал EVPC.

Сценарий 7. Конфигурация универсального обработчика EVPC#

Конфигурация обработчика состоит из 3 частей:

1. Описание графа потока обработки событий, представляет собой бизнес логику обработки и является общей для Flink и Pekko Streams.

2. Зависимые от стенда параметры графа обработки, содержит параметры подключения к транспорту и другим внешним ресурсам.

3. Параметры среды исполнения, специальные параметры для обработчика на Pekko Streams, содержит настройки системы акторов и другие параметры приложения.

Описание графа обработки событий#

Описание графа обработки событий аналогично обработчику на Apache Flink и описано в документе Руководство пользователя EVPC в разделе «Конфигурация потока трансформации».

Описание специфичных для стенда параметров потока обработки#

Описание специфичных для стенда параметров или defaults аналогично обработчику на Apache Flink.

Описание параметров среды исполнения#

Параметры можно передать файлом reactive.conf в формате HOCON через аргумент --reactiveConfig (короткий вариант -rc) или через переменные окружения. Переменные окружения будут перезаписывать параметры из файла reactive.conf.

Общие настройки приложения#

Настройки пулов потоков системы акторов#

Настройки хранилища агрегации в топик Kafka#

При значении storage.type равной kafka.

Настройки хранилища агрегации с использованием EVTA#

При значении storage.type равной grpc.

Для того, чтобы вызов EVTA был защищенным, возможно использование параметров с префиксом storage.grpc.

Настройки хранилища агрегации в базе данных#

Настройки хранилища агрегации для PostgreSQL и Apache Ignite#

При значении storage.type равной database.

Для того, чтобы подключение к базе данных было защищенным возможно использование параметров:

• для PostgreSQL — с префиксом storage.database. и указание storage.database.sslfactory значения ru.sbt.cep.flow.event.process.config.parsing.flow.step.storage.postgresql.PostgresqlSslFactory;

• для Apache Ignite — возможно использование параметров с префиксом storage.database. и указанием storage.database.sslEnabled значения true и указанием storage.database.sslFactory значения ru.sbt.cep.flow.event.process.config.parsing.flow.step.storage.ignite.IgniteSslFactory.

Настройки хранилища агрегации для Apache Cassandra#

При значении storage.type равной timeseries.

Использование EVPT в качестве механизма создания триггеров для агрегации#

Если в конфигурации указаны параметры, начинающиеся с префикса scheduler.,то триггеры для агрегации будут получены с EVPT, иначе будет использоваться внутренний механизм с использованием quartz.

Для того, чтобы вызов EVPT был защищенным, возможно использование параметров с префиксом scheduler..

Аналогично, чтобы внутренний сервер, принимающий вызовы от EVPT, для последующего срабатывания триггера был запущен с SSL-контекстом возможно использование параметров с префиксом scheduler.flow..

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

Настройки Health check#

Чтобы healthCheck сервер был запущен с SSL-контекстом, возможно использование параметров с префиксом healthCheck..

Настройки метрик JMX#

Настройки метрик Influx#

Настройки метрик Prometheus#

Пример настройки аудита#

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

Настройки dead letter#

Используются для отправки событий, во время обработки которых произошла ошибка.

Результат#

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