Установка веб-интерфейса компонента Kintsugi (DBCM)#

Ручная установка#

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

Для ручной установки веб-интерфейса компонента Kintsugi (DBCM) выполните следующие этапы:

1. Распакуйте дистрибутив Kintsugi (DBCM).

2. Выполните настройку системных баз данных, для этого настройте:

   1. БД метаданных Platform V Pangolin DB (или PostgreSQL).

   2. БД хранения порогов метрик.

   3. БД мониторинга TimescaleDB (или VictoriaMetrics).

   4. БД агента сбора и хранения метрик.

   5. БД хранения отчетов нотификации.

   6. БД персистентного хранилища метрик загрузки и производительности (dbperf).

3. Выполните настройку режима работы Kintsugi с сервисами хранения данных о метриках.

4. Выполните установку Kintsugi в Kubernetes/Platform V DropApp (K8S) или Red Hat OpenShift.

Настройка системных баз данных Kintsugi#

Настройка инструмента инсталляции системных БД Kintsugi#

В качестве инструмента инсталляции используется ПО Liquibase 4.29.2 (поставляется в составе дистрибутива).

Для запуска Liquibase выполните одно из следующих действий:

• Сконфигурируйте файл liquibase.properties.

  Параметр	Пример	Описание
  changelogFile	/path/to/changelog/db_changelog_example.xml	Файл с историей изменений БД
  url	jdbc:postgresql://<ХОСТ_БД>:<ПОРТ_БД>/<ИМЯ_БД>	Адрес устанавливаемой (обновляемой) БД
  username	<ИМЯ_ПОЛЬЗОВАТЕЛЯ>	Имя пользователя БД
  password	<ПАРОЛЬ>	Пароль пользователя БД
  defaultSchemaName	<ИМЯ_СХЕМЫ_БД>	Имя схемы системной таблицы Liquibase. Системная таблица Liquibase и таблицы прикладной БД должны располагаться в одной схеме

  Пример конфигурации:

  changelogFile: /path/to/changelog/db_changelog_example.xml
  url: jdbc:postgresql://host_example:port_example/db_example
  username: {username_example}
  password: {password_example}
  defaultSchemaName: {schema_example}
  

• Передайте параметры конфигурации через командную строку согласно документации разработчика Liquibase.

Настройка БД метаданных Platform V Pangolin DB (или PostgreSQL)#

1. Создайте технического пользователя kintsugi для БД метаданных:

   Примечание

   Используйте учетную запись администратора СУБД для дальнейшего развертывания.

   CREATE USER kintsugi PASSWORD 'password';
   

2. Создайте БД для метаданных:

   CREATE DATABASE <meta_db_name>;
   

3. Подключитесь к БД метаданных <meta_db_name>:

   \c <meta_db_name>;
   

4. Создайте в БД метаданных <meta_db_name> схему meta:

   CREATE SCHEMA meta;
   

5. Измените путь поиска по умолчанию на схему meta:

   set schema 'meta';
   

6. Распакуйте содержимое архива db_scripts_repository.zip.

7. Выполните конфигурацию файла liquibase.properties:

   Пример конфигурации:

   changelogFile: /path/to/changelog/repository/master_changelog.xml
   url: jdbc:postgresql://meta_host:meta_port/meta_db
   username: {username_example}
   password: {password_example}
   defaultSchemaName: meta
   

   Примечание

   Описание конфигурации приведено в разделе «Настройка инструмента инсталляции системных БД Kintsugi».

8. Выполните команду установки БД репозитория:

   ./liquibase update
   

9. Выполните команду проверки состояния БД:

   ./liquibase history
   

10. Установите тег текущей версии Kintsugi для реализации возможности отката к текущему состоянию БД:

    ./liquibase tag --tag=<ТЕКУЩАЯ_ВЕРСИЯ_KINTSUGI>
    

