Структура конфігурації реєстру

administrators

[]object

❌

✅

Вказання переліку користувачів реєстру, що мають роль адміністратора реєстру (cp-registry-admin-<registry-name>).

digitalSignature

object

❌

✅

Налаштування сервісу цифрового підпису Підсистеми цифрових підписів реєстру.

digitalDocuments

object

❌

✅

Налаштування обмежень сервісу цифрових документів на завантаження файлів цифрових документів до реєстру користувачами та бізнес-процесами.

dso

object

❌

✅

Налаштування реплік сервісу цифрового підпису Підсистеми цифрових підписів реєстру.

external-systems

[]object

❌

✅

Налаштування взаємодії з іншими зовнішніми системами.

global

object

❌

✅

Глобальні налаштування реєстру

griada

object

❌

✅

Налаштування програмно-апаратного криптомодуля "Гряда".

keycloak

object

❌

✅

Налаштування сервісу управління користувачами та ролями.

kongPluginsConfig

object

❌

✅

Налаштування плагінів зовнішнього API-шлюзу операційної зони реєстру.

nontrembita-external-registration

[]object

❌

✅

Налаштування плагінів зовнішнього API-шлюзу операційної зони реєстру.

portals

object

❌

✅

Налаштування кабінетів користувача.

redash

object

❌

✅

Налаштування підсистеми аналітичної звітності реєстру.

registryVaultPath

string

registry-kv/registry/<registry_name>

✅

Шлях до реєстрового Vault Engine в cервісі управління секретами та шифруванням Hashicorp Vault.

signWidget

object

❌

✅

Налаштування IIT-віджету автентифікації.

trembita

object

❌

❌

Налаштування шлюзу безпечного обміну "Трембіта".

maxFileSize

string

100MB

✅

Максимальний розмір файлу для завантаження, MB

maxTotalFileSize

string

100MB

✅

Макс. сумарний розмір групи файлів для завантаження, MB

email

string

❌

✅

Адреса електронної пошти, що ідентифікує користувача.

firstName

string

❌

✅

Імʼя користувача

lastName

string

❌

✅

Прізвище користувача

passwordVaultSecret

string

❌

✅

Шлях до тимчасового пароля в Сервісі управління секретами та шифруванням Hashicorp Vault.

passwordVaultSecretKey

string

❌

✅

Ключ для пошуку тимчасового пароля в Сервісі управління секретами та шифруванням Hashicorp Vault.

username

string

❌

✅

Імʼя акаунту користувача. Дорівнює полю email.

authFlows

object

❌

✅

Налаштування сутності AuthFlow в Keycloak.

citizenAuthFlow

object

❌

✅

Налаштування сутності AuthFlow в Keycloak для кабінету отримувача послуг.

customHost

string

❌

❌

Визначає keycloak хост з попередньо доданих на рівні Платформи для використання при автентифікації.

identityProviders

object

❌

✅

Налаштування ідентифікаційних провайдерів в Keycloak.

realms

object

❌

✅

Налаштування сутності Realm в Keycloak.

officerAuthFlow

object

❌

✅

Налаштування сутності AuthFlow в Keycloak для кабінету надавача послуг.

authType

string

❌

✅

Визначає можливість використовувати власний віджет автентифікації або налаштувати інтеграцію з id.gov.ua.

edrCheck

bool

❌

✅

Визначає ввімкнена або вимкнена перевірка наявності активного запису в ЄДР для бізнес-користувачів.

registryIdGovUa

bool

❌

✅

Налаштування ідентифікаційного провайдера id.gov.ua

widget

bool

❌

✅

Налаштування віджету автентифікації.

height

string

❌

✅

Визначає висоту віджету автентифікації.

url

string

❌

✅

Визначає посилання на віджет автентифікації.

idGovUa

object

❌

✅

Налаштування ідентифікаційного провайдера id.gov.ua

clientId

string

❌

✅

Визначає клієнтський ідентифікатор.

secretKey

string

❌

✅

Визначає шлях в Сервісі управління секретами та шифруванням Hashicorp Vault до секрету клієнта що був зареєстрований в id.gov.ua.

url

string

❌

✅

Визначає посилання для id.gov.ua

widgetHeight

string

720

✅

Визначає висоту віджету автентифікації.

officerPortal

object

❌

✅

Визначає налаштування рілму автентифікації кабінету надавача послуг.

browserFlow

string

dso-officer-auth-flow

✅

Визначає назву використовуємого AuthFlow.

selfRegistration

bool

❌

✅

