Руководство по установке продукта Platform V Product Pricing#

Этот документ предназначен для администраторов продукта Platform V Product Pricing (далее Продукт), которые обеспечивают работоспособность Продукта на стороне технологической платформы Platform V.

Руководство используется в следующих случаях:

• при установке или обновлении Продукта;

• при обновлении фабрики-потребителя.

Термины#

Сокращения#

Системные требования#

Продукт состоит из следующих модулей:

• Конструктор Правил (pricing-ide-war). Предоставляет пользовательский интерфейс для работы с правилами тарификации (создание / редактирование / публикация).

• Расчетный модуль (pricing-service-war). Производит расчет правил тарификации.

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

Перед установкой Продукта убедитесь, что выполнены следующие условия:

1. Обязательной установке подлежат:

   • ОС Linux (рекомендован ОС «Альт 8 СП»);

   • сервер приложений WildFly;

   • имеется база данных продукта, а также пользователь и пароль к ней. Также необходим пользователь-владелец схемы, через него запускается обновление БД. Предполагается, что все действия по инициализации схемы данных пользователя были сделаны заранее;

   • имеется доступ на чтение к базе данных справочников (ЕКПиТ), а также пользователь и пароль к ней. Предполагается, что все действия по инициализации схемы данных пользователя были сделаны заранее, а таблицы в БД не являются пустыми;

   • установлен SPAS;

   • установлен СУДИР;

   • установлен web-браузер (Яндекс.Браузер версии не ниже 19.10.1).

2. Опциональная установка/использование следующих компонентов, производится по усмотрению потребителя:

   • доступ на чтение к базе данных справочников (ЕКПиТ), а также пользователь и пароль к ней. Предполагается, что все действия по инициализации схемы данных пользователя были сделаны заранее, а таблицы в БД не являются пустыми;

   • Компонент Прикладной журнал (APLJ) продукта Platform V Data Tools;

   • Продукт Platform V One-Time-Token (OTT);

   • Компонент Аудит (AUDT) продукта Platform V Audit SE;

   • Компонент Журналирование (LOGA) продукта Platform V Monitor;

   • Компонент Объединенный мониторинг (MONA) продукта Platform V Monitor;

   • Компонент Авторизация (AUTZ) продукта Platform V IAM SE;

   • Компонент IAM Proxy (AUTH) продукта Platform V IAM SE (реализует аутентификацию и авторизацию).

Аппаратные требования#

В качестве клиентской части Конструктора Стратегий Продукта используется АРМ, реализуемое по технологии «тонкого» клиента (web-интерфейс). Минимальные требования к составу оборудования системного блока типового АРМ по web-технологии и их характеристики:

• процессор — Pentium III;

• объем оперативной памяти — 512 Мб;

• сетевая карта;

• видеокарта — SVGA 32 Мб с поддержкой видео режима с глубиной цвета не хуже HiColor (65536 цветов);

• жёсткий диск — 10 Гб;

• мониторы с разрешающей способностью не менее 1024х768 пикселей.

Программные требования#

Требования к ПО:

• сервер приложений WildFly (лицензия LGPL2.1) 10.1.0.Final;

• клиент liquibase (нужен только на время развертывания);

• OpenJDK рекомендуется использовать версию 1.8

Функционирование 3-го поколения обеспечивается разворачиванием приложения на сервере приложений (WildFly). При разворачивании используются платформенные сервисы. В транспорте (ММТ) выполняется регистрация API, которые обслуживают вызовы, приходящие по ММТ.

Необходимые компоненты для корректной установки Продукта#

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

<dependencies>
    <module name="org.dom4j"/>
    <module name="deployment.custodian-distr-impl-ear.ear" services="import" optional="true"/>
    <module name="deployment.logger-platform-${version}.war" optional="true"/>
    <module name="deployment.seap-lib-${version}.ear" meta-inf="import" services="import" optional="true" />
</dependencies>