11. Добавьте права техническому пользователю kintsugi:

    GRANT CONNECT ON DATABASE <meta_db_name> TO kintsugi;
    GRANT USAGE ON SCHEMA meta TO kintsugi;
    
    ALTER DEFAULT PRIVILEGES IN SCHEMA meta
    GRANT ALL ON FUNCTIONS TO kintsugi;
    ALTER DEFAULT PRIVILEGES IN SCHEMA meta
    GRANT SELECT, UPDATE, USAGE ON SEQUENCES TO kintsugi;
    ALTER DEFAULT PRIVILEGES IN SCHEMA meta
    GRANT ALL ON TABLES TO kintsugi;
    ALTER DEFAULT PRIVILEGES IN SCHEMA meta
    GRANT USAGE ON TYPES TO kintsugi;
    

12. Измените путь поиска по умолчанию:

    ALTER USER kintsugi SET search_path TO meta;
    ALTER DATABASE <meta_db_name> SET search_path TO meta;
    

13. Для настройки сетевого доступа к хранилищу PostgreSQL выполните конфигурацию pg_hba.conf.

    Примечание

    Используйте учетную запись администратора ОС.

    Пример конфигурации аутентификации технической учетной записи kintsugi с использованием сертификатов:

    hostssl all kintsugi 0.0.0.0/0 cert clientcert=1
    

    Формат добавления пользователя и метод его аутентификации указан ниже:

    local      база  пользователь  метод-аутентификации  [параметры-аутентификации]
    host       база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    hostssl    база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    hostnossl  база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    host       база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    hostssl    база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    hostnossl  база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    

Настройка БД хранения порогов метрик#

1. Перейдите в директорию thresholds.

2. Создайте БД с хранилищем порогов метрик:

   CREATE DATABASE <metrics_thresholds_db_name>;
   

3. Создайте технического пользователя kintsugi_thresholds_metrics для БД хранения порогов метрик и выдайте привилегии: CONNECT и CREATE.

   CREATE USER kintsugi_thresholds_metrics PASSWORD 'password';
   GRANT CONNECT, CREATE ON DATABASE <metrics_thresholds_db_name> TO kintsugi_thresholds_metrics;
   

4. Подключитесь к БД хранилища порогов метрик <metrics_thresholds_db_name>:

   \c <metrics_thresholds_db_name>;
   

5. Создайте в БД хранилища порогов метрик <metrics_thresholds_db_name> схему metrics_thresholds:

   CREATE SCHEMA metrics_thresholds;
   

6. Выдайте техническому пользователю kintsugi_thresholds_metrics привилегии: SELECT, INSERT, DELETE и UPDATE:

   GRANT CONNECT ON DATABASE <metrics_thresholds_db_name> TO kintsugi_thresholds_metrics;
   GRANT USAGE ON SCHEMA metrics_thresholds TO kintsugi_thresholds_metrics;
   
   ALTER DEFAULT PRIVILEGES IN SCHEMA metrics_thresholds
     GRANT ALL ON FUNCTIONS TO kintsugi_thresholds_metrics;
   ALTER DEFAULT PRIVILEGES IN SCHEMA metrics_thresholds
     GRANT SELECT, UPDATE, USAGE ON SEQUENCES TO kintsugi_thresholds_metrics;
   ALTER DEFAULT PRIVILEGES IN SCHEMA metrics_thresholds
    GRANT ALL ON TABLES TO kintsugi_thresholds_metrics;
   ALTER DEFAULT PRIVILEGES IN SCHEMA metrics_thresholds
    GRANT USAGE ON TYPES TO kintsugi_thresholds_metrics;
   

7. Измените путь поиска по умолчанию:

   ALTER USER kintsugi_thresholds_metrics SET search_path TO metrics_thresholds;
   ALTER DATABASE <metrics_thresholds_db_name> SET search_path TO metrics_thresholds;
   

8. Установите схему по умолчанию metrics_thresholds:

   set schema 'metrics_thresholds';
   

9. Распакуйте содержимое архива db_scripts_thresholds.zip.