Визначає можливість автоматичного створення облікового запису при першому логіні користувача.

data

object

❌

✅

Налаштування ключів сервісу цифрового підпису реєстру.

env

object

❌

✅

Налаштування оточення сервісу цифрового підпису реєстру.

Key-6-dat

string

❌

✅

Шлях до приватного файлового ключа організації в Сервісі управління секретами та шифруванням Hashicorp Vault.

allowed-keys-yml

string

❌

✅

Шлях до файлу з переліком атрибутів дозволених (або раніше виданих) ключів в Сервісі управління секретами та шифруванням Hashicorp Vault.

osplm.ini

string

❌

✅

Шлях до конфігураційного файлу програмно-апаратного криптомодуля "Гряда" в Сервісі управління секретами та шифруванням Hashicorp Vault. Використовується тільки з апаратним типом ключа.

sign.key.device-type

string

❌

✅

Визначає тип ключа що використовується реєстром. Допустимі значення file або hardware.

sign.key.file.issuer

string

❌

✅

Шлях до інформації про емітента приватного ключа організації в Сервісі управління секретами та шифруванням Hashicorp Vault. Використовується, коли sign.key.device-type = file.

sign.key.file.password

string

❌

✅

Шлях до пароля приватного ключа організації в Сервісі управління секретами та шифруванням Hashicorp Vault. Використовується, коли sign.key.device-type = file.

sign.key.hardware.device

string

❌

✅

Опис носія ключової інформації (НКІ) згідно з описами ІІТ в Сервісі управління секретами та шифруванням Hashicorp Vault. Використовується, коли sign.key.device-type = hardware.

sign.key.hardware.password

string

❌

✅

Шлях до пароля апаратного екземпляра Гряди в Сервісі управління секретами та шифруванням Hashicorp Vault. Використовується, коли sign.key.device-type = hardware.

sign.key.hardware.type

string

❌

✅

Шлях до типу апаратного екземпляра Гряди в Сервісі управління секретами та шифруванням Hashicorp Vault. Використовується, коли sign.key.device-type = hardware.

maxReplicas

int

3

❌

Максимальна кількість реплік компонента.

minReplicas

int

1

❌

Мінімальна кількість реплік компонента.

container

object

❌

❌

Загальні налаштування контейнерів для компонентів реєстру.

istio

object

❌

❌

Загальні налаштування Istio для компонента реєстру.

computeResources

object

❌

✅

Налаштування віртуальних машин реєстру.

deploymentMode

string

development

✅

Налаштування режиму розгортання реєстру. Детальніше див. Налаштування режиму розгортання реєстру.

whiteListIP

object

❌

❌

Налаштування доступів до реєстрових сервісів.

excludePortals

[]object

[""]

❌

Перелік користувацьких порталів, що не будуть розгортатись в реєстрі. Доступні значення в переліку officer, citizen або admin.

bpAdminPortal

object

❌

✅

Налаштувань користувацького інтерфейсу для перегляду стану виконання та управління бізнес-процесами реєстру.

crunchyPostgres

object

❌

✅

Налаштувань підсистеми управління реляційними базами даних.

geoServerEnabled

bool

false

✅

Визначає наявніть або відсутність підсистеми управління геоданими.

kafkaOperator

object

❌

✅

Налаштування підсистеми асинхронного обміну повідомленнями.

notifications

object

❌

✅

Налаштування сповіщень.

registry

object

❌

✅

Реєстрові налаштування.

registryBackup

object

❌

❌

Налаштування резервного копіювання компонентів реєстру.

regulationManagement

object

❌

✅

Налаштування registry regulation management сервісів.

language

string

uk

❌

Налаштування мови реєстру.

region

string

ua

❌

Визначає регіон в якому працює реєстр. Залежить від регіону Платформи.

<component-name>

object

❌

❌

Визначає загальні налаштування конкретного компонента реєстру.

replicas

int

1

❌

Налаштування кількості реплік. Поле доступне для редагування для всіх сервісів, крім geoServer, але має ефект лише для сервісів, що можуть горизонтально маштабуватись.

istio

object

❌

❌

Налаштування Istio Sidecar для компонента реєстру.

container

object

❌

❌

Налаштування ресурсів контейнера компонента реєстру.

datasource.maxPoolSize

string

❌

❌

Налаштування максимального розміру пулу для. Застосовується тільки до компонента restApi.

sidecar

object

❌

❌

Налаштування Istio Sidecar для компонента реєстру.

resources

object

❌

❌

