[EDP-DDM-22779] Rework platform configuration specification

Change-Id: Iee4dc31aff587160a8675b079e465afea9229379

docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/configuration-structure/configuration-structure-general.adoc

@@ -4,8 +4,8 @@
 --
 
 == Загальний опис
-В Платформі реєстрів, параметри конфігурації, як для Платформи, так і реєстрів зберігаються в `Сервісі інспекції та зберігання змін конфігурації
-(Gerrit)` реалізуючи таким чином `GitOps` підхід до зберігання та застосування конфігурації.
+В Платформі реєстрів, параметри конфігурації, як для Платформи, так і реєстрів зберігаються в Сервісі інспекції та зберігання змін конфігурації
+(Gerrit) реалізуючи таким чином `GitOps` підхід до зберігання та застосування конфігурації.
 
 TIP: GitOps — це підхід до оркестрації інфраструктури Платформи та розгортання реєстрів заснований на використанні
 Git-репозиторію як єдиного джерела для конфігураційних файлів підсистем. GitOps забезпечує автоматизоване розгортання,

docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/configuration-structure/platform-configuration-structure.adoc

@@ -2,16 +2,18 @@
 
 include::configuration-structure-general.adoc[]
 
+[caption=]
+.Налаштування Платформи
 |===
 |Рівень налаштувань|Репозиторій|Шлях|Призначення
 
 .2+|_Платформа_
 .2+|`cluster-mgmt`
 |`/deploy-templates/values.yaml`
-|Загальні налаштування Платформи.
+|Загальні налаштування Платформи. Налаштовується адміністратором через адмін-консоль.
 
 |`/deploy-templates/values.gotmpl`
-|Системні параметри Платформи.
+|Містить шаблони та значення за замовчуванням для системних параметрів. У більшості випадків не потребує коригувань.
 
 |===
 
@@ -20,75 +22,142 @@ include::configuration-structure-general.adoc[]
 
 === Параметри налаштувань адміністраторів Платформи
 
-.Налаштування адміністраторів
+`administrators` визначає перелік адміністраторів Платформи.
+
+[[parent-administrators]]
+[cols="20%,10%,5%,5%,60%",options="header",caption=]
+.Параметри налаштувань адміністраторів Платформи
 |===
-|Назва|Тип|Значення за замовчуванням|Призначення
+|Поле| **Тип** | **Значення за замовчуванням** | **Обовʼязкове** | **Призначення**
 
-|`administrators`
-|list
-|-
+|`<<administrators,administrators>>`
+|object
+|&#10007;
+|&#10007;
 |Вказання переліку користувачів Платформи, що мають роль адміністратора Платформи (`cp-cluster-mgmt-admin`)
 
-|`administrators[*].email`
+|===
+
+[[administrators]]
+[cols="20%,10%,5%,5%,60%",options="header",caption=]
+.administrators object | <<parent-administrators,Повернутись на батьківську таблицю>>
+|===
+|Поле|Тип|Значення за замовчуванням|Обовʼязкове|Призначення
+
+|`email`
 |string
-|-
+|&#10007;
+|&#10003;
 |Адреса електронної пошти, що ідентифікує користувача.
 
-|`administrators[*].firstName`
+|`firstName`
 |string
-|-
+|&#10007;
+|&#10003;
 |Імʼя користувача
 
-|`administrators[*].lastName`
+|`lastName`
 |string
-|-
+|&#10007;
+|&#10003;
 |Прізвище користувача
 
-|`administrators[*].passwordVaultSecret`
+|`passwordVaultSecret`
 |string
-|-
+|&#10007;
+|&#10003;
 |Шлях до тимчасового пароля в _Сервісі управління секретами та шифруванням_ Hashicorp Vault.
 
-|`administrators[*].passwordVaultSecretKey`
+|`passwordVaultSecretKey`
 |string
-|password
+|&#10007;
+|&#10003;
 |Ключ для пошуку тимчасового пароля в _Сервісі управління секретами та шифруванням_ Hashicorp Vault.
 