10. Выполните конфигурацию файла liquibase.properties:

    Пример конфигурации:

    changelogFile: /path/to/changelog/thresholds/master_changelog.xml
    url: jdbc:postgresql://thresholds_host:thresholds_port/thresholds_db
    username: {username_example}
    password: {password_example}
    defaultSchemaName: metrics_thresholds
    

    Примечание

    Описание конфигурации приведено в разделе «Настройка инструмента инсталляции системных БД Kintsugi».

11. Выполните шаги 9 – 11 сценария «Настройка БД метаданных Platform V Pangolin DB (или PostgreSQL)».

Настройка БД мониторинга TimescaleDB (или VictoriaMetrics)#

Kintsugi поддерживает два режима работы с сервисами хранения данных о метриках: TimescaleDB или VictoriaMetrics.

Использование схемы с TimescaleDB#

Для использования схемы с TimescaleDB выполните следующие шаги из-под привилегированного пользователя:

1. Создайте БД с хранилищем метрик:

   CREATE DATABASE <metrics_db_name>;
   

2. Создайте технического пользователя kintsugi_metrics для БД хранения метрик и выдайте привилегии: CONNECT и CREATE.

   CREATE USER kintsugi_metrics PASSWORD 'password';
   GRANT CONNECT, CREATE ON DATABASE <metrics_db_name> TO kintsugi_metrics;
   

3. Добавьте расширение timescaledb в значение параметра shared_preload_libraries в файле конфигурации postgresql.conf.

4. Подключитесь к БД метаданных <metrics_db_name>:

   \c <metrics_db_name>;
   

5. Создайте схему metrics и расширение timescaledb, а также таблицу для хранения версии, для этого подключитесь к БД <metrics_db_name> и выполните команды:

   CREATE SCHEMA IF NOT EXISTS metrics;
   CREATE EXTENSION IF NOT EXISTS timescaledb SCHEMA metrics;
   

   Примечание

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

6. Распакуйте содержимое архива db_scripts_timescaledb.zip.

7. Выполните конфигурацию файла liquibase.properties:

   Пример конфигурации:

   changelogFile: /path/to/changelog/timescaledb/master_changelog.xml
   url: jdbc:postgresql://metrics_host:metrics_port/metrics_db
   username: {username_example}
   password: {password_example}
   defaultSchemaName: metrics
   

   Примечание

   Описание конфигурации приведено в разделе «Настройка инструмента инсталляции системных БД Kintsugi».

8. Выполните шаги 9 – 11 сценария «Настройка БД метаданных Platform V Pangolin DB (или PostgreSQL)».

9. Измените путь поиска по умолчанию:

   ALTER USER kintsugi_metrics SET search_path TO metrics;
   ALTER DATABASE <metrics_db_name> SET search_path TO metrics;
   

10. Настройте права для пользователя kintsugi_metrics:

    GRANT usage, CREATE ON SCHEMA metrics TO kintsugi_metrics;
    GRANT SELECT, INSERT, UPDATE ON all tables IN SCHEMA metrics TO kintsugi_metrics;
    GRANT EXECUTE ON ALL functions IN SCHEMA metrics TO kintsugi_metrics;
    GRANT EXECUTE ON ALL procedures IN SCHEMA metrics TO kintsugi_metrics;
    GRANT usage ON ALL sequences IN SCHEMA metrics TO kintsugi_metrics;
    

Использование схемы с VictoriaMetrics#

Для использования схемы с VictoriaMetrics выполните следующие шаги:

1. Создайте директорию для хранения данных VictoriaMetrics:

   mkdir <имя директории хранения данных>
   

2. Запустите VictoriaMetrics:

   victoria-metrics-prod -storageDataPath <имя директории хранения данных о метриках> -retentionPeriod=5d -loggerOutput stdout -httpListenAddr:8407
   

3. Подготовьте файл конфигурации для vmauth <файл конфигурации vmauth>:

   users:
    - username: <username>
    password: <password>
    url_prefix: "http://127.0.0.1:<port>" #endpoint VictoriaMetrics
   