Визначає кількість ресурсів виділених для Istio Sidecar.

enabled

bool

❌

❌

Вмикає або вимикає Istio Sidecar з поди компонента реєстру.

limits

object

❌

❌

Визначає гранично допустимі ресурси, що може споживати пода компонента реєстру.

requests

object

❌

❌

Визначає кількість ресурсів, що резервуються та доступні компоненту реєстру безумовно і одразу від старту.

envVars

[]object

❌

❌

Налаштування змінних оточення для контейнера компонента реєстру.

resources

object

❌

❌

Налаштування ресурсів для контейнера компонента реєстру.

<variable_name>

string

❌

❌

Key - назва змінної, value - значення.

cpu

string

❌

❌

Визначає кількість виданого процесорного часу, задається в millicores (див. CPU resource units)

memory

string

❌

❌

Визначає кількість виданого ресурсу оперативної памʼяті (див. Memory resource units)

enabled

bool

❌

❌

Вмикає або вимикає резервне копіювання реєстру.

expiresInDays

int

❌

❌

Визначає кількість днів для зберігання створеної резервної копії реєстру.

schedule

string

❌

❌

Розклад резервного копіювання реєстру. Задається в UNIX cron форматі.

obc

object

❌

❌

Визначає налаштування резервного копіювання S3-бакетів.

credentials

string

❌

❌

Шлях до токена доступу в S3-бакети в Сервісі управління секретами та шифруванням Hashicorp Vault.

cronExpression

string

❌

❌

Розклад резервного копіювання S3-бакетів. Задається в UNIX cron форматі.

endpoint

string

❌

❌

Визначає хост до S3-бакета.

backupBucket

string

❌

❌

Визначає назву S3-бакету для резервної копії.

email

object

❌

✅

Визначає налаштування сервісу поштових повідомлень реєстру.

type

string

❌

✅

Визначає тип поштового сервера використовуємого для відправки повідомлень. Доступні значення external або internal.

address

string

❌

✅

Визначає поштову адресу поштового сервера типу external.

host

string

❌

✅

Визначає хост поштового сервера типу external.

port

string

❌

✅

Визначає порт поштового сервера типу external.

password

string

❌

✅

❌ Застарілий параметр. Буде видалений в наступних версіях Платформи.

vaultKey

string

❌

✅

Ключ для пошуку пароля поштового сервера типу external в Сервісі управління секретами та шифруванням Hashicorp Vault.

vaultPath

string

❌

✅

Шлях до пароля поштового сервера типу external в Сервісі управління секретами та шифруванням Hashicorp Vault.

replicationFactor

int

1

✅

Налаштовує фактор реплікації Kafka що визначає кількість копій даних, які зберігаються в кількох брокерах Kafka.

storage

object

❌

✅

Налаштування сховища підсистеми асинхронного обміну повідомленнями.

kafka

object

❌

✅

Налаштування сховища підсистеми асинхронного обміну повідомленнями.

zookeeper

object

❌

✅

Налаштування Kafka Zookeeper.

size

string

20Gi

✅

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

size

string

5Gi

✅

Визначає розмір сховища Kafka Zookeeper.

maxCandidateVersions

int

10

✅

Визначає максимальну кількість активних версій кандидатів регламенту реєстру.

requestsLimitsEnabled

bool

true

❌

Визначає чи ввімкнені Requests/Limits для компонентів реєстру.

sidecar.requestsLimitsEnabled

bool

true

❌

Визначає чи ввімкнені Requests/Limits для Istio Sidecar компонентів реєстру.

backups.pgbackrest.repos.schedules

object

❌

✅

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

postgresql

object

❌

✅

Параметри налаштувань екземплярів СКБД підсистеми управління реляційними базами даних.

storageSize

string

10Gi

✅

Визначає розмір сховища екземплярів СКБД підсистеми управління реляційними базами даних.

full

string

❌

✅

Визначає розклад повного резервного копіювання екземплярів СКБД.

parameters

object

❌

✅

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

max_connections

string

200

✅

Визначає максимальну кількість одночасних з’єднань з екземпляром СКБД.

camunda.bpm.metrics

object

❌

✅

Параметри налаштувань користувацького інтерфейсу для перегляду стану виконання та управління бізнес-процесами реєстру.

enabled

bool

true

✅

Визначає чи доступний інтерфейс для збору метрик підсистемою моніторингу подій та сповіщення.

scrapeInterval

string

60s

✅

Визначає часовий проміжок між зборами метрик підсистемою моніторингу подій та сповіщення.

adminRoutes

