diff --git a/docs/en/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc b/docs/en/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc index 98e9e953a5..05681c273b 100644 --- a/docs/en/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc +++ b/docs/en/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc @@ -1,192 +1,129 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Setting up the registry components backup schedule and retention time +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == General description -//Платформа надає можливість [.underline]#керувати розкладом створення резервних копій компонентів реєстру, а також часом зберігання таких копій у сховищі бекапів#. The platform provides the ability to [.underline]#manage the schedule for creating backup copies of registry components and the time span for storing such copies in the backup repository#. -//Резервні копії компонентів створюються за допомогою інструменту *`velero`* та зберігаються у захищеному сховищі бекапів *`minio`*, що знаходиться поза межами кластера Платформи. Backup copies of components are created using the *`velero`* tool and stored in a secure *`minio`* backup repository located outside the Platform cluster. -//[NOTE] -//==== -//Розклад резервного копіювання налаштовується у форматі https://uk.wikipedia.org/wiki/Cron[*unix-cron*] на інтерфейсі адміністративної панелі *Control Plane*. - -//Період зберігання резервних копій має бути більшим за або дорівнювати одиниці, бути цілим числом та не містити спеціальних символів. -//==== [NOTE] ==== The backup schedule is configured in the https://uk.wikipedia.org/wiki/Cron[*unix-cron*] format on the *Control Plane* administrative panel interface. The retention period for backup copies must be greater than or equal to one unit, be a whole number, and not contain special characters. ==== -//// -TODO: Need this section? -Перелік компонентів реєстру, для яких налаштовується резервне копіювання за розкладом та час зберігання резервних копій: :: - -* [*] [.underline]#Портал управління бізнес-процесами реєстру# -- компонент `*bp-admin-portal*`. -* [*] [.underline]#Кабінет отримувача послуг# -- компонент `*citizen-portal*`. -* [*] [.underline]#Кабінет посадової особи# -- компонент `*officer-portal*`. -* [*] [.underline]#Система перевірки та версіонування коду# -- реєстровий компонент `*gerrit*`. -* [*] [.underline]#Система збірки та розгортання змін на середовищах# -- реєстровий компонент `*jenkins*`. -* [*] [.underline]#Система управління ідентифікацією користувачів реєстру та правами доступу# -- реєстровий компонент *keycloak*. -* [*] [.underline]#Сховище артефактів# -- реєстровий компонент *`nexus`*. -//// - -//Значення зберігаються до конфігурації реєстру у файл *_deploy-templates/values.yaml_*. + The values are stored in the registry configuration *_deploy-templates/values.yaml_* file. -//Відповідні параметри застосовуються завдяки Jenkins-пайплайну *`Create-registry-backup-`*. The corresponding parameters are applied through the *`Create-registry-backup-`* Jenkins pipeline. [#schedule-setup] -//== Налаштування розкладу == Setting up a schedule -//. Увійдіть до консолі *Control Plane* як адміністратор реєстру. -//TODO: How do we translate correctly into English the interface controls that are in Ukrainian as in the below example? + how do we write Registry Administrator? . Log in to the *Control Plane* console as the Registry administrator. + image:admin:infrastructure/cluster-mgmt/update-cluster-mgmt-01.png[] -//. Перейдіть до розділу [.underline]#Реєстри# та оберіть необхідний. + . Go to the [.underline]#Registries# section and select the required one. + image:admin:infrastructure/cluster-mgmt/change-key/change-key-01.png[] -//. Натисніть кнопку `Редагувати`, що розташована у правому верхньому куті. + . Click the `Edit` button located in the upper right corner. + -//NOTE: Налаштування розкладу резервного копіювання та часу зберігання резервних копій доступне також при створенні реєстру, та не є обовʼязковим. NOTE: You can also set up a backup schedule and retention time while creating a registry. However, it is not mandatory. - + image:admin:infrastructure/cluster-mgmt/change-key/change-key-02.png[] -//. Перейдіть до секції [.underline]#Резервне копіювання#. Тут можна встановити розклад створення резервних копій та період зберігання. Активуйте перемикач та налаштуйте розклад створення автоматичних резервних копій. + . Go to the [.underline]#Backup# section. Here you can set the schedule for creating backup copies and the retention period. Turn the toggle on and configure the schedule for creating automatic backup copies. + -//TIP: За замовчуванням налаштування автоматичних резервних копій вимкнено для нових реєстрів. -//TODO: How do we translate the name of this toggle into English? Is this interface element already translated? TIP: By default, the *Set automatic backup copy* toggle is turned off for new registries. - + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-01.png[] + [NOTE] ==== -//Розклад резервного копіювання налаштовується у форматі https://uk.wikipedia.org/wiki/Cron[*unix-cron*] та визначається [.underline]#за київським часом#. The backup schedule is configured in the https://uk.wikipedia.org/wiki/Cron[*unix-cron*] format and is defined based on [.underline]#Kyiv time#. -//За замовчуванням часовий пояс `*Europe/Kiev*` встановлюється у конфігурації _values.yaml_ та на рівні поди з Jenkins як змінна середовища. By default, the `*Europe/Kiev*` time zone is set in the _values.yaml_ configuration and at the Jenkins pod level as an environment variable. -//Враховується https://24timezones.com/%D0%9A%D0%B8%D1%97%D0%B2/%D1%87%D0%B0%D1%81[зміщення] на +2 години (`UTC+2`) у зимовий та +3 години (`UTC+3`) у літній час. The https://24timezones.com/%D0%9A%D0%B8%D1%97%D0%B2/%D1%87%D0%B0%D1%81[offset] of +2 hours (`UTC+2`) in winter and +3 hours (`UTC+3`) in summer is taken into account. -//Скористайтеся ресурсом https://crontab.guru/[] -- простим та зручним редактором для виразів cron, щоб краще зрозуміти логіку налаштувань розкладу. Use the https://crontab.guru/[] resource, a simple and convenient cron expression editor, to better understand the logic of schedule settings. ==== -//* У полі `Розклад` вкажіть, наприклад, таке значення: `5 10 * * MON-FRI`. Використовуйте пробіл як роздільник. -* In the `Schedule` field, enter, for example, the following value: `5 11 * * MON-FRI`. Use a space as a separator. + +* In the `Schedule` field, enter, for example, the following value: `5 11 * * MON-FRI`. Use space as a separator. + -//Це означатиме, що резервна копія для середовища реєстру створюватиметься кожного дня, з понеділка по п'ятницю, о 10:05 за київським часом. -//TODO: Kiev or Kyiv? This means that a backup copy for the registry environment will be created every day from Monday to Friday at 10:05 according to Kyiv time. + -//TIP: Після введення розкладу резервного копіювання, на інтерфейсі з'являється підказка, яка показує час 3-х наступних запусків створення резервних копій. TIP: After entering the backup schedule, a hint appears on the interface showing the time of the next 3 backup creation runs. -//* У полі `Час зберігання (днів)` вкажіть, наприклад, `5`. Тобто бекап зберігатиметься у сховищі протягом 5 днів. -//TODO: Interface element above name in English? + * In the `Retention time (days)` field, enter, for example, the following value: `5`. This means that the backup will be stored in the repository for 5 days. + -//NOTE: Значення може бути лише додатним числом та не меншим за 1 день. Рекомендуємо встановити час збереження більшим за період між створенням копій. NOTE: The value can only be a positive number and should not be set to less than 1 day. It is recommended to set the retention time longer than the period between creating copies. - + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-02.png[] -//. Натисніть kbd:[ПІДТВЕРДИТИ], щоб зберегти зміни. + . Click kbd:[CONFIRM] to save the changes. + -//В результаті сформується запит на оновлення зі статусом `Новий`. As a result, a request for update with the status `New` will be generated. -//. Поверніться до розділу `Реєстри`, прокрутіть бігунок униз сторінки та знайдіть секцію `Запити на оновлення`. -//TODO: How to properly translate the names of the interface elements above? + . Go back to the `Registries` section, scroll down the page, and find the `Requests for update` section. + image:registry-management/cp-submit-mr/cp-submit-mr-1.png[] -//. Відкрийте сформований запит, натиснувши іконку перегляду -- 👁. + . Open the generated request by clicking the view icon -- 👁. + -//NOTE: Запропоновані зміни вносяться до конфігурації файлу *_deploy-templates/values.yaml_* у разі підтвердження. NOTE: The proposed changes will be applied to the *_deploy-templates/values.yaml_* configuration file upon confirmation. -//. У новому вікні зіставте 2 версії змін, переконайтеся, що внесені вами дані вірні, та натисніть kbd:[Підтвердити]. Ви також можете відразу відхилити зміни до конфігурації, натиснувши kbd:[Відхилити]. + . In the new window, compare the two versions of the changes, make sure the data you entered is correct, and click kbd:[Confirm]. You can also reject the changes to the configuration immediately by clicking kbd:[Reject]. + -//TIP: У вікні для порівняння можна зручно перевірити 2 версії змін: поточну (зліва) та нову (справа). TIP: The comparison window allows you to conveniently check the two versions of the changes: the current one (on the left) and the new one (on the right). - + -image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-6.png[] +image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-12.png[] + image:registry-management/cp-submit-mr/cp-submit-mr-3.png[] + -//У результаті запит набуває статусу `Підтверджено`. У встановлений час запускається Jenkins-пайплайн *`Create-registry-backup-`*. Він застосовує параметри заданої конфігурації та створює резервні копії у сховищі бекапів. As a result, the request will change the state to `confirmed`. At the specified time, the *`Create-registry-backup-`* Jenkins pipeline will be triggered. It applies the parameters of the specified configuration and creates backups in the backup repository. -//. Зачекайте, доки виконається збірка коду. Це може зайняти декілька хвилин. + . Wait until the code build is completed. This may take a few minutes. -//== Перевірка створених бекапів == Checking the created backups -//У визначену дату та час мають бути створені резервні копії, згідно із розкладом, вказаним у конфігурації (_див. -- xref:#schedule-setup[]_). At the specified date and time, backups should be created according to the schedule specified in the configuration (_see --xref:#schedule-setup[]_) -//Перевірити це можна наступним чином: :: You can check this as follows: :: + -//. У відомостях про реєстр відкрийте секцію [.underline]#Компоненти реєстру# та перейдіть до *Jenkins*. -//TODO: What is the correct English name of the above interface section? + . In the registry information, open the [.underline]#Registry components# section and navigate to *Jenkins*. + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-1.png[] -//. Перейдіть до теки з необхідним реєстром та оберіть пайплайн *`Create-registry-backup-`*. Якщо пайплайн підсвічується зеленим, то збірку можна вважати успішною. + . Go to the folder with the corresponding registry and select the *`Create-registry-backup-`* pipeline. If the pipeline is highlighted in green, the build can be considered successful. + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-2.png[] -//. Відкрийте деталі збірки. + . Open the build details. + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-3.png[] -//. Перейдіть до виводу консолі (`*Console Output*`), щоб переглянути технічний лог виконання пайплайну. -//TODO: Should we leave below Console Output two times? + . Go to the console output (`*Console Output*`) to view the technical log of the pipeline execution. + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-4.png[] -//. Прокрутіть бігунок униз сторінки та переконайтеся, що резервну копію реєстру створено. + . Scroll down the page and make sure that the registry backup has been created. + -.Console Output. Успішне створення резервної копії реєстру .Console Output. Successful creation of registry backup - ==== ---- [INFO] Velero backup - external-1-2023-02-17-17-07-36 done with Completed status ---- -//Вираз показує, що створено резервну копію для реєстру із певною назвою (_тут_ -- `external-1`), дату та час створення бекапу та статус успішного завершення. + This expression indicates that a backup has been created for the registry with a specific name (_here_ - `external-1`), the date and time of backup creation, and the successful completion status. ==== + image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-5.png[] - + -//IMPORTANT: Після закінчення строку зберігання, система бекапування видаляє застарілі резервні копії. -IMPORTANT: After the retention period expires, the backup system deletes outdated backup copies. +IMPORTANT: After the retention period expires, the backup system deletes outdated backup copies. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/registry-management/control-plane-create-registry.adoc b/docs/en/modules/admin/pages/registry-management/control-plane-create-registry.adoc index 245fa3590e..4700b934e9 100644 --- a/docs/en/modules/admin/pages/registry-management/control-plane-create-registry.adoc +++ b/docs/en/modules/admin/pages/registry-management/control-plane-create-registry.adoc @@ -3,13 +3,10 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Після успішного xref:installation/platform-deployment/platform-deployment-overview.adoc[встановлення Платформи на цільовому оточенні], адміністратор Платформи отримує доступ до адміністративної панелі, що має назву *Control Plane*. Вона дозволяє керувати конфігураціями інфраструктурних компонентів Платформи (`cluster-mgmt`), а також компонентів реєстру. - After successfully xref:installation/platform-deployment/platform-deployment-overview.adoc[deploying the Platform on a target environment], a Platform administrator can access the *Control Plane* admin console interface. In Control Plane, you can manage the configurations of the Platform infrastructure components (`cluster-mgmt`) and registry components. [TIP] ==== -//Посилання до сервісу *Control Plane* можливо отримати у консолі *Openshift*. Перейдіть до розділу *Networking* > *Routes*, у пошуку вкажіть значення *`control-plane`*, і посилання буде доступне у стовпці *Location*. You can find the link to *Control Plane* in the OpenShift console. Go to *Networking* > *Routes* and search for `control-plane`. The link is displayed in the *Location* column of search results. image:infrastructure/cluster-mgmt/cp-registry-deploy-12.png[] @@ -17,81 +14,61 @@ image:infrastructure/cluster-mgmt/cp-registry-deploy-12.png[] [IMPORTANT] ==== -//Розгорнути реєстр в адмін-панелі *Control Plane* може лише адміністратор Платформи з відповідними правами доступу. Для цього необхідна роль `cp-cluster-mgmt-admin` у реалмі `control-plane-admin` сервісу *Keycloak*. Only a Platform administrator with appropriate permissions can deploy a registry using the *Control Plane* admin console. This action requires a `cp-cluster-mgmt-admin` role in Keycloak's `control-plane-admin` realm. For details, see xref:admin:registry-management/control-plane-assign-platform-admins.adoc[]. ==== -//Для розгортання нового реєстру виконайте наступні кроки: :: To deploy a new registry, perform these steps: :: + -//. Увійдіть до адміністративної панелі *Control Plane*, використовуючи попередньо отримані логін та пароль. . Sign in to *Control Plane*. + image:admin:infrastructure/cluster-mgmt/update-cluster-mgmt-01.png[] -//. Перейдіть до розділу +++Реєстри+++ > далі натисніть `+++Створити новий+++`. + . Open the *Registries* section and click the *`Create New`* button. + image:infrastructure/cluster-mgmt/cp-registry-deploy-1.png[] -//. Заповніть параметри конфігурації відповідними даними. + . Configure your registry parameters. + -//TIP: Детальніше про кроки розгортання описано у розділах нижче. TIP: Read on for details on each deployment step. -//== Загальні налаштування +[#general-settings] == General settings -//На цьому кроці ви можете вказати службову (системну) назву реєстру, яка буде використовуватися у різних операціях обміну даними на Платформі. In this step, you can specify the registry's system name, which is used in various data exchange operations on the Platform. The registry name cannot be changed once the registry is created. [CAUTION] ==== -//* Назва повинна бути унікальною, і її неможливо буде змінити після створення реєстру. Поле +++Назва реєстру+++ є обов'язковим до заповнення. -//TODO: Slightly rearranged the contents of this list item. * The *Registry name* is a required field. * The name must be unique. -//* Для введення доступні лише латинські літери (`"a-z"`) та знак `"-"`. * Allowed characters are lowercase Latin letters (`a-z`) and hyphens (`-`). -//* Довжина не повинна перевищувати 12 символів. * The name cannot contain more than 12 characters. ==== -//Додатково ви можете вказати опис, який може містити офіційну назву реєстру чи його призначення. Це поле потрібне для інформаційних (бізнес- або юридичних) цілей. - You can describe the purpose of the registry or provide its official name in the *Description* field. This information may be helpful for business or legal reasons. -//Натисніть `+++Підтвердити+++` для переходу до наступного кроку. - Click *`Confirm`* to go to the next step. image:admin:registry-management/registry-create/cp-create-registry-1.png[] -//== Створення адміністраторів реєстру == Creating registry administrators -//На цьому кроці ви можете призначити _адміністраторів реєстру_. In this step, you can assign registry administrators. [NOTE] ==== -//Можливість внесення нових адміністраторів буде доступна і згодом після розгортання, через опцію редагування реєстру. You can also add administrators by editing the registry soon after its deployment. For details, see xref:registry-develop:registry-admin/create-users/create-registry-admins.adoc[]. ==== -//. У полі +++Адміністратори+++ вкажіть адміністраторів, яким буде надано доступ до реєстру. . In the *Administrators* field, specify the administrators who will have access to the registry. + -//CAUTION: Поле є обов'язковим до заповнення. -//TODO: Does it mean at least ONE admin must be added here? -CAUTION: This is a required field. +CAUTION: This is a required field. It means at least ONE admin must be added here. + image:admin:registry-management/registry-create/cp-create-registry-2-1.png[] + -//Натисніть `+` (`Додати`) та у новому вікні введіть дані кожного адміністратора реєстру, а саме: Click the *`+`* (*Add*) button and provide the following details for each registry administrator: + -- @@ -104,56 +81,42 @@ Click the *`+`* (*Add*) button and provide the following details for each regist image:admin:registry-management/registry-create/cp-create-registry-2.png[] + -//Для того, щоб надати доступ декільком особам, повторіть дію для кожного адміністратора окремо (`+` > вкажіть дані адміністратора > `+++Підтвердити+++`). To add several administrators, repeat this step for each user separately (click *`+`* > provide details > *`Confirm`*). + [NOTE] ==== -//Використовуйте нижній регістр для введення даних електронної пошти. -Use lower case for email addresses. +Use a lower case for email addresses. -//Доступні символи: `"0-9"`, `"a-z"`, `"_"`, `"-"`, `"@"`, `"."`, `","`. Allowed characters are: digits (`0-9`), Latin letters (`a-z`), underscores (`_`), hyphens (`-`), at sign (`@`), dots (`.`), and commas (`,`). ==== -//. Натисніть `+++Далі+++` для переходу до наступного кроку. -. Click *`Next`* to go to the next step. +. Click *`Next`* to go to the next step. + image:admin:registry-management/registry-create/cp-create-registry-2-2.png[] - + [NOTE] ==== -//Користувач-адміністратор реєстру автоматично створюється у реалмі `openshift` сервісу *Keycloak* із роллю `cp-registry-admin-` та групою `/cp-registry-admin-`, де `` -- назва реєстру. The registry administrator account is automatically created in the `openshift` realm of the *Keycloak* service with the `cp-registry-admin-` role in the `/cp-registry-admin-` group, where `` is the name of your registry. ==== -//== Шаблон розгортання реєстру == Registry deployment template -//На цьому кроці оберіть шаблон для розгортання реєстру. Залежно від навантаження, яке очікується на реєстр, ви можете обрати одну з доступних конфігурацій, тобто певний шаблон із відповідною кількістю ресурсів. Наприклад, мінімальна або рекомендована конфігурація, або конфігурація з геосервером тощо). - In this step, you can select a template for your registry. Templates are predefined registry configurations with a set number of resources that you can select depending on the expected workload. For example, you can choose between a minimum and recommended configuration, or select a configuration with GeoServer, and so on. -//Приблизну вартість обчислювальних ресурсів реєстру ви можете розрахувати на сторінці xref:arch:architecture/registry-cost.adoc[], або зверніться за консультацією до команди технічної підтримки Платформи. -//TODO: This feels like a TIP. -To calculate the approximate cost of the resources your registry will need, use the xref:arch:architecture/platform-system-requirements/registry-cost.adoc[] page or reach out to the Platform's technical support team. +TIP: To calculate the approximate cost of the resources your registry will need, use the xref:arch:architecture/platform-system-requirements/registry-cost.adoc[] page or reach out to the Platform's technical support team. image:admin:registry-management/registry-create/cp-create-registry-3.png[] -//. У полі +++Шаблон реєстру+++ оберіть зі списку шаблон конфігурації, відповідно до якого розгортатиметься реєстр. . Select the configuration template for your registry from the *Registry template* list. + -//Шаблон реєстру визначає параметри конфігурації та кількість інстансів для реєстру, що розгортається, тобто виділену кількість ресурсів, зокрема *CPU*, *RAM* тощо, та кількість нод у *MachineSets*. A registry template defines the configuration options and the allocated resources, including *CPU*, *RAM*, the number of nodes in *MachineSets*, and so on. + CAUTION: This is a required field. + image:admin:registry-management/registry-create/cp-create-registry-3-1.png[] -//. У полі +++Гілка шаблону реєстру+++ оберіть гілку, яка буде застосована при розгортанні реєстру. + . In the *Registry template branch* field, select the branch to use when deploying your registry. + -//NOTE: Мається на увазі версія гілки компонента у Gerrit-репозиторії, що містить відповідну версію шаблону реєстру. NOTE: This refers to the version of the component's branch in the Gerrit repository containing the corresponding registry template version. + CAUTION: This is a required field. @@ -161,27 +124,19 @@ CAUTION: This is a required field. image:admin:registry-management/registry-create/cp-create-registry-3-2.png[] . Click *`Next`* to go to the next step. - + image:admin:registry-management/registry-create/cp-create-registry-3-3.png[] -//== Вибір поштового сервера == Mail server settings -//На цьому кроці оберіть тип поштового сервера для відправлення email-повідомлень у реєстрі. - In this step, you can select the type of mail server your registry will use for sending email messages. -//CAUTION: Крок є опціональним. Ви можете пропустити ці налаштування. Їх можна змінити під час редагування реєстру. - CAUTION: The step is optional. You can skip it when creating a registry and return to these settings when editing it. image:admin:registry-management/registry-create/cp-create-registry-4.png[] -//* +++Внутрішній поштовий сервер+++ (`*platform-mail-server*`) — поштовий сервер, який розповсюджується як платформний сервіс та доступний для використання усіма реєстрами одного екземпляра Платформи. -//TODO: ua: "платформенний" * *Platform mail server* (`platform-mail-server`) is a mail server distributed as part of the Platform. This service is available to all registries within a single instance of the Platform. -//* +++Зовнішній поштовий сервер+++ (*`external-mail-server`*) — зовнішній відносно платформи поштовий сервіс (*gmail* тощо). + * *External mail server* (`external-mail-server`) is a mail server outside the Platform (such as *Gmail*). [TIP] @@ -191,22 +146,16 @@ For details, see xref:registry-develop:registry-admin/user-notifications/email/c Click *`Next`* to go to the next step. -//== Дані про ключ -== Key info -//TODO: This section contains a lot of ua-specific stuff. +== Information about keys -//На цьому кроці налаштуйте параметри конфігурації для ключів та сертифікатів цифрового підпису, які будуть використовуватись у реєстрі. Надалі дані про ключ можна оновлювати при редагуванні реєстру. In this step, you can configure your registry's digital signature keys and certificates. Once the registry is created, you will be able to update these settings by editing your registry. [IMPORTANT] ==== -//Крок є обов'язковим. This step is mandatory. -//Секція +++Дані про ключ+++ має містити налаштування для ініціалізації криптосервісу (*`digital-signature-ops`*) та накладання системного підпису (цифрової печатки системи). Без внесення цих даних пода криптосервісу не запуститься. Data in the *Key info* section is required to initialize the `digital-signature-ops` crypto service and apply the system signature, or system digital seal. Without this information, the crypto service will not start. -//Такі ключі використовуються для підпису витягів, сформованих Платформою, та підпису даних, що змінюються відповідно до логіки бізнес-процесів реєстру. Encryption keys are used to sign excerpts generated by the Platform and to sign data that is modified according to the logic of the registry's business processes. ==== @@ -215,31 +164,26 @@ Encryption keys are used to sign excerpts generated by the Platform and to sign For details on configuring keys, see xref:registry-management/system-keys/control-plane-registry-keys.adoc[]. ==== -//. У полі +++Тип носія+++ оберіть відповідний тип ключа, що використовується. . In the *Media type* field, select the type of key to use. -//. Оберіть електронний ключ. + . Provide the electronic key. + -//Поле +++Файловий ключ (розширення .dat)+++ заповнюється операційним ключем із розширенням `.dat` (_Key-6.dat_) адміністратора Платформи. Завантажте файл із ключем, натиснувши kbd:[*Browse*], оберіть ключ у відповідній директорії та натисніть kbd:[*Open*]. Upload the Platform administrator's operational key file (_Key-6.dat_) using the *File key (.dat)* field. Click kbd:[*Browse*], locate the key file on your computer, select it, and click kbd:[Open]. -//. У полі +++АЦСК, що видав ключ+++ показана повна назва АЦСКfootnote:[**АЦСК** - Акредитований центр сертифікації ключів.], що видав ключ. -//TODO: Removed the footnote to simplify this. + . The *AKCC that issued the key* field displays the full name of the AKCC (Accredited Key Certification Center). -//TODO: "АЦСК, що видав ключ" та "Емітент ключа" - це одне й те саме? -//. У полі +++Пароль до файлового ключа+++ введіть пароль до завантаженого ключа. + . In the *File key password* field, enter the password for the key you uploaded. -//. Секція +++Дані для перевірки ключа+++ містить дані публічних сертифікатів та перелік АЦСК: + . The *Key validation info* section contains public certificates data and a list of AKCCs: -//* У полі +++Публічні сертифікати АЦСК (розширення .p7b)+++ завантажте файл із переліком сертифікатів сумісних ЦСК (https://iit.com.ua/download/productfiles/CACertificates.p7b[CACertificates.p7b]), який можна отримати на сайті АТ "ІІТ" за посиланням https://iit.com.ua/downloads. + * Upload the https://iit.com.ua/download/productfiles/CACertificates.p7b[CACertificates.p7b] file that contains a list of certificates of compatible AKCCs using the *Public AKCC certificates (.p7b)* field. You can download this file from the IIT website: https://iit.com.ua/downloads. -//* У полі +++Список АЦСК (розширення .json)+++ завантажте файл із параметрами взаємодії сумісними ЦСК (link:https://iit.com.ua/download/productfiles/[CAs.json]), який можна отримати на сайті АТ "ІІТ" за посиланням: https://iit.com.ua/downloads. + * Upload the https://iit.com.ua/download/productfiles/[CAs.json] file that contains interaction parameters for compatible AKCCs using the *AKCCs list (.json)* field. You can download this file from the IIT website: https://iit.com.ua/downloads. -//. Вкажіть +++Перелік дозволених ключів+++, підпис яких може вважатися дійсним. + . In the *Allowed keys list*, specify the keys whose signatures are considered valid. + [NOTE] ==== -//У цьому блоці зазначається перелік ключів, у тому числі й старих (наприклад, при ротації ключів), щоб все, що раніше було підписано старим ключем, вважалося валідованим. Тобто перелік дозволених ключів повинен містити історію даних усіх ключів, що використовувались у системі для накладання підпису. This section contains a list of all keys, including old ones (for example, when rotating keys), so that everything previously signed with an old key is still considered validated. That is, the list of allowed keys should contain the data history of all the keys used in the system to apply a signature. ==== @@ -247,48 +191,39 @@ This section contains a list of all keys, including old ones (for example, when image:admin:registry-management/registry-create/cp-create-registry-5.png[] -//== Ресурси реєстру == Registry resources -//На цьому кроці ви можете визначити конфігурацію для ресурсів реєстру по певних сервісах, які у ньому розгортаються. Керування ресурсами, що використовуються контейнерами в рамках вашого екземпляра реєстру, дозволяє забезпечити оптимальну працездатність та ефективність. In this step, you can configure registry resources for specific services that are deployed in it. Properly managing the resources used by containers within your registry instance ensures optimal performance and efficiency. -//. Оберіть зі списку сервіс для конфігурації ресурсів і натисніть *`+`* (`Додати`). . Select the service you wish to configure from the list and click *`+`* (*Add*). + [CAUTION] ==== This step is optional. -//Під час розгортання реєстру усі наявні сервіси налаштовані та передзаповнені відповідними значеннями запитів, лімітів та змінних оточення за замовчуванням. -//TODO: про які "запити" тут йдеться? When the registry is deployed, all its services are configured using the default values for requests, limits, and environment variables. -//Навіть у випадку видалення сервісів зі списку, під час розгортання реєстру Платформа застосує стандартну конфігурацію. -//TODO: Not clear how services are removed from the list. Even if services are removed from the list, the Platform will apply the standard configuration when deploying the registry. ==== + image:admin:registry-management/registry-create/cp-create-registry-7.png[] -//. Встановіть власні значення для ресурсів. + . Customize resource parameters. + . Click *`Next`* to go to the next step. + image:admin:registry-management/registry-create/cp-create-registry-7-1.png[] TIP: For details on configuring the resources, see xref:registry-management/control-plane-registry-resources.adoc[]. -//== Налаштування DNS == DNS settings -//На цьому кроці ви можете встановити власні DNS-імена і завантажити SSL-сертифікати у `.pem`-форматі для сервісу Keycloak, а також Кабінетів користувачів. In this step, you can set custom DNS names and upload SSL certificates in `.pem` format for the Keycloak service and user portals. [CAUTION] ==== This step is optional. -//Якщо ви не вкажете тут жодних налаштувань, система використає значення за замовчуванням. If you do not configure anything here, the system will use the default values. ==== @@ -298,15 +233,12 @@ TIP: For details on configuring DNS, see xref:admin:registry-management/custom-d Click *`Next`* to go to the next step. -//== Обмеження доступу == Access restrictions -//На цьому кроці ви можете встановити обмеження доступу до певних компонентів, які використовуються у реєстрі, зокрема _Кабінетів посадової особи та отримувача послуг_, а також _адміністративних компонентів реєстру_. In this step, you can restrict access to specific registry components, such as user portals and administrative components. [CAUTION] ==== -//Крок є опціональним, але з метою безпеки рекомендовано встановити CIDR для відповідних компонентів. This step is optional, but we recommend configuring CIDR for these components for security purposes. ==== @@ -318,31 +250,28 @@ Click *`Next`* to go to the next step. == Officers (service providers) authentication -//На цьому кроці ви можете налаштувати тип автентифікації для надавачів послуг (посадових осіб), а також дозволити, або заборонити можливість автореєстрації. In this step, you can configure authentication for service providers (officers) and enable or disable self-registration. [CAUTION] ==== This step is optional. -//Якщо ви не вкажете тут жодних налаштувань, система використає значення за замовчуванням -- автентифікація з КЕП та вимкнена автореєстрація. If you do not configure anything here, the system will use the default values: authentication using Qualified Electronic Signature (QES) and disabled self-registration. ==== image:admin:registry-management/registry-create/cp-create-registry-9.png[] -//Ви можете обрати один із двох типів автентифікації, який буде доступний для ідентифікації особи в системі: Select the authentication type to use when identifying users in the system: -//TODO: ua-specific: I think we can keep the QES option without referring to IIT, but remove the id.gov.ua widget option. -//* КЕП (*IIT*-віджет) -* QES -//* Віджет *id.gov.ua* -* *id.gov.ua* widget +-- +* QES -- a widget to authenticate users via Qualified electronic signatures. +* *id.gov.ua* -- a widget to authenticate users via third-party digital identification providers. +-- + +include::ROOT:partial$admonitions/ua-specific.adoc[] TIP: For details, see xref:registry-develop:registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc[]. -//Самостійна реєстрація посадових осіб дозволить вам спростити процес реєстрації користувачів без необхідності залучення адміністратора. You can enable the self-registration option for officers to simplify the user registration process by removing the need to involve an administrator. TIP: For details, see xref:registry-develop:registry-admin/cp-auth-setup/cp-officer-self-registration.adoc[]. @@ -353,45 +282,31 @@ Click *`Next`* to go to the next step. include::ROOT:partial$admonitions/ua-specific.adoc[] -//TODO: ua-specific, probably irrelevant to non-ua Platform -//На цьому кроці ви можете налаштувати перевірку наявності активного запису в ЄДР для бізнес-користувачів, що дозволяє встановити зв'язок між КЕП користувача та його юридичною особою чи фізичною особою-підприємцем, що зареєстровані в Єдиному державному реєстрі (ЄДР). Це важливий аспект безпеки та надійності системи, який допомагає забезпечити відповідність даних користувача та підтвердження їх особистості. In this step, you can set up validation to check whether business users have an active entry in the Unified state register (EDR). This allows the system to connect the user's QES with their legal records in the state register. This is an important aspect of the system's security and reliability that helps validate user data and confirm their identity. [CAUTION] ==== This step is optional. -//Якщо ви не вкажете тут жодних налаштувань, система використає значення за замовчуванням -- перевірка увімкнена. If you do not configure anything here, the system will use the default value: validation disabled. ==== image:admin:registry-management/registry-create/cp-create-registry-10.png[] -//TIP: For details, see xref:registry-develop:registry-admin/cp-auth-setup/cp-auth-setup-citizens.adoc[]. - Click *`Next`* to go to the next step. -//== Резервне копіювання == Backup settings -//На цьому кроці ви можете налаштувати розклад створення резервних копій компонентів реєстру, а також період зберігання таких копій у сховищі бекапів. In this step, you can set the backup schedule for your registry components and define the retention period for backup copies in the backup repository. -//Резервні копії компонентів створюються за допомогою інструменту *`velero`* та зберігаються у захищеному сховищі бекапів *`minio`*, що знаходиться поза межами кластера Платформи. Component backup copies are created using the *Velero* tool and stored in the *MinIO* secure backup storage outside the Platform cluster. -//Розклад резервного копіювання налаштовується у форматі https://uk.wikipedia.org/wiki/Cron[*unix-cron*] на інтерфейсі адміністративної панелі *Control Plane*. The backup schedule is configured using the https://uk.wikipedia.org/wiki/Cron[*unix-cron*] format in the *Control Plane* admin console interface. -//Також система виконує автоматичну реплікацію даних, які зберігаються в S3-бакетах. Ви можете налаштувати розклад резервного копіювання таких реплікацій. The system also performs automatic replication of data stored in S3 buckets. You can configure a backup schedule for these replications. image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-registry-components-8-1.png[] -//TIP: Детальніше про автоматичне створення резервних копій реєстру, а також резервне копіювання реплікацій S3-бакетів, читайте на сторінці xref:admin:backup-restore/backup-schedule-registry-components.adoc[]. - -//TIP: Додатково ознайомтеся зі створенням бекапів у ручному режимі та відновленням з них середовища реєстру на сторінці xref:admin:backup-restore/control-plane-backup-restore.adoc[]. - [TIP] ==== * To learn about creating registry backups _automatically_ and configuring backups for S3 bucket replications, see xref:admin:backup-restore/backup-schedule-registry-components.adoc[]. @@ -400,26 +315,20 @@ image:admin:backup-restore/backup-schedule-registry-components/backup-schedule-r Click *`Next`* to go to the next step. -//== Підтвердження та процес розгортання == Confirmation and deployment -//Завершіть процедуру натисканням клавіші `+++Створити реєстр+++`. To complete the procedure, click the *Create registry* button. -//Ви можете також перевірити дані, внесені на попередніх кроках, переміщаючись між відповідними вкладками. You can go back to any of the settings tabs to double-check the data you provided. image:admin:registry-management/registry-create/cp-create-registry-12.png[] -//У результаті реєстр додається до переліку доступних у розділі +++Реєстри+++ адміністративної панелі *Control Plane*. As a result, the registry appears in the *Registries* section of the *Control Plane* admin console interface. -//У разі успішного розгортання, реєстр позначається зеленою піктограмою у стовпці +++Статус+++. If the registry is deployed successfully, a green check mark appears next to its name in the *Status* column. image:admin:registry-management/registry-create/cp-create-registry-12-2.png[] -//Розгортання реєстру займає певний час і виконується автоматично сервісом Jenkins. Сервіс запускає процес (пайплайн), що має назву *Master-Build-``*, де `` -- назва реєстру. Переглянути статус розгортання можна, перейшовши до розділу +++Реєстри+++ > відкрийте щойно створений реєстр > +++Конфігурація+++ > *CI*. Deploying the registry takes some time. The Jenkins service starts the deployment automatically by running the pipeline called *Master-Build-``*, where `` is the name of your registry. To monitor the deployment process, go to the *Registries* section and open the registry you just created, then scroll down to the *Configuration* section and click the *Jenkins* link icon in the *CI* column. image:admin:registry-management/registry-create/cp-create-registry-12-1.png[] diff --git a/docs/en/modules/admin/pages/registry-management/control-plane-edit-registry.adoc b/docs/en/modules/admin/pages/registry-management/control-plane-edit-registry.adoc index 3de0fe5d64..bf51a63e19 100644 --- a/docs/en/modules/admin/pages/registry-management/control-plane-edit-registry.adoc +++ b/docs/en/modules/admin/pages/registry-management/control-plane-edit-registry.adoc @@ -1,170 +1,129 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Перегляд та внесення змін до конфігурації реєстру = Viewing and editing registry configuration +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Редагування основних налаштувань реєстру == Editing general settings -//Після успішного xref:registry-management/control-plane-create-registry.adoc[розгортання], ви можете переглядати поточні налаштування реєстру та вносити зміни до його конфігурацій. Зробити це можна у 2 простих кроки: After successfully xref:registry-management/control-plane-create-registry.adoc[deploying your registry], you can view and edit its settings. You can do this in two simple steps: -//. Увійдіть до адміністративної панелі *Control Plane* як xref:registry-develop:registry-admin/create-users/create-registry-admins.adoc[адміністратор реєстру]. . Sign in to the Control Plane admin console as the xref:registry-develop:registry-admin/create-users/create-registry-admins.adoc[registry administrator]. -//. Відкрийте розділ +++Реєстри+++, знайдіть необхідний та натисніть іконку редагування `🖉`. + . Open the *Registries* section, find the registry you wish to edit, and click the edit icon (🖉). image:registry-management/registry-edit/cp-edit-registry-1.png[] -//В результаті ви потрапите до розділу +++Редагування реєстру+++. Тут ви можете оновити налаштування, зокрема: As a result, the *Edit registry* page opens. Here you can update the following settings: -* xref:registry-management/control-plane-create-registry.adoc#general-settings[General settings] +* xref:admin:registry-management/control-plane-create-registry.adoc#general-settings[General settings] * xref:registry-develop:registry-admin/create-users/create-registry-admins.adoc[Adding or removing administrators] * xref:registry-develop:registry-admin/user-notifications/email/config-smtp-server.adoc[] * xref:registry-management/system-keys/control-plane-registry-keys.adoc[] -* xref:registry-management/сontrol-plane-registry-resources.adoc[] +* xref:registry-management/control-plane-registry-resources.adoc[] * xref:admin:registry-management/custom-dns/custom-dns-overview.adoc[] * xref:admin:registry-management/control-plane-cidr-access-endpoints.adoc[] * xref:registry-develop:registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc[Service providers authentication] * xref:registry-develop:registry-admin/cp-auth-setup/cp-auth-setup-citizens.adoc[Service recipients authentication] * xref:admin:backup-restore/backup-schedule-registry-components.adoc[Backup] -//NOTE: Внесення змін до конфігурації реєстру відбувається за GitOps-підходом, подібно до процесу xref:registry-management/control-plane-create-registry.adoc[розгортання]. NOTE: Updating the registry configuration follows the GitOps approach, similar to the xref:registry-management/control-plane-create-registry.adoc[deployment] process. -//Ви можете також перейти до редагування згаданих вище налаштувань не одразу, а через перегляд відомостей про реєстр. You can open the *Edit registry* page either from the list of registries (using the edit icon) or the registry details page (using the *`Edit`* button in the upper-right corner). image:registry-management/registry-edit/cp-edit-registry-2.png[] -//== Перегляд відомостей про реєстр, налаштування доступу та зовнішніх інтеграцій == Viewing registry details, access settings, and external integrations -//Ви можете переглядати основну інформацію про реєстр, що розгорнуто на Платформі, додавати або видаляти доступи до реєстру, налаштовувати зовнішні інтеграції за SOAP-протоколом або REST, переглядати конфігурацію реєстру, а також підтверджувати або відхиляти запити на оновлення конфігурації. You can view basic information about the registries deployed on the Platform, manage access to your registry, configure external SOAP or REST integrations, view registry configuration, and approve or reject configuration update requests. -//. Увійдіть до адміністративної панелі *Control Plane* як xref:registry-develop:registry-admin/create-users/create-registry-admins.adoc[адміністратор реєстру]. . Sign in to the *Control Plane* admin console as the xref:registry-develop:registry-admin/create-users/create-registry-admins.adoc[registry administrator]. -//. Знайдіть розділ +++Реєстри+++ та відкрийте необхідний. + . Go to the *Registries* section and click the name of your registry. + -//На цій сторінці ви можете побачити 2 основні вкладки: The registry details page contains two tabs: - ++ [tabs] ==== -//Інформація про реєстр:: + Registry information:: + -- [#sections] -//+++Сторінка поділена декілька основних секцій:+++ :: + This tab contains the following sections: :: -//* +++Загальна інформація+++. + -//Ви можете переглянути її й відредагувати за необхідності. + * *General information*. You can view and edit it if needed. -//TODO: I cannot edit anything in this section, but maybe I just don't have permissions? + image:registry-management/registry-edit/cp-edit-registry-3.png[] + WARNING: The registry name cannot be changed. -//* +++Налаштування взаємодії з реєстрами через Трембіту+++. + -//Ви можете налаштувати інтеграцію із реєстрами-учасниками СЕВ ДЕІР "Трембіта" за *SOAP*-протоколом. -//TODO: ua-specific + * *Setting up interaction with registries via Trembita*. You can set up interaction with other registries that are part of the SEI SEIR Trembita system via the *SOAP* protocol. + image:registry-management/registry-edit/cp-edit-registry-4.png[] + TIP: For details, see xref:registry-develop:registry-admin/external-integration/cp-integrate-trembita.adoc[]. -//* +++Налаштування взаємодії з іншими системами+++. + -//Ви можете налаштувати інтеграцію з іншими реєстрами та зовнішніми системами за допомогою *REST*. + * *Setting up interaction with other systems*. You can set up interaction with other registries and external systems via the *REST* protocol. + image:registry-management/registry-edit/cp-edit-registry-5.png[] + TIP: For details, see xref:registry-develop:registry-admin/external-integration/cp-integrate-ext-system.adoc[]. -//* +++Доступ для реєстрів Платформи та зовнішніх систем+++. + -//Ви можете додавати або видаляти доступи до реєстру для інших реєстрів на Платформі або зовнішніх систем. + * *Access to Platform registries and external systems*. You can configure access to your registry for other registries on the Platform or external systems. + image:registry-management/registry-edit/cp-edit-registry-6.png[] + TIP: For details, see xref:registry-management/control-plane-registry-grant-access.adoc[]. -//* +++Конфігурація+++. + -//Секція містить посилання до: -//** *`VCSfootnote:[+++Система керування версіями +++ (СКВ, англ. **_Version Control System_**, VCS) — програмний інструмент для керування версіями одиниці інформації: початкового коду програми, скрипту, вебсторінки, вебсайту, 3D-моделі, текстового документа тощо. -//_Система керування версіями_ — інструмент, який дозволяє одночасно, не заважаючи один одному, проводити роботу над груповими проєктами.]`* -- сервісу інспекції та зберігання змін регламенту (Gerrit) -//** *`CIfootnote:[+++Неперервна інтеграція+++ (англ. **_Continuous Integration_**) — практика розробки програмного забезпечення, яка полягає у виконанні частих автоматизованих складань проєкту для якнайшвидшого виявлення та розв'язання інтеграційних проблем.]`* -- сервісу розгортання регламенту (Jenkins). + * *Configuration*. This section contains the following links: ** **VCS**footnote:[*Version Control System* (VCS) is a software tool for managing versions of information units such as the source code of a program, script, web page, website, 3D model, text document, and so on. VCS enables multiple people to collaborate on the same project without interfering with each other.]: Regulations changes review and storage service (Gerrit). ** **CI**footnote:[*Continuous Integration* (CI) is a software development practice involving frequent automated project builds to identify and resolve integration issues as quickly as possible.]: Regulations deployment service (Jenkins). + image:registry-management/registry-edit/cp-edit-registry-7.png[] -//* +++Запити на оновлення+++. + -//Ви можете вносити зміни до конфігурації реєстру шляхом редагування відповідних налаштувань. Такі зміни потрапляють на до секції +++Запити на оновлення+++, де їх можна переглянути та xref:registry-management/control-plane-submit-mr.adoc[підтвердити або відхилити]. + * *Update requests*. You can change your registry configuration by editing any of its settings. These changes go to the *Update requests* section, where you can review and either xref:registry-management/control-plane-submit-mr.adoc[approve or reject] them. + image:registry-management/registry-edit/cp-edit-registry-8.png[] -- -//Швидкі посилання :: Quick links :: + -//Секція містить швидкі посилання до вебінтерфейсів різних сервісів з коротким описом їх призначення. + This tab contains links to the web interfaces of the various services with brief descriptions. + TIP: For details, see xref:registry-management/control-plane-quick-links.adoc[]. - ==== [#registry-deploy-status] -//== Перевірка відомостей про розгортання змін == Monitoring the deployment of changes -//Розгортання змін до конфігурації займає певний час і виконується автоматично сервісом Jenkins. Сервіс запускає процес (пайплайн), що має назву *Master-Build-``*, де `` -- назва реєстру. Переглянути статус розгортання можна, перейшовши до розділу +++Реєстри+++ > ваш реєстр > +++Конфігурація+++ > *CI*. - Deploying configuration changes takes some time. The Jenkins service starts the deployment automatically by running the *Master-Build-``* pipeline, where `` is the name of your registry. To monitor the deployment process, go to the *Registries* section and open the registry you modified, then scroll down to the *Configuration* section and click the *Jenkins* link icon in the *CI* column. image:admin:registry-management/registry-create/cp-create-registry-12-1.png[] image:admin:registry-management/registry-create/cp-create-registry-12-3.png[] -//Загалом у центральному компоненті Jenkins передбачено декілька процесів (пайплайнів), зокрема: -//TODO: Is it OK to call these OOB? The central Jenkins component provides several out-of-the-box processes (pipelines): -//+++Службові процеси+++ :: Виконують різні службові функції та підготовчі дії до запуску основних пайплайнів. До таких відносять: Service processes :: Service processes perform various auxiliary functions and set the stage for the main pipelines. These include: -//* *Create-release-``* -- виконує ряд службових операцій, зокрема клонування репозиторію та створення нової гілки. Запускає службовий пайплайн із назвою `job-provisions » ci » default-` із підготовчими кроками для подальшого процесу CI/CD, де `` -- номер версії збірки, що відповідатиме git-тегу у Gerrit. * *Create-release-``* performs several service operations, including cloning the repository and creating a new branch. Starts a service pipeline named `job-provisions` > `ci` > `default-` (where `` is the version number of the build that corresponds to the Git tag in Gerrit), which prepares the stage for the subsequent CI/CD process. -//* *MASTER-Code-review-``* -- системний процес перевірки якості коду, який запускається автоматично через `git push` до `master`-гілки репозиторію Gerrit. + * *MASTER-Code-review-``* is a system process of code quality review that is launched automatically via `git push` to the `master` branch of the Gerrit repository. -//+++Основні процеси+++ :: -//Виконують збірку коду для розгортання різних функціональних складових реєстру. До таких відносять: + Main processes :: Main processes build the code used to deploy various functional components of the registry. These include: -//* *Master-Build-``* -- основний процес для збірки коду при розгортанні або оновленні конфігурації реєстру, зокрема виділення ресурсів, розгортання сервісів реєстру, як-то Кабінети користувачів, система виконання бізнес-процесів (BPMS), база даних, компоненти Фабрики даних, розгортання порожнього регламенту тощо. -//TODO: Складнувате речення, не зрозуміло, що до чого відноситься * *Master-Build-``* is the primary code build process for deploying or updating the registry configuration. This includes resource allocation, deployment of registry services such as user portals, Business Process Management System (BPMS), database, data factory components, empty regulations deployment, and so on. -//* *Create-registry-backup-``* -- процес, який створює резервні копії реєстру (бекапи) та поміщає їх до об'єктного сховища *Minio*. + * *Create-registry-backup-``* is a process that creates registry backups and puts them in the *MinIO* object storage. -//* *Restore-registry-``* -- процес, який дозволяє створити (відновити) реєстр із резервної копії. + * *Restore-registry-``* is a process that enables you to create (restore) a registry from a backup copy. -//* *Delete-release-``* -- процес, який дозволяє видалити реєстр. + * *Delete-release-``* is a process that enables you to delete a registry. + diff --git a/docs/en/modules/arch/images/architecture/registry/operational/ext-api-management/registry-ext-traffic-subsystem.drawio.svg b/docs/en/modules/arch/images/architecture/registry/operational/ext-api-management/registry-ext-traffic-subsystem.drawio.svg index c0f2813a8b..3e87802a1d 100644 --- a/docs/en/modules/arch/images/architecture/registry/operational/ext-api-management/registry-ext-traffic-subsystem.drawio.svg +++ b/docs/en/modules/arch/images/architecture/registry/operational/ext-api-management/registry-ext-traffic-subsystem.drawio.svg @@ -1,4 +1,4 @@ - + -
Registry operational zone
Registry operational zone
External traffic management subsystem
External traffic management subsystem
Incoming traffic
Incoming traffic
External traffic management
subsystem
External traffic management...
Container orchestration platform
Container orchestration platform
Citizens
Citizens
Officers
Officers
Cross-service communication
Cross-service communicati...
Platform subsystem
Platform subsystem
Target subsystem component
Target subsystem component
Registry data management subsystem
Registry data management sub...
User and roles management
subsystem
User and roles management...
External integrations
subsystem
External integrations...
Registry subsystem
Registry subsystem
Business process
management subsystem
Business process...
User settings management
subsystem
User settings management...
Registry excerpt generation subsystem
Registry excerpt generation...
External systems simulation
API subsystem
External systems simulation...
User notification subsystem
User notification subsystem
Registry analytical
reporting subsystem
Registry analytical...
Geodata management
subsystem
Geodata management...
Operator's control action
Operator's control action
Non-relational database management system
Non-relational database manage...
sessions
sessions
Операційне сховище
сесій користувачів
Операційне сховище...
ServiceMesh-gateway
(istio-ingressgateway)
ServiceMesh-gateway...
External API gateway
of the registry operational zone (kong-kong)
External API gateway...
Istio Envoy
Istio Envoy
Save user sessions
Save user sessions
User authentication
User authentication
Redirect user traffic
Redirect user traffic
Kong Proxy
Kong Proxy
User traffic
redirectio
User traffic...
Unauthorized
users
Unauthor...
Redirect user traffic
Redirect user traffic
Get configuration
Get configuration
Ingress Controller
Ingress Controller
трафік
трафік
Налаштування
Налаштування
Cross-service communication with mTLS authentication
Cross-service communication w...
User portal subsystem
User portal subsystemText is not SVG - cannot display \ No newline at end of file +
Registry operational zone
Registry operational zone
External traffic management subsystem
External traffic management subsystem
Incoming traffic
Incoming traffic
External traffic management
subsystem
External traffic management...
Container orchestration platform
Container orchestration platform
Citizens
Citizens
Officers
Officers
Cross-service communication
Cross-service communicati...
Platform subsystem
Platform subsystem
Target subsystem component
Target subsystem component
Registry data management subsystem
Registry data management sub...
User and roles management
subsystem
User and roles management...
External integrations
subsystem
External integrations...
Registry subsystem
Registry subsystem
Business process
management subsystem
Business process...
User settings management
subsystem
User settings management...
Registry excerpt generation subsystem
Registry excerpt generation...
External systems simulation
API subsystem
External systems simulation...
User notification subsystem
User notification subsystem
Registry analytical
reporting subsystem
Registry analytical...
Geodata management
subsystem
Geodata management...
Operator's control action
Operator's control action
Non-relational database management system
Non-relational database manage...
sessions
sessions
Операційне сховище
сесій користувачів
Операційне сховище...
ServiceMesh-gateway
(istio-ingressgateway)
ServiceMesh-gateway...
External API gateway
of the registry operational zone (kong-kong)
External API gateway...
Istio Envoy
Istio Envoy
Save user sessions
Save user sessions
User authentication
User authentication
Redirect user traffic
Redirect user traffic
Kong Proxy
Kong Proxy
User traffic
redirectio
User traffic...
Unauthorized
users
Unauthor...
Redirect user traffic
Redirect user traffic
Get configuration
Get configuration
Ingress Controller
Ingress Controller
трафік
трафік
Налаштування
Налаштування
Cross-service communication with mTLS authentication
Cross-service communication w...
User portal subsystem
User portal subsystemText is not SVG - cannot display \ No newline at end of file diff --git a/docs/en/modules/arch/pages/architecture/registry/operational/ext-api-management/overview.adoc b/docs/en/modules/arch/pages/architecture/registry/operational/ext-api-management/overview.adoc index 39e4248bef..6067a9eb14 100644 --- a/docs/en/modules/arch/pages/architecture/registry/operational/ext-api-management/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/registry/operational/ext-api-management/overview.adoc @@ -5,65 +5,47 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] == Overview -//Підсистема, призначенням якої є управління зовнішнім трафіком та контроль доступу до API-сервісів операційної зони Реєстру. The subsystem is designed to manage external traffic and control access to API services of the registry operational zone. == Subsystem functions -//* Аутентифікація та авторизація запитів -// зони реєстру -//* Налаштування та контроль рейт-лімітів -//* Трансформація запитів та відповідей -//* Логування вхідних запитів * Authentication and authorization of requests * Traffic routing to API services of the registry operational zone subsystems * Configuration and control of rate limits * Transformation of requests and responses * Logging of incoming requests -//== Технічний дизайн підсистеми -== Technical design of the subsystem +== Subsystem technical design image::architecture/registry/operational/ext-api-management/registry-ext-traffic-subsystem.drawio.svg[width=600,float="center",align="center"] -//== Складові підсистеми [#subsystem-components] == Subsystem components |=== -//|Назва компоненти|Представлення в реєстрі|Походження|Репозиторій|Призначення |Component name|Presentation in the registry|Origin|Repository|Purpose -//|_Зовнішній API-шлюз операційної зони_ |_Registry operational zone external API gateway_ |`kong-kong` |3rd-party |https://github.com/epam/edp-ddm-kong[github:/epam/edp-ddm-kong] -//|Забезпечує керування трафіком, авторизацію, контроль доступу до API, балансування навантаження, перетворення запитів/відповідей та аналітику/моніторинг. |Provides traffic management, authorization, API access control, load balancing, request/response transformation, and analytics/monitoring. -//|_ServiceMesh шлюз_ |_ServiceMesh gateway_ |`istio-ingressgateway` |3rd-party |https://github.com/istio/proxy[github:/istio/proxy] -//|Мережевий шлюз що працює на межі istio service-mesh та отримує вхідні з'єднання HTTP/TCP. -|Network gateway operating on the edge of the Istio service --mesh, receiving incoming HTTP/TCP connections. +|Network gateway operating on the edge of the Istio service-mesh, receiving incoming HTTP/TCP connections. -//|xref:arch:architecture/registry/operational/ext-api-management/redis-storage.adoc#_sessions[__Операційне сховище сесій користувача__] |xref:arch:architecture/registry/operational/ext-api-management/redis-storage.adoc#_sessions[__Operational user sessions storage__] |`redis:sessions` |3rd-party |- -//|Зберігання користувацьких JWT-токенів |Storage of user JWT tokens |=== -//== Технологічний стек -== Technological stack +== Technology stack -//При проектуванні та розробці підсистеми, були використані наступні технології: The following technologies were used in the design and development of the subsystem: * xref:arch:architecture/platform-technologies.adoc#kong[Kong] @@ -71,26 +53,22 @@ The following technologies were used in the design and development of the subsys * xref:arch:architecture/platform-technologies.adoc#redis[Redis] * xref:arch:architecture/platform-technologies.adoc#istio[Istio ServiceMesh] -//== Атрибути якості підсистеми == Subsystem quality attributes === _Scalability_ -//Підсистема управління зовнішнім трафіком операційної зони реєстру підтримує як горизонтальне, так і вертикальне масштабування. The external traffic management subsystem of the registry operational zone supports both horizontal and vertical scalability. [TIP] -- -//Детальніше з масштабуванням підсистем можна ознайомитись у розділі For more details on subsystem scalability, please refer to xref:architecture/container-platform/container-platform.adoc[] -- === _Observability_ -//Підсистема управління зовнішнім трафіком операційної зони реєстру підтримує журналювання вхідних запитів та збір метрик продуктивності для подальшого аналізу через веб-інтерфейси відповідних підсистем Платформи. + The external traffic management subsystem of the registry operational zone supports logging of incoming requests and collects performance metrics for further analysis through web interfaces of the corresponding Platform subsystems. [TIP] -- -//Детальніше з дизайном підсистем можна ознайомитись у відповідних розділах: For more details on subsystem design, please refer to the relevant sections: * xref:arch:architecture/platform/operational/logging/overview.adoc[] @@ -98,12 +76,11 @@ For more details on subsystem design, please refer to the relevant sections: -- === _Portability_ -//Підсистема управління зовнішнім трафіком операційної зони реєстру може бути перенесена, розгорнута та керована однаково та надійно на різних платформах оркестрації контейнерів що розгорнуті в різних хмарних середовищах або власній інфраструктурі в дата-центрі. + The external traffic management subsystem of the registry operational zone can be easily transported, deployed, and reliably managed across different container orchestration platforms in various cloud environments or in proprietary infrastructure within data centers. [TIP] -- -//Детальніше можна ознайомитись у розділі xref:arch:architecture/container-platform/container-platform.adoc[Платформа оркестрації контейнерів] -For more details, please refer to -xref:arch:architecture/container-platform/container-platform.adoc[Container orchestration platform] --- +For more details, please refer to the +xref:arch:architecture/container-platform/container-platform.adoc[Container orchestration platform]. +-- \ No newline at end of file diff --git a/docs/ua/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc b/docs/ua/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc index c66521b85f..66f3eb4da7 100644 --- a/docs/ua/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc +++ b/docs/ua/modules/admin/pages/backup-restore/backup-schedule-registry-components.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Керування розкладом резервного копіювання реєстру +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис @@ -35,7 +19,6 @@ ==== //// -TODO: Need this section? Перелік компонентів реєстру, для яких налаштовується резервне копіювання за розкладом та час зберігання резервних копій: :: * [*] [.underline]#Портал управління бізнес-процесами реєстру# -- компонент `*bp-admin-portal*`. diff --git a/docs/ua/modules/admin/pages/registry-management/control-plane-create-registry.adoc b/docs/ua/modules/admin/pages/registry-management/control-plane-create-registry.adoc index bbed35a9f9..a0128a1b02 100644 --- a/docs/ua/modules/admin/pages/registry-management/control-plane-create-registry.adoc +++ b/docs/ua/modules/admin/pages/registry-management/control-plane-create-registry.adoc @@ -1,29 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -// Use this to make a text bold: +++Компонент для розробки регламенту+++ -// Use this to make a text bold and code: -//Option 1: `+++Компонент для розробки регламенту+++` -//Option 2: Use this to make a text bold and code: +++Підтвердити+++ -//Option 3: `+++Створити новий+++` - = Розгортання екземпляра реєстру +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Після успішного xref:installation/platform-deployment/platform-deployment-overview.adoc[встановлення Платформи на цільовому оточенні], адміністратор Платформи отримує доступ до адміністративної панелі, що має назву *Control Plane*. Вона дозволяє керувати конфігураціями інфраструктурних компонентів Платформи (`cluster-mgmt`), а також компонентів реєстру. diff --git a/docs/ua/modules/admin/pages/registry-management/control-plane-edit-registry.adoc b/docs/ua/modules/admin/pages/registry-management/control-plane-edit-registry.adoc index 48eb4231e8..9dd4fd33df 100644 --- a/docs/ua/modules/admin/pages/registry-management/control-plane-edit-registry.adoc +++ b/docs/ua/modules/admin/pages/registry-management/control-plane-edit-registry.adoc @@ -45,7 +45,7 @@ image:registry-management/registry-edit/cp-edit-registry-2.png[] . Знайдіть розділ +++Реєстри+++ та відкрийте необхідний. + На цій сторінці ви можете побачити 2 основні вкладки: - ++ [tabs] ==== Інформація про реєстр:: diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/create-users/create-registry-admins.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/create-users/create-registry-admins.adoc index 4e497877a7..ac04465796 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/create-users/create-registry-admins.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/create-users/create-registry-admins.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Створення адміністраторів реєстру +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис @@ -245,18 +229,4 @@ image:admin:user-management/user-management-44.png[] * xref:registry-develop:study-project/index.adoc[] * xref:admin:registry-management/control-plane-assign-platform-admins.adoc[] * xref:admin:registry-management/control-plane-edit-registry.adoc[] -* xref:admin:update/update-registry-components.adoc[] - -//// -KeyCloak:gerrit-administrators - -KeyCloak:camunda-admin - -KeyCloak:redash-admin - -jKeyCloak:jenkins-users (за запитом Адміністратор користувачів може надати jenkins-admin) - -KeyCloak:nexus-user -//// - -<<< \ No newline at end of file +* xref:admin:update/update-registry-components.adoc[] \ No newline at end of file