4. Подготовьте сертификаты для vmauth. Пример сертификата приведен ниже:

   tls.key:
       <СОДЕРЖИМОЕ КЛЮЧА СЕРТИФИКАТА>
   tls.crt:
       <СОДЕРЖИМОЕ СЕРТИФИКАТА>
   

5. Запустите vmauth:

   vmauth-prod --tls=true --auth.config=./vmauth_config/<файл конфигурации vmauth> --httpListenAddr=0.0.0.0:8421 --tlsCertFile=./vmauth_cert/vmauth_ip.crt --tlsKeyFile=./vmauth_cert/vmaut_ip.key
   

Настройка БД агента сбора и хранения метрик#

1. Создайте технического пользователя kintsugi_agents для БД агента сбора и хранения метрик:

   Примечание

   Используйте учетную запись администратора СУБД для дальнейшего развертывания.

   CREATE USER kintsugi_agents PASSWORD 'password';
   

2. Создайте БД для агента сбора и хранения метрик:

   CREATE DATABASE <agents_db_name>;
   

3. Подключитесь к БД агента сбора и хранения метрик <agents_db_name>:

   \c <agents_db_name>;
   

4. Создайте в БД агента сбора и хранения метрик <agents_db_name> схему agents:

   CREATE SCHEMA agents;
   

5. Измените путь поиска по умолчанию на схему agents:

   set schema 'agents';
   

6. Распакуйте содержимое архива db_scripts_agents.zip.

7. Выполните конфигурацию файла liquibase.properties:

   Пример конфигурации:

   changelogFile: /path/to/changelog/repository/master_changelog.xml
   url: jdbc:postgresql://agents_host:agents_port/agents_db
   username: {username_example}
   password: {password_example}
   defaultSchemaName: agents
   

   Примечание

   Описание конфигурации приведено в разделе «Настройка инструмента инсталляции системных БД Kintsugi».

8. Выполните команду установки БД агента сбора и хранения метрик:

   ./liquibase update
   

9. Выполните команду проверки состояния БД:

   ./liquibase history
   

10. Установите тег текущей версии Kintsugi для реализации возможности отката к текущему состоянию БД:

    ./liquibase tag --tag=<ТЕКУЩАЯ_ВЕРСИЯ_KINTSUGI>
    

11. Добавьте права техническому пользователю kintsugi_agents:

    GRANT CONNECT ON DATABASE <agents_db_name> TO kintsugi_agents; 
    GRANT USAGE ON SCHEMA agents TO kintsugi_agents;
    
    ALTER DEFAULT PRIVILEGES IN SCHEMA agents
    GRANT ALL ON FUNCTIONS TO kintsugi_agents;
    ALTER DEFAULT PRIVILEGES IN SCHEMA agents
    GRANT SELECT, UPDATE, USAGE ON SEQUENCES TO kintsugi_agents;
    ALTER DEFAULT PRIVILEGES IN SCHEMA agents
    GRANT ALL ON TABLES TO kintsugi_agents;
    ALTER DEFAULT PRIVILEGES IN SCHEMA agents
    GRANT USAGE ON TYPES TO kintsugi_agents;
    

12. Измените путь поиска по умолчанию:

    ALTER USER kintsugi_agents SET search_path TO agents;
    ALTER DATABASE <agents_db_name> SET search_path TO agents;
    

13. Для настройки сетевого доступа к хранилищу PostgreSQL выполните конфигурацию pg_hba.conf.

    Примечание

    Используйте учетную запись администратора ОС.

    Пример конфигурации аутентификации технической учетной записи kintsugi_agents с использованием сертификатов:

    hostssl all kintsugi_agents 0.0.0.0/0 cert clientcert=1
    

    Формат добавления пользователя и метод его аутентификации указан ниже:

    local      база  пользователь  метод-аутентификации  [параметры-аутентификации]
    host       база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    hostssl    база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    hostnossl  база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    host       база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    hostssl    база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    hostnossl  база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    