string

❌

✅

Налаштування доступу до роутів адміністративних сервісів реєстру.

citizenPortal

string

❌

✅

Налаштування доступу до кабінету отримувача послуг.

officerPortal

string

❌

✅

Налаштування доступу до кабінету надавача послуг.

copyFromAuthWidget

bool

false

✅

height

int

0

✅

Визначає висоту IIT-віджета, px.

url

string

❌

✅

Визначає посилання на IIT-віджет.

instanceCount

int

2

✅

Визначає кількість віртуальних машин для розгортання реєстру з типом інфраструктури AWS або vSphere.

awsInstanceType

string

r5.2xlarge

✅

Визначає тип AWS EC2-інстансу для розгортання реєстру з типом інфраструктури AWS.

awsSpotInstance

bool

false

✅

Визначає використання типу spot для AWS EC2-інстансу реєстру.

awsSpotInstanceMaxPrice

string

❌

❌

Визначає максимальну ціну для AWS EC2 spot-інстансу.

awsInstanceVolumeType

string

gp3

✅

Визначає тип системного диска AWS EC2-інстансу для розгортання реєстру з типом інфраструктури AWS.

instanceVolumeSize

int

80

✅

Визначає розмір системного диска віртуальної машини реєстру з типом інфраструктури AWS або vSphere.

vSphereInstanceCPUCount

int

8

✅

Визначає кількість vCPU віртуальної машини реєстру з типом інфраструктури vSphere.

vSphereInstanceCoresPerCPUCount

int

1

✅

Визначає кількість ядер у кожного vCPU віртуальної машини реєстру з типом інфраструктури vSphere.

vSphereInstanceRAMSize

int

32768

✅

Визначає кількість RAM віртуальної машини реєстру з типом інфраструктури vSphere.

enabled

bool

true

✅

Визначає використання або відсутність апаратного ключа в реєстрі.

ip

string

❌

✅

Визначає ip-адресу програмно-апаратного криптомодуля "Гряда".

port

int

❌

✅

Визначає порт програмно-апаратного криптомодуля "Гряда".

url

string

❌

✅

Визначає url програмно-апаратного криптомодуля "Гряда".

pluginsPrometheusBandwidthMetrics

bool

true

✅

Налаштування

pluginsPrometheusLatencyMetrics

bool

true

✅

Налаштування

pluginsPrometheusPerConsumerMetrics

bool

true

✅

Налаштування

pluginsPrometheusStatusCodeMetrics

bool

true

✅

Налаштування

pluginsProxyCacheTtl

int

900

✅

Налаштування

pluginsRateLimitByHeaderFaultTolerant

bool

true

✅

Налаштування

pluginsRateLimitByHeaderHeaderName

string

token-claim

✅

Налаштування

pluginsRateLimitByHeaderHideClientHeaders

bool

false

✅

Налаштування

pluginsRateLimitByHeaderPolicy

string

local

✅

Налаштування

pluginsRateLimitByHeaderRequestsPerHour

int

10000

✅

Налаштування

pluginsRateLimitByHeaderRequestsPerSecond

int

10

✅

Налаштування

pluginsRateLimitByIpFaultTolerant

bool

true

✅

Налаштування

pluginsRateLimitByIpHideClientHeaders

bool

false

✅

Налаштування

pluginsRateLimitByIpPolicy

string

local

✅

Налаштування

pluginsRateLimitByIpRequestsPerHour

int

10000

✅

Налаштування

pluginsRateLimitByIpRequestsPerSecond

int

10

✅

Налаштування

rateLimitingPluginEnable

bool

false

✅

Налаштування

enabled

bool

❌

❌

Визначає ввімкнена або вимкнена зовнішня інтеграція.

external

bool

❌

❌

Визначає тип зовнішньої інтеграції: інший реєстр на Платформі або за межами Платформи.

name

string

❌

❌

Визначає імʼя зовнішньої системи.

ipList

[]object

❌

❌

Визначає перелік IP-адрес ШБО Трембіта, з яких дозволен доступ до bp-webservice-gateway та registry-soap-api. Пусте значення поля дорівнює відсутності доступу до SOAP API.

registries

object

❌

✅

Містить налаштування взаємодію з реєстром через ШБО "Трембіта".

dracs-registry

object

❌

✅

Налаштування системної інтеграції з ДРАЦС. Присутня за замовчуванням і недоступна для видалення.

edr-registry

object

❌

✅

Налаштування системної інтеграції з ЄДР. Присутня за замовчуванням і недоступна для видалення.

