Skip to content

Commit

Permalink
[EDP-DDM-26074] Gathered navigation for arch platform subsystems, add…
Browse files Browse the repository at this point in the history
…ed platform system requirements to en version, translated two subsystems, added diagrams, added lots of other improvements and fixes

Change-Id: I89785ff359da037be3296a294a95dd5efdcfedfe
  • Loading branch information
[email protected] committed Sep 14, 2023
1 parent 609fb2e commit 8866a66
Show file tree
Hide file tree
Showing 96 changed files with 608 additions and 774 deletions.
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
:toc-title: On this page:
:toc: auto
:toclevels: 5
:experimental:
:sectnums:
:sectnumlevels: 5
:sectanchors:
:sectlinks:
:partnums:

//= Розгортання екземпляра реєстру
= Deploying a registry
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`), а також компонентів реєстру.

Expand Down Expand Up @@ -145,7 +137,7 @@ In this step, you can select a template for your registry. Templates are predefi

//Приблизну вартість обчислювальних ресурсів реєстру ви можете розрахувати на сторінці 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/registry-cost.adoc[] page or reach out to the Platform's technical support team.
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[]

Expand Down Expand Up @@ -324,8 +316,7 @@ TIP: For details, see xref:admin:registry-management/control-plane-cidr-access-e

Click *`Next`* to go to the next step.

//== Автентифікація надавачів послуг
== Service providers authentication
== Officers (service providers) authentication

//На цьому кроці ви можете налаштувати тип автентифікації для надавачів послуг (посадових осіб), а також дозволити, або заборонити можливість автореєстрації.
In this step, you can configure authentication for service providers (officers) and enable or disable self-registration.
Expand Down Expand Up @@ -358,8 +349,9 @@ TIP: For details, see xref:registry-develop:registry-admin/cp-auth-setup/cp-offi

Click *`Next`* to go to the next step.

//== Автентифікація отримувачів послуг
== Service recipients authentication
== Citizens (service recipients) authentication

include::ROOT:partial$admonitions/ua-specific.adoc[]

//TODO: ua-specific, probably irrelevant to non-ua Platform
//На цьому кроці ви можете налаштувати перевірку наявності активного запису в ЄДР для бізнес-користувачів, що дозволяє встановити зв'язок між КЕП користувача та його юридичною особою чи фізичною особою-підприємцем, що зареєстровані в Єдиному державному реєстрі (ЄДР). Це важливий аспект безпеки та надійності системи, який допомагає забезпечити відповідність даних користувача та підтвердження їх особистості.
Expand All @@ -375,7 +367,7 @@ If you do not configure anything here, the system will use the default value: va

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[].
//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.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

//= Автоматичне горизонтальне масштабування екземплярів нод кластера
= Automatic horizontal scaling of cluster node instances
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

= Container orchestration platform
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

Expand Down
12 changes: 5 additions & 7 deletions docs/en/modules/arch/pages/architecture/overview.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

= Architectural documentation
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

== General overview

*The Platform for state registries* is an information system designed to _deliver government services in a digital format efficiently_. It enables the rapid creation, modeling, deployment, and maintenance of electronic state registries.
*_The Platform for state registries_* is an information system designed to _deliver government services in a digital format efficiently_. It enables the rapid creation, modeling, deployment, and maintenance of electronic state registries.

The main objective of this solution is to implement a _decentralized_ and _regulated_ approach to managing state registries. This product aims to balance _data security requirements_, _interoperability_, _deployment speed_, and the _cost_ of registry ownership.

//== Проблематика
== Main purpose

*The Registries Platform* aims to address several problems with the current state of government information registries, which complicate the process of digitizing government services:
*_The Registries Platform_* aims to address several problems with the current state of government information registries, which complicate the process of digitizing government services:

* Many registries, owned by multiple entities, are maintained in _Excel_ with poor data quality.
* Registry information systems are outdated and require updates.
Expand Down Expand Up @@ -112,10 +110,10 @@ The technical documentation package of the Platform includes the following:
//* xref:arch:architecture/platform-deployment.adoc[] - концептуальна діаграма розгортання _Платформи Реєстрів_
* xref:arch:architecture/platform-deployment.adoc[] -- conceptual deployment diagram of _the Platform for state registries_;
//* xref:arch:architecture/platform-quality-attributes.adoc[] - ключові атрибути якості з описом підходів та техник до їх адресування
* xref:arch:architecture/platform-quality-attributes.adoc[] -- key quality attributes with descriptions of approaches and techniques to address them;
* xref:arch:architecture/platform-quality-attributes/overview.adoc[] -- key quality attributes with descriptions of approaches and techniques to address them;
//* xref:arch:architecture/platform-technologies.adoc[] - опис переліку та категорій ключових технологій , які застосовані для побудови рішення _Платформі Реєстрів_
* xref:arch:architecture/platform-technologies.adoc[] -- a description of the key technologies and categories used to build _the Platform for state registries_ solution;
//* _Високорівневий дизайн зон та підсистем Платформи_ - набір розділів з високорівневою архітектурою, описом складових та їх взаємодії, ключових аспектів рішення, тощо.
* _High-level Design of the Platform's zones and subsystems_ -- a set of sections with high-level architecture, component descriptions, interactions, key aspects of the solution, and more;
//* xref:arch:architecture/registry-cost.adoc[] - опис підходу до оцінки вартості володіння реєстрами, які розгорнуті на _Платформі Реєстрів_
* xref:arch:architecture/registry-cost.adoc[] -- a description of the approach to assessing the cost of owning registries deployed on _the Platform for state registries_.
* xref:architecture/platform-system-requirements/registry-cost.adoc[] -- a description of the approach to assessing the cost of owning registries deployed on _the Platform for state registries_.
12 changes: 7 additions & 5 deletions docs/en/modules/arch/pages/architecture/platform-conceptual.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

= Platform conceptual architecture
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

Expand Down Expand Up @@ -38,8 +37,10 @@ The main users of the _Platform for state registries_ can be divided into the fo
* _Citizens_: Natural persons or legal entities who passed authentication and self-registration in the register to have access to electronic services.
//* _Отримувачі послуг_ - фізичні або юридичні особи, які пройшли автентифікацію та самореєстрацію в реєстрі з метою отримання електронних послуг.
* _Officers_: Official representatives of government bodies providing services under their official duties, or the entities registered as service providers (depending on the requirements of an individual register).

//* _Надавачі послуг_ - офіційні представники державних органів, які надають послуги в рамках своїх службових обов'язків або особи, які зареєструвались як надавачі послуг (залежно від вимог окремого реєстру).
* _Developers of the Registry Regulations_: The users responsible for the _Lowcode_ development of the xref:arch:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[digital register regulations]
* _Developers of the Registry Regulations_: The users responsible for the _Lowcode_ development of the xref:arch:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[Digital registry regulations]

//* _Розробники регламенту реєстру_ - користувачі, які відповідають за _Lowcode_-розробку xref:arch:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[цифрового регламенту реєстру]
* _Support Service (L2)_: The users responsible for monitoring of the system's technical metrics, incident response.
//* _Служба підтримки (L2)_ - користувачі, які відповідають за моніторинг технічних метрик системи, реакція на інциденти
Expand Down Expand Up @@ -87,7 +88,8 @@ You can learn more about the design of the integrated subsystems in the relevant
--

=== _Trembita SEI SEIR_
//=== _СЕВДЕІР "Трембіта"_

include::ROOT:partial$admonitions/ua-specific.adoc[]

The _Platform for state registries_ is integrated into the _Trembita System of Electronic Interaction of State Electronic Information Resources (SEI SEIR)_ to ensure secure data exchange with the state registers and other information systems.
//_Платформа Реєстрів_ інтегрована до _Системи Електронної Взаємодії Державних Електронних Інформаційних Ресурсів (СЕВДЕІР) "Трембіта"_ з метою забезпечення захищеного інформаційного обміну даними державних реєстрів та інших інформаційних систем.
Expand All @@ -100,7 +102,7 @@ You can learn more about the design of the integrated subsystems in the relevant
* xref:arch:architecture/platform/operational/user-management/overview.adoc[]
* xref:arch:architecture/registry/operational/bpms/overview.adoc[]
* xref:arch:architecture/registry/operational/external-integrations/overview.adoc[]
* xref:arch:architecture/data-exchange/overview.adoc[]
//* xref:arch:architecture/data-exchange/overview.adoc[]
--

=== _Diia services (diia.gov.ua)_
Expand Down
17 changes: 4 additions & 13 deletions docs/en/modules/arch/pages/architecture/platform-deployment.adoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,28 @@
= Platform deployment diagram
//= Діаграма розгортання Платформи
= Platform deployment architecture
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

== Platform infrastructure deployment diagram
//== Діаграма розгортання Платформної інфраструктури

The Registry Platform installation procedure is the responsibility of the xref:architecture/platform-installer/overview.adoc[Platform resources status management component], which is designed taking into account for compatibility between different infrastructure providers.
//За процедуру інсталяції Платформи реєстрів відповідає xref:architecture/platform-installer/overview.adoc[Компонент керування станом ресурсів Платформи], що розроблений з урахуванням сумісності між різними постачальниками інфраструктури.
The Registries Platform installation procedure is the responsibility of the xref:architecture/platform-installer/overview.adoc[Component for managing the state of Platform resources]. This Component is designed with consideration for compatibility between different infrastructure providers.

The installation procedure of the OpenShift container orchestration Platform is the responsibility of the https://github.com/okd-project/okd/releases[OKD installer] developed and supplied by RedHat.
//За процедуру інсталяції Платформи оркестрації контейнерів OpenShift відповідає https://github.com/okd-project/okd/releases[OKD installer], що розроблен та постачаєтся RedHat.

This diagram shows the deployment of resources in the AWS public cloud.
//Дана діаграма відображає розгортання ресурсів в публічному хмарному середовищі AWS.

[TIP]
--
For more information about the _OpenShift container orchestration Platform_ and the _Registry Platform_, see the relevant sections:
//Детальніше з процедурою встановлення _Платформи оркестрації контейнерів OpenShift_ та _Платформи Реєстрів_ можна ознайомитись у відповідних розділах:

* xref:admin:installation/platform-deployment/platform-deployment-overview.adoc[]
For more details about the technical design of the subsystems and components engaged in the installation process, see the following sections:
//Детальніше з технічним дизайном підсистем та компонент, які задіяні в інсталяції, можна ознайомитись у розділах:

* xref:architecture/platform-installer/overview.adoc[Platform resources status management component]
//* xref:architecture/platform-installer/overview.adoc[Компонент керування станом ресурсів Платформи]
* xref:architecture/container-platform/container-platform.adoc#_portability[Container orchestration platform]
//* xref:architecture/container-platform/container-platform.adoc#_portability[Платформа оркестрації контейнерів]
--
The diagram below depicts the Registries Platform's infrastructure deployment in one region (AZ) of the AWS public cloud environment.

.Platform architecture on AWS
//.Платформна архітектура на AWS
image::architecture/ddm-platform-infrastructure-deployment.drawio.svg[]
13 changes: 8 additions & 5 deletions docs/en/modules/arch/pages/architecture/platform-logical.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
//= Логічна архітектура Платформи
= Platform logical architecture
include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

//== Загальний опис
== Overview

//_Платформа Реєстрів_ представляє собою розподілену систему з мікросервісною архітектурою, в дизайн якої закладено декілька важливих ідей:
The _Registry Platform_ is a distributed system with microservice architecture. Its design is based on the following fundamental ideas:

//* Незалежність від інфраструктури для розгортання
Expand All @@ -20,7 +20,6 @@ The _Registry Platform_ is a distributed system with microservice architecture.
//* Відповідність реєстрів вимогам безпеки, масштабованості та відмовостійкості
* Registry compliance with security, scalability and fault-tolerance requirements

//== Архітектурні принципи
== Architecture principles

//* _Платформа Реєстрів_ побудована з використанням відкритих стандартів на базі технологій з відкритим кодом.
Expand Down Expand Up @@ -57,7 +56,7 @@ A separate system level may contain two zones with subsystems that are responsib
The subsystems are composed of services that address a block of functional and non-functional requirements.


image::architecture/ddm-platform-structural-view.png[]
image::architecture/ddm-platform-structural-view.svg[]

//=== _Інфраструктура_
=== _Infrastructure_
Expand Down Expand Up @@ -108,6 +107,8 @@ You can learn more about the Platform resource state management component here:
* xref:architecture/platform-installer/overview.adoc[]
--

////
//=== _Шлюз безпечного обміну "Трембіта"_
=== _"Trembita" secure exchange gateway_
Expand All @@ -128,6 +129,8 @@ You can learn more about the "Griada" software-hardware cryptomodule here:
* xref:architecture/network-crypto-module/overview.adoc[]
--
////

////
== Технологічний стек
Expand Down
Loading

0 comments on commit 8866a66

Please sign in to comment.