Настройка БД хранения отчетов нотификации#

1. Перейдите в директорию alerting.

2. Создайте БД с хранилищем отчетов нотификации:

   CREATE DATABASE <alerting_db_name>;
   

3. Создайте технического пользователя kintsugi_alerting для БД хранения отчетов нотификации и выдайте привилегии: CONNECT и CREATE.

   CREATE USER kintsugi_alerting PASSWORD 'password';
   GRANT CONNECT, CREATE ON DATABASE <alerting_db_name> TO kintsugi_alerting;
   

4. Подключитесь к БД хранилища отчетов нотификации <alerting_db_name>:

   \c <alerting_db_name>;
   

5. Создайте в БД хранилища отчетов нотификации <alerting_db_name> схему alerting:

   CREATE SCHEMA alerting;
   

6. Выдайте техническому пользователю kintsugi_alerting привилегии: SELECT, INSERT, DELETE и UPDATE:

   GRANT CONNECT ON DATABASE <alerting_db_name> TO kintsugi_alerting;
   GRANT USAGE ON SCHEMA metrics_alerting TO kintsugi_alerting;
   
   ALTER DEFAULT PRIVILEGES IN SCHEMA alerting
     GRANT ALL ON FUNCTIONS TO kintsugi_alerting;
   ALTER DEFAULT PRIVILEGES IN SCHEMA alerting
     GRANT SELECT, UPDATE, USAGE ON SEQUENCES TO kintsugi_alerting;
   ALTER DEFAULT PRIVILEGES IN SCHEMA alerting
    GRANT ALL ON TABLES TO kintsugi_alerting;
   ALTER DEFAULT PRIVILEGES IN SCHEMA alerting
    GRANT USAGE ON TYPES TO kintsugi_alerting;
   

7. Измените путь поиска по умолчанию:

   ALTER USER kintsugi_alerting SET search_path TO alerting;
   ALTER DATABASE <alerting_db_name> SET search_path TO alerting;
   

8. Установите схему по умолчанию alerting:

   SET SCHEMA 'alerting';
   

9. Распакуйте содержимое архива db_scripts_alerting.zip.

10. Выполните конфигурацию файла liquibase.properties:

    Пример конфигурации:

    changelogFile: /path/to/changelog/alerting/master_changelog.xml
    url: jdbc:postgresql://alerting_host:alerting_port/alerting_db
    username: {example_username}
    password: {example_password}
    defaultSchemaName: alerting
    

    Примечание

    Описание конфигурации приведено в разделе «Настройка инструмента инсталляции системных БД Kintsugi».

11. Выполните шаги 9 – 11 сценария «Настройка БД метаданных Platform V Pangolin DB (или PostgreSQL)».

Настройка БД персистентного хранилища метрик загрузки и производительности#

1. Создайте технического пользователя kintsugi_dbperf для БД персистентного хранилища метрик загрузки и производительности:

   Примечание

   Используйте учетную запись администратора СУБД для дальнейшего развертывания.

   CREATE USER kintsugi_dbperf PASSWORD 'password';
   

2. Создайте БД персистентного хранилища метрик загрузки и производительности сбора и хранения метрик:

   CREATE DATABASE <dbperf_db_name>;
   

3. Подключитесь к БД персистентного хранилища метрик загрузки и производительности <dbperf_db_name>:

   \c <dbperf_db_name>;
   

4. Создайте в БД персистентного хранилища метрик загрузки и производительности <dbperf_db_name> схему dbperf:

   CREATE SCHEMA dbperf;
   

5. Измените путь поиска по умолчанию на схему dbperf:

   set schema 'dbperf';
   

6. Распакуйте содержимое архива db_scripts_dbperf.zip.