idp-exchange-service-registry

object

❌

✅

Налаштування системної інтеграції з ЄІБДВПО. Присутня за замовчуванням і недоступна для видалення.

<system_name_placeholder>

object

❌

❌

Параметри іншої зовнішньої системи для інтеграції з реєстром.

auth

object

❌

✅

Параметри заголовку, що визначають налаштування авторизації.

client

object

❌

✅

Параметри заголовку, що ідентифікують учасника сервісу.

service

object

❌

✅

Параметри заголовку, що ідентифікують сервіс.

mock

bool

❌

✅

Визначає зовнішню систему як реальну, або як заглушку точки інтеграції.

protocol

string

SOAP

✅

Визначає протокол інтеграційної взаємодії. Дозволені значення SOAP.

protocol-version

string

❌

✅

Визначає версію протоколу, за яким обмінюються повідомленням з ШБО "Трембіта".

type

string

❌

✅

Визначає platform або registry тип взаємодії.

url

string

❌

✅

Визначає хост ШБО "Трембіта".

user-id

string

❌

✅

Ідентифікатор користувача, що ініціює запит.

type

string

❌

✅

Визначає тип авторизації. Доступні значення AUTH_TOKEN або NO_AUTH.

secret

string

❌

❌

Шлях до токена авторизації в Сервісі управління секретами та шифруванням Hashicorp Vault.

x-road-instance

string

❌

✅

Код середовища, що ідентифікує екземпляр сервісу або учасника.

member-class

string

❌

✅

Ідентифікатор класу сервісу або учасника.

member-code

string

❌

✅

Ідентифікатор сервісу або учасника.

subsystem-code

string

❌

✅

Код, що ідентифікує підсистему сервісу або учасника, якщо сервіс надається підсистемою.

x-road-instance

string

❌

✅

Код середовища, що ідентифікує екземпляр сервісу або учасника.

member-class

string

❌

✅

Ідентифікатор класу сервісу або учасника.

member-code

string

❌

✅

Ідентифікатор сервісу або учасника.

subsystem-code

string

❌

✅

Код, що ідентифікує підсистему сервісу або учасника, якщо сервіс надається підсистемою.

service-code

string

❌

❌

Код, що ідентифікує підсистему сервісу або учасника, якщо сервіс надається підсистемою.

service-version

string

❌

❌

Код, що ідентифікує підсистему сервісу або учасника, якщо сервіс надається підсистемою.

diia

object

❌

✅

Налаштування системної інтеграції з ДіЯ. Присутня за замовчуванням і недоступна для видалення.

<system_name_placeholder>

object

❌

❌

Параметри іншої зовнішньої системи для інтеграції з реєстром.

protocol

string

❌

✅

Визначає протокол інтеграції з зовнішньою системою. Доступне значення REST.

type

string

❌

✅

Визначає platform або registry тип взаємодії.

url

string

❌

✅

Визначає адресу зовнішньої системи.

mock

string

❌

✅

Визначає зовнішню систему як реальну, або як заглушку точки інтеграції.

auth

object

❌

✅

Визначає налаштування автентифікації з зовнішньою системою.

secret

string

❌

❌

Шлях до токену зовнішньої системи в Сервісі управління секретами та шифруванням Hashicorp Vault.

type

string

❌

✅

Визначає метод автентифікації з зовнішньою системою. Доступні значення NO_AUTH, AUTH_TOKEN, BEARER, BASIC, AUTH_TOKEN+BEARER.

citizen

object

❌

✅

Налаштування кабінету отримувача послуг.

officer

object

❌

✅

Налаштування кабінету надавача послуг.

customDns

object

❌

❌

Налаштування власних DNS-імен для кабінетів користувачів.

signWidget

object

❌

✅

Налаштування IIT-віджету автентифікації для кабінетів користувачів.

customDns

object

❌

❌

Налаштування власних DNS-імен для кабінетів користувачів.

signWidget

object

❌

✅

Налаштування IIT-віджету автентифікації для кабінетів користувачів.

individualAccessEnabled

bool

❌

❌

Визначає можливість використовування кабінету надавача послуг фізичною особою

enabled

bool

❌

✅

Визначає наявніть або відсутність заданого власного DNS-імені для кабінету.

host

string

❌

❌

Визначає хост власного DNS-імені для кабінету.

url

string

❌

✅

Визначає посилання на віджет автентифікації.

height

object

❌

✅

Визначає візуальну висоту віджету автентифікації.

copyFromAuthWidget

bool

❌

✅