Seap_lip

Для того, чтобы выполнить установку Seap_lip:

1. Скопируйте файл seap-lib*.ear, расположенный в party-дистрибутиве, в папке lib-overlay на сервер WildFly.

2. Выполните разархивацию.

unzip -q seap-lib*.ear -d <your seap-lib dir >

3. В распакованной директории выдайте разрешение на исполнение к файлам с расширением sh.

chmod +x ${SEAP_LIB_DIR}/*.sh

4. Убедитесь, что в окружении заведен env JBOSS_HOME. В случае отсутствия добавьте, пример: export JBOSS_HOME=/opt/wildfly.

5. Вызовите скрипт.

create-overlay.sh

6. В результате чего произойдет добавление библиотек в WildFly.

7. Подключите зависимости в инсталляцию приложения.

. jboss-cli.sh --connect --command="deployment-overlay link --name=seap-lib-<version>--deployments=<имя инсталляции приложения, пример: pricing-service-war >

Подробное описание содержится в документации WildFly.

Установка#

Подготовка к развертыванию сервера приложений#

Пререквизитом для установки Продукта является установка и настройка следующих продуктов/компонентов, использование которых носит опциональный характер:

• Platform V Configuration;

• компонент Журналирование (LOGA) продукта Platform V Monitor;

• Platform V Audit SE.

Кроме того, необходимо, чтобы было настроено Единое Информационное Пространство.

В рамках установки Продукта (Расчетного модуля) использованы конфигурационные файлы, где прописаны все интеграции, дополнительных действий администратора не предполагается. Обязательные и необязательные параметры по установке указаны ниже по документу.

Настройка сервера приложений#

Настройка сервера приложений для работы с БД модуля Конфигуратор#

Чтобы Продукт загружал конфигурационные настройки системных модулей Платформы и свои бизнес-параметры, в настройках сервера приложений (WildFly/bin/standalone.conf) пропишите параметры подключения к БД модуля Конфигуратор. При этом сам модуль Конфигуратор должен быть заранее установлен, выполнены все скрипты БД, входящие в состав дистрибутива модуля Конфигуратор (в том числе скрипты, создающие учетную запись пользователя для чтения конфигурационных параметров).

Создание источников данных#

В конфигурационном файле WildFly/standalone/configuration/standalone.xml пропишите драйвер для подключения к БД, в секцию <datasources> для <subsystem xmlns="urn:jboss:domain:datasources:4.0">.

  <drivers>
  <driver name="postgresql" module="org.postqres">
  <driver-class>org.postqresql.Driver</driver-class>
  </driver>
  </drivers>

Для источника данных Platform V Product Pricing в конфигурационный файл добавьте строки с параметрами, пример которых показан в коде ниже:

<xa-datasource jndi-name="java:/jdbc/pricing" pool-name="IFT_PricingDS" enabled="true" use-ccm="true">
<xa-datasource-property name="URL">jdbc:postgresql://10.53.238.164:6543/dp?prepareThreshoId=0</xa-datasource-property>
<xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class>
<driver>postgresql</driver>
<xa-pool>
<is-same-rm-override>false</is-same-rm-override>
<no-tx-separate-pools>true</no-tx-separate-pools>
</xa-pool>
<security>
<user-name>PRICING_SERVICES_APPL</user-name>
<password>PRICING_SERVICES_APPL</password>
</security>

Для источника данных ЕКПиТ, должен быть добавлен конфигурационный файл со следующими параметрами:

<xa-datasource jndi-name="java:/jdbc/ekpit" pool-name="ekpitDataBaseDS" enabled="true" use-ccm="true">
<xa-datasource-property name="URL">
jdbc:dbserver:thin:@grid1655.maindomain.mycompany.ru:1521:db18
</xa-datasource-property>
<xa-datasource-class>postgresql.jdbc.xa.client.DatabaseXADataSource</xa-datasource-class>
<driver>postgresql</driver>
<xa-pool>
<is-same-rm-override>false</is-same-rm-override>
<no-tx-separate-pools>true</no-tx-separate-pools>
</xa-pool>
<security>
<user-name>EKPIT</user-name>
<password>EKPIT</password>
</security>
</xa-datasource>

В конфигурации приложения (Конфигуратор или platform-config.properties) укажите следующие параметры (если они отличаются от принятых по умолчанию):

Если предусмотрена работа в режиме StandIn, добавьте следующие параметры:

Установка web-приложений на сервер WildFly#

Перед установкой приложений установите библиотеку seap-lib. Для корректной работы Продукта необходим overlay – seap-lib-8.1. Установка приложений представляет собой развертывание *.war-пакетов на сервер приложений:

• Конструктор Стратегий: pricing-ide-war-<номер_версии>.war;

• Расчетный Модуль: pricing-service-war-<номер_версии>.war.

Инструкции о способах развертывания war-пакетов можно найти в документации WildFly.

Конфигурация развернутых приложений#

В комплекте поставки в директории configuration идут следующие файлы с определением конфигурационных параметров:

• pricing-ide-config-struct.xml: файл конфигурации Конструктора Стратегий Продукта;

• pricing-service-config-struct.xml: файл конфигурации Расчетного Модуля Продукта.

Таблица ниже содержит конфигурационные параметры Расчетного Модуля.

Таблица ниже содержит конфигурационные параметры Конструктора Правил.

Для работы с Конструктором Стратегий Продукта требуется иметь идентифицированных пользователей с набором ролей. Роль представляет собой набор прав (грантов) на выполнение определенных действий.

Список функциональных прав, используемых в Конструкторе стратегий:

Настройка пространства WildFly#

Для того чтобы установить PostgreSQL jdbc-driver и добавить источник данных:

1. Воспользуйтесь драйвером из дистрибутива ojdbc.jar: \sbt-spb-fsrv-01\OAVSP\Distrib\Servers\ojdbc;

2. Создайте директорию [WILDFLY_HOME]/modules/system/layers/base/com/postgresql/main/;

3. Скопируйте в созданную директорию ojdbc.jar;

4. Создайте файл module.xml в той же директории и добавьте:

   <?xml version="1.0" encoding="UTF-8"?>
    <module xmlns="urn:jboss:module:1.3" name="org.postqres">
   
     <resources>
        <resource-root path="ojdbc6.jar"/>
     </resources>
     <dependencies>
        <module name="javax.api"/>
        <module name="javax.transaction.api"/>
     </dependencies>
   </module>
   

5. В конфигурационном файле standalone/configuration/standalone.xml добавьте в тег следующее описание:

   <driver name="postgresql" module="org.postqres">
       <driver-class>org.postqresql.Driver</driver-class>
   </driver>
   

6. Добавьте источник данных в после ExampleDS:

 <xa-datasource jndi-name="java:/jdbc/pricingDS" pool-name="pricingDS" enabled="true" use-ccm="true">
        <xa-datasource-property name="URL">
              jdbc:postgresql:@10.68.24.101:1521:filtes
        </xa-datasource-property>
        <xa-datasource-class>org.postqresql.xa.PGXADataSource</xa-datasource-class>
        <driver>postgresql</driver>
 	   <xa-pool>
             <min-pool-size>1</min-pool-size>
             <initial-pool-size>1</initial-pool-size>
             <max-pool-size>10</max-pool-size>
             <is-same-rm-override>false</is-same-rm-override>
             <no-tx-separate-pools>true</no-tx-separate-pools>
        </xa-pool>
        <security>
             <user-name>SERVICE_PACKAGE</user-name>
             <password>SERVICE_PACKAGE</password>
        </security>
 </xa-datasource>

Взаимодействие с СУДИР#

Интеграция с СУДИР реализована на уровне back-части платформы (модуль Технологического Ядра).

Метрики#

Реализован сбор метрик модуля pricing-service.

Метрики pricing-service

Задача тестирования инсталляции#

Создание job Jenkins по запуску smoke-тестов.

Создание job Jenkins по запуску smoke-тестов#

При установке необходимо использовать скрипт соответствующий версии дистрибутива, чтобы скрипт и дистрибутив находились в соответствии.

Для создания job Jenkins:

1. В Jenkins создайте задачу типа "Pipeline".

2. В секции Pipeline в поле Definition выберите Pipeline script from SCM.

3. В поле SCM выберите Git.

4. Укажите адрес к репозиторию с сохраненной задачей, а также имя, где сохранена задача, также указываем имя Credentials в jenkins для доступа к этому репозиторию.

5. В поле Branches to build укажите ветку, в которой находится скрипт задачи.

6. В поле Script Path укажите путь до файла скрипта.

7. Сохраните изменения.

Описание скрипта запуска тестов (Jenkinsfile)#

Для запуска smoke тестов нужно использовать созданную ранее задачу Jenkins.

Для этой job нужно указать следующие параметры:

1. standType — имя стенда, для которого будут запущены тесты.

2. artifactUrl — ссылка на дистрибутив из Nexus.

3. Опциональное значение ветки репозитория, из которой будем брать параметры и секреты. Если значение не указано явным образом, будет использовано значение ветки по умолчанию (параметр secretAndParametersRepoBranch).

В процессе работы задачи будут выполнены следующие действия:

1. Запущены тесты для кластера и на geo-балансировщик с поддержкой ОТТ.

2. Запущены тесты для кластера и на geo-балансировщик без ОТТ.

Создание keystore и truststore ОТТ#

Для доступа к серверу ОТТ понадобится сертификат, ключ и цепочка сертификатов.

Для выпуска сертификата ОТТ нужно выполнить следующие шаги:

1. Получить публичный сертификат. Публичные сертификаты сервера ОТТ выдаются по ЗНО. Нужно обращаться к администраторам ТЯ.

2. Получить приватный сертификат. В качестве module.id указать значение: pricing-service-cloud-test.

3. После выполнения шагов должно быть получено два файла (имена могут отличаться от указанных ниже примеров):

   • ott_service_truststore.p12 — публичная часть (truststore);

   • pricing-service.p12 — приватная часть (keystore).

4. Переименовать файлы на ott-truststore.p12 и ott-keystore.p12.

5. Сохранить файлы в репозитории в каталоге test-resources в директории с секретами ${secretConfigurationPath}.

Создание keystore и truststore TLS#

Корневой и промежуточный доверенные сертификаты выданы тестовым удостоверяющим центром Компании. Для промышленных стендов удостоверяющий центр должен быть не тестовым. Поэтому часть файлов будет называться по-другому.

Для выпуска сертификата TLS:

1. Создайте конфигурацию запроса на сертификат.

[ req ]
default_bits       = 2048
distinguished_name = req_distinguished_name
req_extensions     = req_ext
prompt = no
 
[ req_distinguished_name ]
countryName                 = RU
stateOrProvinceName         = MOW
localityName                = MOW
organizationName            = MYCOMPANY
commonName                  = pricing-service-cloud-test
 
[ req_ext ]
subjectAltName = @alt_names
 
[alt_names]
DNS.1   = pricing-service-cloud-test

2. Сформируйте request.csr.

openssl req -out request.csr -newkey rsa:2048 -nodes -keyout tls.key -config request.cnf

3. Оформите ЗНО через ServiceManager, прикладывая файл request.csr. При этом нужно обязательно запросить создание клиентского сертификата.

4. После получения ответа, скопируйте файл request.cer (подписанный сертификат в формате DER), и цепочку сертификатов, которым он подписан.

5. Преобразуйте полученный сертификат в формат PEM.

openssl x509 -inform DER -in request.cer -out tls.crt

6. Создайте хранилище keystore.

openssl pkcs12 -export -inkey tls.key -out keystore.p12 -in tls.crt

7. Преобразуйте keystore из формата PKCS12 в JKS.

keytool -importkeystore -destkeystore keystore.jks -srckeystore keystore.p12 -srcstoretype PKCS12

8. Измените пароль приватного ключа.

keytool -keypasswd -keystore keystore.jks -alias 1

9. Измените алиас сертификата.

keytool -changealias -alias 1 -destalias pricing-service-cloud-test -keystore keystore.jks

10. Преобразуйте полученный корневой сертификат в формат PEM.

openssl x509 -inform DER -in "Test Root CA 2.cer" -out "Test Root CA 2.crt"

11. Преобразуйте полученный промежуточный сертификат в формат PEM.

openssl x509 -inform DER -in "Sberbank Test Issuing CA 2.cer" -out "Sberbank Test Issuing CA 2.crt"

12. Создайте хранилище truststore.jks и добавить в него доверенный корневой сертификат.

keytool -import -keystore truststore.jks -file "Test Root CA 2.crt" -alias root-ca -noprompt

13. Добавьте в truststore.jks промежуточный доверенный сертификат.

keytool -import -keystore truststore.jks -file "Sberbank Test Issuing CA 2.crt" -alias chain-ca -noprompt

14. Сохраните файлы в репозитории в каталоге test-resources в директории с секретами ${secretConfigurationPath}`.

Получаем два файла:

• keystore.jks — приватный ключ и сертификат

• truststore.jks — доверенные сертификаты

Обновление файла passwords.properties паролями от хранилищ и ключей#

В файле хранятся пароли к БД для запуска liquibase, а также пароли к хранилищам сертификатов и ключей для запуска job тестирования. Файл шифруется тем же способом, и с тем же паролем, что и секреты для среды контейнеризации Kubernetes или Red Hat OpenShift 4+ с помощью ansible-vault. Файл passwords.properties следует разместить в том же каталоге, в котором находятся секреты для среды контейнеризации Kubernetes или Red Hat OpenShift 4+ в зашифрованном виде — ${secretConfigurationPath}.

В файл passwords.properties нужно добавить пароли для созданных хранилищ и ключей:

...
ott.certstore.pwd=111111
ott.trust.store.pwd=111111
ott.certstore.private.key.pwd=111111
transport.rest.ssl.keystore.password=2222222
transport.rest.ssl.private.key.password=111111
transport.rest.ssl.truststore.password=111111

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

• ott.certstore.pwd — пароль для доступа к хранилищу сертификатов ОТТ.

• ott.trust.store.pwd — пароль доступа к хранилищу доверенных сертификатов ОТТ.

• ott.certstore.private.key.pwd — пароль доступа к приватному ключу ОТТ

• transport.rest.ssl.keystore.password — пароль для доступа к хранилищу сертификатов.

• transport.rest.ssl.private.key.password — пароль доступа к приватному ключу.

Обновление#

Обновление осуществляется так же, как первоначальная установка: запускается задача установки с параметром updateMode = fullInstall. В процедуру установки включен процесс обновления базы данных с помощью утилиты liquibase. Установку новой версии продукта необходимо осуществлять согласно описанным шагам в разделе Установка текущего документа. Дополнительных настроек не требуется.

Проверка работоспособности установки#

Для проверки корректности установки, проверьте, что задача установки завершилась со статусом SUCCESS (успешно).

Проверка работоспособности осуществляется путем:

• unit-теста и проверки доступности базы данных;

• выполнение автотестов и smart регрессов.

Откат#

Автоматической процедуры отката нет.

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

Часто встречающиеся проблемы и пути их устранения#

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

Чек-лист валидации установки#

После установки необходимо проверить:

• для проекта в WildFly создались объекты приложений.

• логи на отсутствие ошибок, логи можно наблюдать в централизованной системе управления.