7. Выполните конфигурацию файла liquibase.properties:

   Пример конфигурации:

   changelogFile: /path/to/changelog/repository/master_changelog.xml
   url: jdbc:postgresql://dbperf_host:dbperf_port/dbperf_db
   username: {username_example}
   password: {password_example}
   defaultSchemaName: dbperf
   

   Примечание

   Описание конфигурации приведено в разделе «Конфигурация helm-чарта Kintsugi».

8. Выполните команду установки БД агента сбора и хранения метрик:

   Примечание

   При первой (инициализирующей) миграции БД необходимо указать количество партиций и передать контекст dbperfInitDB для применения настроек партиций. В последующих миграциях, эти парамерты передавать не нужно.

   DB_DBPERF_PARTITION_COUNT=16 # Сконфигурируйте количество партиций Базы Данных
   ./liquibase update  -Dpartitions.count=${DB_DBPERF_PARTITION_COUNT} --context-filter=dbperfInitDB"
   

9. Выполните команду проверки состояния БД:

   ./liquibase history
   

10. Установите тег текущей версии Kintsugi для реализации возможности отката к текущему состоянию БД:

    ./liquibase tag --tag=<ТЕКУЩАЯ_ВЕРСИЯ_KINTSUGI>
    

11. Добавьте права техническому пользователю kintsugi_dbperf:

    GRANT CONNECT ON DATABASE <dbperf_db_name> TO kintsugi_dbperf; 
    GRANT USAGE ON SCHEMA dbperf TO kintsugi_dbperf;
    ALTER DEFAULT PRIVILEGES IN SCHEMA dbperf
    GRANT ALL ON FUNCTIONS TO kintsugi_dbperf;
    ALTER DEFAULT PRIVILEGES IN SCHEMA dbperf
    GRANT SELECT, UPDATE, USAGE ON SEQUENCES TO kintsugi_dbperf;
    ALTER DEFAULT PRIVILEGES IN SCHEMA dbperf
    GRANT ALL ON TABLES TO kintsugi_dbperf;
    ALTER DEFAULT PRIVILEGES IN SCHEMA dbperf
    GRANT USAGE ON TYPES TO kintsugi_dbperf;
    

12. Измените путь поиска по умолчанию:

    ALTER USER kintsugi_dbperf SET search_path TO dbperf;
    ALTER DATABASE <dbperf_db_name> SET search_path TO dbperf;
    

13. Для настройки сетевого доступа к хранилищу PostgreSQL выполните конфигурацию pg_hba.conf.

    Примечание

    Используйте учетную запись администратора ОС.

    Пример конфигурации аутентификации технической учетной записи kintsugi_dbperf с использованием сертификатов:

    hostssl all kintsugi_dbperf 0.0.0.0/0 cert clientcert=1
    

    Формат добавления пользователя и метод его аутентификации указан ниже:

    local      база  пользователь  метод-аутентификации  [параметры-аутентификации]
    host       база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    hostssl    база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    hostnossl  база  пользователь  адрес  метод-аутентификации  [параметры-аутентификации]
    host       база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    hostssl    база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    hostnossl  база  пользователь  IP-адрес  IP-маска  метод-аутентификации  [параметры-аутентификации]
    

Настройка режима работы Kintsugi с сервисами хранения данных о метриках#

Для настройки режима работы Kintsugi с сервисом хранения данных о метриках:

• VictoriaMetrics, установите значение true у параметра global.victoriaMetrics.enabled в конфигурационных файлах ./helm/application/kintsugi/values.yaml и ./helm/application/istio-kintsugi/values.yaml.

• TimescaleDB, установите значение false у параметра global.victoriaMetrics.enabled в конфигурационных файлах ./helm/application/kintsugi/values.yaml и ./helm/application/istio-kintsugi/values.yaml.

Установка Kintsugi в Kubernetes/Platform V DropApp (K8S) или Red Hat OpenShift#

Перед началом установки заполните файлы с конфигурацией Kintsugi в Kubernetes/Platform V DropApp/Red Hat OpenShift.

Конфигурация helm-чарта Kintsugi#

Для конфигурации helm-чарта Kintsugi (DBCM) выполните следующие шаги:

1. Подготовьте файл ./helm/application/kintsugi/values.yaml.

2. Задайте значения параметрам конфигурации секции global.

Описание конфигурационного файла helm-чарта Kintsugi представлено ниже.

Основной блок настроек#

Блок настройки БД#

Описываются по стандартному шаблону:

Конфигурирование кастомных labels и annotations для ресурсов Kubernetes в helm-чарте Kintsugi#

Дополнительный блок#

Настройка параметров HashiCorp Vault#

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

Конфигурация микросервисов имеет общие параметры:

Далее представлены дополнительные параметры для микросервисов:

• alerting:

  Параметр	Пример	Описание
  alerting.config.sortCustomProps	"custom_AC" "custom_STAND" "custom_CIR"	Упорядоченный набор пользовательских свойств, по которым производится сортировка активов, за которыми наблюдает пользователь
  alerting.config.email.from	example@mail.ru	Заголовок для формирования Kafka сообщения (адреса отправителя)
  alerting.config.email.secret	<СОДЕРЖИМОЕ СЕРТИФИКАТА>	Уникальный идентификатор почтового адреса
  alerting.config.email.prefixMessageId	kintsugi	Префикс, который будет использован в уникальном идентификаторе сообщения
  alerting.config.email.topicResponse	topic-respon	Заголовок для формирования Kafka сообщения (топик, в который будет отправлен ответ на сообщение)
  alerting.config.email.validDomains	"sbertech.ru"	Массив допустимых почтовых доменов

• curator:

  Параметр	Пример	Описание
  curator.config.requestsPropertySequence	["custom_property_test", "custom_property_test2"]	Устанавливает очередность пользовательских свойств в конфигурации curator для группировки после фильтрации

• dbperf:

  Параметр	Пример	Описание
  config.storage.type	"persistent"	Определяет режим использования персистентного хранилища метрик загрузки и производительности. Допустимые значения: persistent и in-memory

• backend, когда dbterm:

  • не используется:

    backend:
    ingress:
        hosts:
        - backend.some.domain #хост backend
        - terminal.some.domain #хост terminal
    

    В отличие от прочих микросервисов Kintsugi backend может создавать один или более ingress/route.

  • используется:

    backend:
    ingress:
        hosts: 
        - backend.some.domain #хост backend
    dbterm: 
    ingress: 
        host: terminal.some.domain #хост terminal
    

• frontend/frontend-slim:

  Параметр	Пример	Описание
  <frontend/frontend-slim>.server	sygnx/nginx	HTTP-сервер, используемый для запуска веб-сервисов Kintsugi (nginx/syngx)
  <frontend/frontend-slim>.config.feedback.email	support_kintsugi@sbertech.ru	Электронная почта получателя обратной связи. Не должен быть заполнен при указанном адресе в <frontend/frontend-slim>.config.feedback.link
  <frontend/frontend-slim>.config.feedback.link	https://example.com	Адрес получателя обратной связи. Не должен быть заполнен при указанной почте в <frontend/frontend-slim>.config.feedback.email
  <frontend/frontend-slim>.config.documentation	https://docs.kintsugi.example/DBM/	Адрес веб-страницы с документацией Kintsugi
  frontend.config.externalButton.url	"/custom-assets/test-asset"	Адрес источника данных о внешних сервисах
  frontend.config.externalButton.title.ru	"Внешние сервисы"	Русскоязычное наименование вкладки, где хранятся данные о внешних сервисах
  frontend.config.externalButton.title.en	"External services"	Английское наименование вкладки, где хранятся данные о внешних сервисах
  frontend.config.alerting.enabled	true	Включение/отключение сервиса оповещений (true/false)
  frontend.config.feedbackWidget.location	"PROM"	Адрес для загрузки локации
  frontend.config.feedbackWidget.systemName	"system name"	Имя системы