-|`administrators[*].username`
+|`username`
 |string
-|-
+|&#10007;
+|&#10003;
 |Імʼя акаунту користувача. Дорівнює полю `email`.
 
 |===
 
+[source,yaml]
+.Приклад специфікації налаштування адміністраторів
+----
+administrators:
+    - email: [email protected]
+      firstName: user
+      lastName: user
+      passwordVaultSecret: registry-kv/cluster/[email protected]
+      passwordVaultSecretKey: password
+      username: [email protected]
+----
+
+
 === Параметри налаштувань сервісу управління користувачами та ролями
 
-.Налаштування сервісу управління користувачами та ролями
+`keycloak` визначає налаштування сервісу управління користувачами та ролями Keycloak.
+
+[[parent-keycloak]]
+[cols="20%,10%,5%,5%,60%",options="header",caption=]
+.Параметри сервісу управління користувачами та ролями Keycloak
 |===
-|Назва|Тип|Значення за замовчуванням|Призначення
+|Поле|Тип|Значення за замовчуванням|Обовʼязкове|Призначення
 
-|`keycloak`
-|map
-|-
-|Загальні налаштування Keycloak компонента.
+|`<<customHosts,keycloak>>`
+|object
+|&#10007;
+|&#10007;
+|Загальні налаштування компонента Keycloak.
 
-|`keycloak.customHosts`
-|list
-|-
+|===
+
+`keycloak.customHosts` визначає перелік альтернативних DNS-імен для Keycloak.
+
+[[customHosts]]
+[cols="20%,10%,5%,5%,60%",options="header",caption=]
+.Параметри альтернативних DNS-імен Keycloak | <<parent-keycloak,Повернутись на батьківську таблицю>>
+|===
+|Поле|Тип|Значення за замовчуванням|Обовʼязкове|Призначення
+
+|`<<child-customHosts,customHosts>>`
+|object
+|&#10007;
+|&#10007;
 |Перелік альтернативних DNS-імен для Keycloak.
 
-|`keycloak.customHosts[*].certificatePath`
+|===
+
+[[child-customHosts]]
+[cols="20%,10%,5%,5%,60%",options="header",caption=]
+.Параметри альтернативних DNS-імен Keycloak | <<customHosts,Повернутись на батьківську таблицю>>
+|===
+|Поле|Тип|Значення за замовчуванням|Обовʼязкове|Призначення
+
+|`certificatePath`
 |string
-|-
+|&#10007;
+|&#10004;
 |Шлях до TLS/SSL сертифікату в _Сервісі управління секретами та шифруванням_ Hashicorp Vault.
 
-|`keycloak.customHosts[*].host`
+|`host`
 |string
-|-
+|&#10007;
+|&#10004;
 |Назва альтернативного DNS-імені.
 
 |===
 
+[source,yaml]
+.Приклад специфікації налаштувань сервісу управління користувачами та ролями
+----
+keycloak:
+  customHosts:
+    - certificatePath: registry-kv/cluster/domains/example-keycloak.openshift.company.com/20230505T085919Z
+      host: example-keycloak.openshift.company.com
+----
+
 === Параметри налаштувань сервісу резервного копіювання та відновлення
 
 .Налаштування сервісу резервного копіювання та відновлення

docs/ua/modules/arch/pages/architecture/platform/administrative/control-plane/single-registry-template.adoc

@@ -140,7 +140,7 @@ global:
   - '{{ env "NAMESPACE" }}/registry-postgres'
 ----
 +
-TIP: Для передачі значення параметра `installed` можна використати або задання його на рівні пайплайну як змінну оточення або
+TIP: Для передачі значення параметра `installed` можна використати або задання його на рівні пайплайну як змінну оточення
 або прочитати з `values.yaml` через https://helmfile.readthedocs.io/en/latest/#environment-values[helmfile environment values]
 
 . Параметри налаштування Гряди не повинні мати окремих елементів вводу з UI адмін-консолі, а повинні задаватись з вже існуючих