• tsdbmon:

  Параметр	Пример	Описание
  tsdbmon.config.promqlQueryTimeout	2	Максимальное время, когда запрос может занять, прежде чем быть прерванным
  tsdbmon.config.promqlSubqueryStepInterval	1	Интервал шага по умолчанию, который будет использоваться для оценки subquery. Это значение используется, если в подведении явно не указано значение шага. Пример: <metric_name>[30m:]. В Prometheus эта настройка установлена опцией evaluation_interval
  tsdbmon.config.promqlLookbackDelta	5	Параметр, отвечающий за то, насколько далеко tsdbmon будет достраивать точки при их отсутствии
  tsdbmon.config.promqlMaxSamples	50000000	Максимальное количество выборок которое один запрос может загрузить и передать
  tsdbmon.config.promqlMaxPointsPerTs	10000	Максимальное количество точек для тайм-серии. Этот расчет - оценка, которая происходит как (start - end)/step, где начало и конец - это «начало» и «конец» временные метки

  Примечание

  * При установке Kintsugi с использованием хранилища секретов SecMan конфигурация параметров выполняется согласно разделу Настройка интеграции с HashiCorp Vault/SecMan.

Настройка секретов helm-чарта Kintsugi#

Модульная установка Kintsugi#

Модульная установка Kintsugi осуществляется через заполнение helm-конфигурации ./helm/application/<микросеврис Kintsugi>/values.yaml.

Конфигурация параметров данного раздела для каждого микросевриса Kintsugi идентична и будет рассмотрена на примере audit_proxy:

Конфигурация helm-чарта Istio#

Для конфигурации helm-чарта Istio выполните следующие шаги:

1. Подготовьте файл ./helm/application/istio-kintsugi/values.yaml.

2. Выполните конфигурацию helm-чарта Istio.

Описание конфигурационного файла helm-чарта Istio представлено ниже.

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

Настройка сервиса аудит#

Настройка БД#

Конфигурирование кастомных labels и annotations для ресурсов Kubernetes в helm-чарте Istio#

Настройка Elasticsearch#

Настройка Fluentbit#

Настройка безопасности#

Настройка Istio#

Настройка Jaeger#

Настройка Kafka#

Настройка HashiCorp Vault#

Настройка VictoriaMetrics#

Настройка Synapse#

Настройка Istio Ingress Gateway#

Настройка OTT Egress#

Настройка Identity Provider#

Настройка секретов helm-чарта Istio#

Установка Kintsugi в Kubernetes/Platform V DropApp#

Для установки Kintsugi в Kubernetes/Platform V DropApp выполните следующие шаги установки:

1. Подготовьте kubeconfig и сохраните kubeconfig в каталоге $HOME/.kube. Пример:

       apiVersion: v1
       clusters:
       - cluster:
       certificate-authority-data: <СОДЕРЖИМОЕ СЕРТИФИКАТА>
       server: https://100.xx.xx.xx:5555
       name: sks-kintsugi
       contexts:
       - context:
       cluster: sks-kintsugi
       user: sks-kintsugi-admin
       name: sks-kintsugi-admin@sks-kintsugi
       current-context: sks-kintsugi-admin@sks-kintsugi
       kind: Config
       preferences: {}
       users:
       - name: sks-kintsugi-admin
       user:
       client-certificate-data: <СОДЕРЖИМОЕ СЕРТИФИКАТА>
       client-key-data: <СОДЕРЖИМОЕ КЛЮЧА СЕРТИФИКАТА>
   

2. Выполните установку Kintsugi в Kubernetes/Platform V DropApp. Пример:

   helm install <release_name> helm/application
   

Установка Kintsugi в Red Hat OpenShift (опционально)#

Для установки Kintsugi (DBCM) в Red Hat OpenShift выполните следующие шаги установки:

1. Выполните авторизацию в Red Hat OpenShift под учетной записью с правами администратора проекта. Пример:

   oc login --token=<token> --server=https://<server>:<port>
   

2. Выполните развертывание Kintsugi в Red Hat OpenShift. Пример:

   helm install <release_name> helm/application