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 d52e86e477..245fa3590e 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 @@ -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`), а також компонентів реєстру. @@ -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[] @@ -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. @@ -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 //На цьому кроці ви можете налаштувати перевірку наявності активного запису в ЄДР для бізнес-користувачів, що дозволяє встановити зв'язок між КЕП користувача та його юридичною особою чи фізичною особою-підприємцем, що зареєстровані в Єдиному державному реєстрі (ЄДР). Це важливий аспект безпеки та надійності системи, який допомагає забезпечити відповідність даних користувача та підтвердження їх особистості. @@ -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. diff --git a/docs/en/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg b/docs/en/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg index 55fe00be9a..556170ab4d 100644 --- a/docs/en/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg +++ b/docs/en/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg @@ -1,4 +1,4 @@ - + -
AWS Cloud
AWS Cloud
AWS Region
AWS Region
Private bastion subnet
Private bastion subnet
OpenShift VPC 10.0.0.0/16
OpenShift VPC 10.0.0.0/16
Public OpenShift
subnet
Public OpenShift...
Route Table
Rout...
Private OpenShift
subnet
Private OpenShift...
3
3
3
3
Route Table
Rou...
3
3
3
3
N
N

Elastic IP
E...
Platform VPC 192.168.100.0/24
Platform VPC 192.168.100.0/24
Public platform subnet
Public platform subnet
KMS
KMS
Platform MinIO
Platform MinIO
Platform Vault
Platform Vault
Route Table
Rou...
Platform
Internet Gateway
Plat...
OpenShift
Internet Gateway
Open...
Unseal
Unseal
External
API NLB
Ext...
External
Router Balancer
Ext...
Internal
API NLB
Int...
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
OpenShift
Master Nodes
OpenShift...
Logging
Worker nodes
Logging...
Platform
Storage Nodes
Platform...
Platform
Nodes
Platform...
Registry
Nodes
Registry...
EBS
EBS
EBS
EBS
Elastic IPs
Elastic IPs
VPC S3
Endpoint
VPC S...
Bastion VPC
Bastion VPC
Public bastion subnet
Public bastion subnet
Route Table
Rou...
Internet
Gateway
Inte...
Route Table
Rou...

Elastic IP
E...
NAT
Gateway
NAT...
Bastion Host
Bastion...
EBS
EBS
3
3
3
3
N
N
3
3
N
N
Simple Storage
Service (S3)
Simple...
AWS Route53
AWS Route53
Програмно-апаратний
криптомодуль "Гряда"
Програмно-апаратний...
ШБО "Трембіта"
ШБО "Трембіта"
Platform
NAT Gateway
Platform...
Text is not SVG - cannot display
\ No newline at end of file +
AWS Cloud
AWS Cloud
AWS Region
AWS Region
Private bastion subnet
Private bastion subnet
OpenShift VPC 10.0.0.0/16
OpenShift VPC 10.0.0.0/16
Public OpenShift
subnet
Public OpenShift...
Route Table
Rout...
Private OpenShift
subnet
Private OpenShift...
3
3
3
3
Route Table
Rou...
3
3
3
3
N
N

Elastic IP
E...
Platform VPC 192.168.100.0/24
Platform VPC 192.168.100.0/24
Public platform subnet
Public platform subnet
KMS
KMS
Platform MinIO
Platform MinIO
Platform Vault
Platform Vault
Route Table
Rou...
Platform
Internet Gateway
Plat...
OpenShift
Internet Gateway
Open...
Unseal
Unseal
External
API NLB
Ext...
External
Router Balancer
Ext...
Internal
API NLB
Int...
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
OpenShift
Master Nodes
OpenShift...
Logging
Worker nodes
Logging...
Platform
Storage Nodes
Platform...
Platform
Nodes
Platform...
Registry
Nodes
Registry...
EBS
EBS
EBS
EBS
Elastic IPs
Elastic IPs
VPC S3
Endpoint
VPC S...
Bastion VPC
Bastion VPC
Public bastion subnet
Public bastion subnet
Route Table
Rou...
Internet
Gateway
Inte...
Route Table
Rou...

Elastic IP
E...
NAT
Gateway
NAT...
Bastion Host
Bastion...
EBS
EBS
3
3
3
3
N
N
3
3
N
N
Simple Storage
Service (S3)
Simple...
AWS Route53
AWS Route53
Software-hardware
cryptomodule
Softwar...
Secure exchange gateway
Secure exchange...
Platform
NAT Gateway
Platform...
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/en/modules/arch/images/architecture/platform/operational/distributed-tracing/distributed-tracing-subsystem.drawio.svg b/docs/en/modules/arch/images/architecture/platform/operational/distributed-tracing/distributed-tracing-subsystem.drawio.svg new file mode 100644 index 0000000000..cc4e92fa15 --- /dev/null +++ b/docs/en/modules/arch/images/architecture/platform/operational/distributed-tracing/distributed-tracing-subsystem.drawio.svg @@ -0,0 +1,4 @@ + + + +
External traffic management subsystem
External traffic management subsystem
System administrators
System a...
Cross-service communication
Cross-service communicati...
Registry subsystem
Registry subsystem
Deploy and configure
Deploy and configure
Deploy and 
configure
Deploy and...
Deploy and configure
Deploy and configure
Jaeger operator
(jaeger-operator)
Jaeger operator...
Save data
Save data
Jaeger collector
(jaeger-collector)
Jaeger collector...
Data access
Data access
Web interface and requests service
(jaeger-query)
Web interface and reque...
Tracing storage
(elasticsearch)
Tracing storage...
Registry subsystems
Registry subsystems
Platform subsystem
Platform subsystem
Target subsystem's component
Target subsystem's component
Request tracing subsystem
Request tracing subsystem
Send
data
Send...
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/en/modules/arch/images/architecture/platform/operational/monitoring/monitoring-subsystem.drawio.svg b/docs/en/modules/arch/images/architecture/platform/operational/monitoring/monitoring-subsystem.drawio.svg new file mode 100644 index 0000000000..e5e566de75 --- /dev/null +++ b/docs/en/modules/arch/images/architecture/platform/operational/monitoring/monitoring-subsystem.drawio.svg @@ -0,0 +1,4 @@ + + + +
Операційна зона Платформи
Операційна зона Платформи
Підсистема моніторингу подій та сповіщення
Підсистема моніторингу подій та сповіщення
Збір
метрик
Збір...
Служба моніторингу k8s обʼєктів
(kube-state-metrics)
Служба моніторингу k8s обʼєктів...
Збір
метрик
Збір...
Компонент інтеграції метрик з механізмами масштабування OKD 
(prometheus-adapter)
Компонент інтеграції метрик з механізмами масштабування OKD...
Запит
метрик
Запит...
Збір
метрик
Збір...
Служба моніторингу openshift обʼєктів
(openshift-state metrics)
Служба моніторингу openshift обʼєктів...
Збір
метрик
Збір...

(node-exporter)
(node-exporter)...

(node-exporter)
(node-exporter)...
Екпортери метрик віртуальних машин
(node-exporter)
Екпортери метрик віртуальних машин...
Збір
метрик
Збір...
Сервіс сповіщень 
(alertmanager-main)
Сервіс сповіщень...
Відправка
сповіщень
Відправка...
Веб-інтерфейс моніторингу Платформи 
(grafana)
Веб-інтерфейс моніторингу Платформи...
Підключення до
джерела даних
Підключення до...
Запит
метрик
Запит метрик
Сервіс виконання запитів до
Prometheus
(thanos-querier)
Сервіс виконання запитів доPrometheus...
Розширення для рендерінгу зображень
(grafana-image-renderer)
Розширення для рендерінгу зображень...
Рендерінг
PNG зображень
Рендерінг...
Доступ до
інформаційних панелей
Доступ до...
Доступ до
веб-інтерфейсу
Доступ до...
Доступ до
веб-інтерфейсу
Доступ до...
Підсистема управління
зовнішнім трафіком
Платформи
Підсистема управління...
Підсистема управління
Платформою та реєстрами
Підсистема управлінняПлатформою та реєстрами
Службові
адміністратори
Службові...
Підсистеми
реєстру
Підсистеми...
Підсистеми
Платформи
Підсистеми...
Збір метрик
Збір метрик
Сповіщення
адміністраторів
Сповіщення...
Сповіщення
адміністраторів
Сповіщення...
Сповіщення
адміністраторів
Сповіщення...
Зовнішні канали сповіщення
(telegram, teams тощо)
Зовнішні канали сповіщення...
Веб-інтерфейс управління кластером OpenShift
Веб-інтерфейс управління кластером OpenShift
Доступ до
інформаційних панелей
Доступ до...
Сповіщення
адміністраторів
Сповіщення...
Сервіс моніторингу 
(prometheus-k8s)
Сервіс моніторингу...
Оператор 
Prometheus  
(prometheus-
operator)
Оператор...
Розгортання та налаштування
компонентів підсистеми 
моніторинга та сповіщень 
Розгортання та налаштування...
Openshift оператор моніторингу 
(cluster-monitoring-operator)
Openshift оператор моніторингу...
Служба валідації конфігурації ресурсів
(prometheus-operator-admission-webhook)
Служба валідації конфігурації ресурсів...
Платформа оркестрації контейнерів 
Платформа оркестрації контейнерів 
Виставлення перетворених метрик
через Kubernetes Metrics API
Виставлення перетворених метрик...
Керування та налаштування
компонентами моніторингу
Керування та налаштування...
Перевірка та модифікація 
yaml конфігурації підсистеми моніторинга
Перевірка та модифікація...
Міжсервісна взаємодія
Міжсервісна взаємодія
Підсистема Платформи
Підсистема Платформи
Компонент
цільової підсистеми
Компонент...
Підсистеми реєстру
Підсистеми реєстру
Зовнішні системи
Зовнішні системи
Доступ до
веб-інтерфейсу
Доступ до...
Сповіщення
Сповіщення
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/en/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc b/docs/en/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc index c048abf65c..d05f2ec919 100644 --- a/docs/en/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc +++ b/docs/en/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc @@ -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[] diff --git a/docs/en/modules/arch/pages/architecture/container-platform/container-platform.adoc b/docs/en/modules/arch/pages/architecture/container-platform/container-platform.adoc index c206389447..3a9b658e30 100644 --- a/docs/en/modules/arch/pages/architecture/container-platform/container-platform.adoc +++ b/docs/en/modules/arch/pages/architecture/container-platform/container-platform.adoc @@ -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[] diff --git a/docs/en/modules/arch/pages/architecture/overview.adoc b/docs/en/modules/arch/pages/architecture/overview.adoc index b6732a7c8f..c22f5d42c7 100644 --- a/docs/en/modules/arch/pages/architecture/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/overview.adoc @@ -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. @@ -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_. \ No newline at end of file +* 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_. \ No newline at end of file diff --git a/docs/en/modules/arch/pages/architecture/platform-conceptual.adoc b/docs/en/modules/arch/pages/architecture/platform-conceptual.adoc index 3a3e28dc80..97fa2fee70 100644 --- a/docs/en/modules/arch/pages/architecture/platform-conceptual.adoc +++ b/docs/en/modules/arch/pages/architecture/platform-conceptual.adoc @@ -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[] @@ -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)_ - користувачі, які відповідають за моніторинг технічних метрик системи, реакція на інциденти @@ -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. //_Платформа Реєстрів_ інтегрована до _Системи Електронної Взаємодії Державних Електронних Інформаційних Ресурсів (СЕВДЕІР) "Трембіта"_ з метою забезпечення захищеного інформаційного обміну даними державних реєстрів та інших інформаційних систем. @@ -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)_ diff --git a/docs/en/modules/arch/pages/architecture/platform-deployment.adoc b/docs/en/modules/arch/pages/architecture/platform-deployment.adoc index d52935c119..ecd7c583ba 100644 --- a/docs/en/modules/arch/pages/architecture/platform-deployment.adoc +++ b/docs/en/modules/arch/pages/architecture/platform-deployment.adoc @@ -1,30 +1,19 @@ -= 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[Компонент керування станом ресурсів Платформи] @@ -32,6 +21,8 @@ For more details about the technical design of the subsystems and components eng //* 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[] diff --git a/docs/en/modules/arch/pages/architecture/platform-logical.adoc b/docs/en/modules/arch/pages/architecture/platform-logical.adoc index 872c0cf643..92ff230c3b 100644 --- a/docs/en/modules/arch/pages/architecture/platform-logical.adoc +++ b/docs/en/modules/arch/pages/architecture/platform-logical.adoc @@ -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: //* Незалежність від інфраструктури для розгортання @@ -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 //* _Платформа Реєстрів_ побудована з використанням відкритих стандартів на базі технологій з відкритим кодом. @@ -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_ @@ -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_ @@ -128,6 +129,8 @@ You can learn more about the "Griada" software-hardware cryptomodule here: * xref:architecture/network-crypto-module/overview.adoc[] -- +//// + //// == Технологічний стек diff --git a/docs/en/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc b/docs/en/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc index 92c13a1e9a..1a69bb6e8b 100644 --- a/docs/en/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc @@ -1,16 +1,15 @@ = Platform quality attributes -include::ROOT:partial$templates/document-attributes/default-set-en.adoc[] +include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] - == General description //В даному розділі задокументовані нефункціональні вимоги, яким має відповідати _Платформи Реєстрів_. -This section shows the non-functional requirements that the _Registry Platform_ must fulfil. +This section shows the non-functional requirements that the _Registries Platform_ must fulfil. //Для кожного атрибута якості наведено загальний опис підходу, яким чином він адресований в архітектурі рішення, ключові метрики та надано посилання на технічний дизайн відповідних підсистем та розділів з детальним описом. -For each quality attribute the following information is provided: overview of approach, implementation in solution architecture, key metrics. Additionally, links to the technical design of the corresponding subsystems, and sections with detailed descriptions are provided. +For each quality attribute, the following information is provided: overview of approach, implementation in solution architecture, key metrics. Additionally, links to the technical design of the corresponding subsystems, and sections with detailed descriptions are provided. //При визначенні цільових значень для метрик, враховується класифікація реєстрів та умови їх експлуатації. Registry classification and operation conditions are taken into account when defining target values for metrics. @@ -75,13 +74,13 @@ We differentiate the following Registry operation conditions: |xref:arch:architecture/platform-quality-attributes/platform-observability.adoc[Observability]|This quality attribute defines the capability of a system to record and provide detailed information in the form of event logs, monitoring metrics, and user transaction tracing data, in order to simplify problem identification and solving by system administrators. |xref:arch:architecture/platform-quality-attributes/platform-auditability.adoc[Auditability]|This quality attribute defines the capability of a system to record and provide information on important technical and business events, connected with system operation by end users. The provided information may be used to detect and solve problems in system functionality. |xref:arch:architecture/platform-quality-attributes/platform-interoperability.adoc[Interoperability]|This quality attribute defines the capability of a system to effectively interact with other systems for data exchange. +|xref:arch:architecture/platform-quality-attributes/platform-operability.adoc[Operability]|The quality attribute defines the presence and level of capabilities for servicing and managing system settings during operation. +|xref:arch:architecture/platform-quality-attributes/platform-modifiability.adoc[Modifiability]|The quality attribute determines the level of complexity and speed of making changes to the system to expand functionalities and correct defects. +|xref:arch:architecture/platform-quality-attributes/platform-verifiability.adoc[Verifiability]|The quality attribute determines the level of complexity for testing and debugging the system when changes are introduced. +|=== // |Reliability|... -// |Operability|... // |Maintainability|... // |Supportability|... -// |Modifiability|... // |Accessibility|... -// |Usability|... - -|=== \ No newline at end of file +// |Usability|... \ No newline at end of file diff --git a/docs/en/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc b/docs/en/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc index c5c02cd48c..3c06d4ada9 100644 --- a/docs/en/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc +++ b/docs/en/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc @@ -18,17 +18,10 @@ The _Registry Platform_ preformance requirements are represented by two key metr [TIP] -- -//Детальніше з результатами тестування продуктивності можна ознайомитись у відповідних розділах: -You can find detailed information on performance testing in the corresponding sections: - - -//// -* xref:testing:performance-testing/perf-report/1-9-5/perf-test-1-9-5-1500-1.adoc[Тестування продуктивності Платформи 1.9.5 при навантаженні 1500 користувачів на 1 годину] -* xref:testing:performance-testing/perf-report/1-9-5/perf-test-1-9-5-1500-8.adoc[Тестування продуктивності Платформи 1.9.5 при навантаженні 1500 користувачів на 8 годин] -//// -* xref:testing:performance-testing/perf-report/1-9-5/perf-test-1-9-5-1500-1.adoc[Platform version 1.9.5 testing with 1500 users for 1 hour workload] -* xref:testing:performance-testing/perf-report/1-9-5/perf-test-1-9-5-1500-8.adoc[Platform version 1.9.5 testing with 1500 users for 8 hours workload] +You can read more on performance testing in xref:testing:performance-testing/performance-testing.adoc[] section. +//* xref:testing:performance-testing/perf-report/1-9-5/perf-test-1-9-5-1500-1.adoc[Platform version 1.9.5 testing with 1500 users for 1-hour workload] +//* xref:testing:performance-testing/perf-report/1-9-5/perf-test-1-9-5-1500-8.adoc[Platform version 1.9.5 testing with 1500 users for 8-hour workload] -- //== Цільові метрики diff --git a/docs/en/modules/arch/pages/architecture/platform-system-requirements/overview.adoc b/docs/en/modules/arch/pages/architecture/platform-system-requirements/overview.adoc new file mode 100644 index 0000000000..e590eb3b48 --- /dev/null +++ b/docs/en/modules/arch/pages/architecture/platform-system-requirements/overview.adoc @@ -0,0 +1,7 @@ += Platform system requirements + +== Overview + +This section contains the documented system requirements for the _Registries Platform_: + +* xref:arch:architecture/platform-system-requirements/registry-cost.adoc[Calculating registry cost] -- description of the approach to evaluating the ownership cost for registries deployed on the _Platform_. \ No newline at end of file diff --git a/docs/en/modules/arch/pages/architecture/registry-cost.adoc b/docs/en/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc similarity index 99% rename from docs/en/modules/arch/pages/architecture/registry-cost.adoc rename to docs/en/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc index 97233796d7..aeb088ea0d 100644 --- a/docs/en/modules/arch/pages/architecture/registry-cost.adoc +++ b/docs/en/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Calculating the registry cost +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc index 57fc28c425..07d5ae7639 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc @@ -1,6 +1,5 @@ -include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Configuring custom DNS name for registry portals in OpenShift 4.x +include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/dev-prod-deployment-mode.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/dev-prod-deployment-mode.adoc index c2477aeda0..3b11c7b729 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/dev-prod-deployment-mode.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/dev-prod-deployment-mode.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Deploying the Platform to production without registry development tools +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/gitops-administrators.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/gitops-administrators.adoc index 3495638208..c4dce5f8c9 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/gitops-administrators.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/gitops-administrators.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Setting up Platform and registry administrators +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/overview.adoc index 567b8016ec..92f0403cf4 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/overview.adoc @@ -5,7 +5,7 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] == Overview -The _Subsystem for deploying and configuring the Platform and registries_ is a collection of tools and processes +The *_Subsystem for deploying and configuring the Platform and registries_* is a collection of tools and processes that enable the Platform and Registries to function smoothly and continuously, tailored to the needs of its users. diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/registry-platform-keys.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/registry-platform-keys.adoc index 9bf394e970..5a3a02427b 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/registry-platform-keys.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/registry-platform-keys.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Updating Platform and registry keys and digital signature service configuration +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc index 7fe9ca87ac..9484206fd2 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc @@ -1,6 +1,5 @@ -include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Secure resource publishing in OpenShift 4.x cluster +include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/platform-configuration-structure.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/platform-configuration-structure.adoc index b27d9fca9e..4a227d1a5c 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/platform-configuration-structure.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/platform-configuration-structure.adoc @@ -1,4 +1,3 @@ -//= Структура конфігурації Платформи = Platform configuration structure include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/registry-configuration-structure.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/registry-configuration-structure.adoc index aa616d5178..e9bfc422b6 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/registry-configuration-structure.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/configuration-structure/registry-configuration-structure.adoc @@ -1,4 +1,3 @@ -//= Структура конфігурації Реєстру = Registry configuration structure include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] @@ -6,8 +5,6 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] include::common/description.adoc[] -[caption=] -//.Налаштування реєстру .Registry configuration |=== //|Рівень налаштувань|Репозиторій|Шлях|Призначення diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/overview.adoc index 26bc61bb4d..39473465b9 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/overview.adoc @@ -5,7 +5,7 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] == General description -_Platform and Registries management subsystem_ provides simplified management of the central components of the Platform, registries and +The *_Platform and registries management subsystem_* provides simplified management of the central components of the Platform, registries and _OpenShift_ resources. It allows you to create and configure registries, as well as aggregates links to all available in the _WEB API_ Platform and is a single point start of work with the _Platform of registers_. diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc similarity index 98% rename from docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc rename to docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc index 2ab66621d0..ca1f411578 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc @@ -863,7 +863,7 @@ Every component accessing Vault must use a dedicated OpenShift service account. //Перейти до використання змінної оточення "_trembita.registries.edr-registry.auth.secret.token_", яка була створена на базі xref:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc#_застосування_змін_до_secret_ресурсів_kubernetes_оператором_external_secrets_operator["trembita-registries-secrets"-секрету] , для отримання авторизаційного токену у типових розширеннях: //TODO: Change link to en version -We need to switch to using the environment variable _trembita.registries.edr-registry.auth.secret.token_, which is based on the xref:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc#_застосування_змін_до_secret_ресурсів_kubernetes_оператором_external_secrets_operator["trembita-registries-secrets" secret], to receive the authorization token in these typical extensions: +We need to switch to using the environment variable _trembita.registries.edr-registry.auth.secret.token_, which is based on the xref:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc#_застосування_змін_до_secret_ресурсів_kubernetes_оператором_external_secrets_operator["trembita-registries-secrets" secret], to receive the authorization token in these typical extensions: * _com.epam.digital.data.platform.bpms.extension.delegate.connector.registry.edr.SearchSubjectsEdrRegistryConnectorDelegate_ * _com.epam.digital.data.platform.bpms.extension.delegate.connector.registry.edr.SubjectDetailEdrRegistryConnectorDelegate_ @@ -874,7 +874,7 @@ We need to switch to using the environment variable _trembita.registries.edr-reg //Для вказаної на рівні REST-конектора назви зовнішньої системи, необхідно визначити тип авторизації зі змінної оточення "_external-systems..auth-type_", який було налаштовано адміністратором реєстру (_"NO_AUTH" | "BASIC" | "BEARER" | "AUTH_TOKEN+BEARER"_), та в залежності від типу отримати необхідні дані для проведення авторизації запиту з xref:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc#_застосування_змін_до_secret_ресурсів_kubernetes_оператором_external_secrets_operator["external-systems-secrets"-секрету]: //TODO: Change link to en version -For an external system defined at the REST connector level, authorization type is identified by the environment variable _external-systems..auth-type_ set by the registry administrator (_"NO_AUTH" | "BASIC" | "BEARER" | "AUTH_TOKEN+BEARER"_). Depending on the type, the credentials required to authorize the request are obtained from the xref:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc#_застосування_змін_до_secret_ресурсів_kubernetes_оператором_external_secrets_operator["external-systems-secrets" secret]: +For an external system defined at the REST connector level, authorization type is identified by the environment variable _external-systems..auth-type_ set by the registry administrator (_"NO_AUTH" | "BASIC" | "BEARER" | "AUTH_TOKEN+BEARER"_). Depending on the type, the credentials required to authorize the request are obtained from the xref:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc#_застосування_змін_до_secret_ресурсів_kubernetes_оператором_external_secrets_operator["external-systems-secrets" secret]: * _com.epam.digital.data.platform.bpms.extension.delegate.connector.rest.ExternalSystemConnectorDelegate_ @@ -945,7 +945,7 @@ a| //|Компрометація облікових даних зовнішніх інтеграцій через невірне налаштування системи обробки помилок. При використанні секретів опеншифту, їх монтування в цільовий сервіс як змінна середовища може привести до їх розкриття якщо ПЗ надає інформацію про все операційне середовище при виникненні помилки. |Compromise of external integrations account data due to incorrect configuration of the error-handling system. Mounting OpenShift secrets onto the target service as an environment variable may lead to their reveal if software returns all information about operating environment when an error occurs. -a| +a| //- Монтувати секрети до цільових сервісів як файли. //- Налаштувати механізм загальної обробки помилок * Mount secrets for target services as files. @@ -955,7 +955,7 @@ a| //|Компрометація данних у Vault через токен доступу оператора секретів. Оператор зовнішніх секретів створює свої кастомні ресурси в яких можуть зберігатись облікові дані доступу до сховища. |Vault data compromise through the secret operator's access token. External Secrets Operator creates its own custom resources which may contain account information with access to Vault. -a| +a| //- Створити окремого сервісного користувача для інтеграції з оператором зовнішніх секретів відповідаючи принципу найменьших привілеїв //- Налаштувати RBAC для доступу до CRD оператора зовнішніх секретів * Create a dedicated service account to integrate with External Secrets Operator using the principle of least privilege. @@ -965,7 +965,7 @@ a| //|Відмова від авторства. Відсутність аудит логу і інформації про доступ до секретів у Vault. |Lack of accountability. Absence of an audit log and information about accessing the Vault secrets. -a| +a| //- Налаштувати систему логування та аудиту для Vault Set up the logging and audit system for Vault. |Not considered in the initial design @@ -973,7 +973,7 @@ Set up the logging and audit system for Vault. //|Ризик бекдору у компоненті external secrets operator |Backdoor risk in the External Secrets Operator component. -a| +a| //- Заборонити на рівні мережевих політик будь яке спілкування сервісу external secrets operator з зовнішніми ресурсами і дозволити комунікацію з сервісами задіяними згідно бізнес логіки. Prohibit any communications between External Secrets Operator and external resources at the network policies level and allow communication with services involved according to business logic. |Not considered in the initial design @@ -986,7 +986,7 @@ a| * Unauthorized data access in the data center. * Incorrect decommissioning of data center components. * Unauthorized access to backups. -a| +a| //- Налаштувати шифрування для розділів які використовуються Vault-ом Set up encryption for partitions that use Vault. |Not considered in the initial design @@ -994,7 +994,7 @@ Set up encryption for partitions that use Vault. //|Ризик ухилення від виявлення та закріплення в системі за відсутності ротації секретів |Risk of detection evasion and anchoring in the system due to the absence of secrets rotation. -a| +a| //- Налаштувати систему\процес ротації секретів Set up the system/process of secrets rotation. |Not considered in the initial design diff --git a/docs/en/modules/arch/pages/architecture/platform/administrative/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/administrative/overview.adoc index 91d717b168..742e609ff4 100644 --- a/docs/en/modules/arch/pages/architecture/platform/administrative/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/administrative/overview.adoc @@ -1,12 +1,11 @@ -include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] - = Platform administrative zone +include::ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::ROOT:partial$admonitions/language-en.adoc[] == General description -The _Platform administrative zone_ comprises subsystems +The *_Platform administrative zone_* comprises subsystems that manage the state and settings of the Platform instance and its deployed registries. We utilize the _**GitOps** approach_ to handle updates. This method automatically applies modifications to the appropriate version control repositories. diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc index 369b9a7ac1..3d94eca828 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc @@ -1,14 +1,13 @@ -//= Підсистема резервного копіювання та відновлення = Backup and restore subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == Overview //Підсистема, що забезпечує безпечне резервне копіювання та відновлення реєстрових та центральних компонентів Платформи, виконання аварійного відновлення Реєстру. Subsystem that provides safe backup copy and restore operations for Registry and central Platform components, and performs Registry disaster recovery. - -//== Функції підсистеми == Subsystem functions //* Безпечне резервне копіювання та відновлення центральних і реєстрових компонентів Платформи реєстрів @@ -22,7 +21,6 @@ Subsystem that provides safe backup copy and restore operations for Registry and //* Міграція ресурсів реєстру на інший екземпляр Платформи реєстрів * Registry resources migration to another Registry Platform instance -//== Технічний дизайн підсистеми == Subsystem technical design //На даній діаграмі зображено компоненти, які входять в _Підсистему резервного копіювання та відновлення_ та їх взаємодію з іншими підсистемами. @@ -30,7 +28,6 @@ The following diagram displays the components that are included in _Backup and r image::architecture/platform/operational/backup-recovery/backup-subsystem.drawio1.svg[width=800,float="center",align="center"] -//== Складові підсистеми == Subsystem components diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc index a69afea3ab..61f4c7a8a5 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc @@ -1,13 +1,13 @@ -//= Підсистема розподіленого зберігання даних = Distributed data storage subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == Overview //Підсистема, що забезпечує функціонування об’єктного (S3 сумісного), блочного та файлового сховища в Платформі. Subsystem that provides the functionality of object (S3-compatible), block, and file storage in the Platform. -//== Функції підсистеми == Subsystem functions //* Підтримка функціонування обʼєктного, файлового та блочного сховища @@ -17,15 +17,13 @@ Subsystem that provides the functionality of object (S3-compatible), block, and //* Масштабування та аварійне відновлення обʼєктного, файлового та блочного сховища * Scaling and disaster recovery of the object, block, and file storage -//== Технічний дизайн підсистеми == Subsystem technical design //На даній діаграмі зображено компоненти, які входять в _Підсистему розподіленого зберігання даних_ та їх взаємодію з іншими підсистемами. The following diagram displays the components that comprise _Data storage subsystem_, and their interaction with other subsystems. -image::architecture/platform/operational/distributed-data-storage/distributed-data-storage.drawio.png[width=800,float="center",align="center"] +image::architecture/platform/operational/distributed-data-storage/distributed-data-storage.drawio.svg[width=800,float="center",align="center"] -//TIP: Для більш детальної інформації про компоненти _ceph_ та _rook_ зверніться до офіціальної документації TIP: You can find more detailed information on _ceph_ and _rook_ components in https://docs.ceph.com/en/quincy/architecture/[ceph architecture] and https://rook.io/docs/rook/v1.10/Getting-Started/storage-architecture/[rook architecture] documentation. @@ -230,52 +228,6 @@ https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/rep |Component that gathers and aggregates information on crashes in Ceph. |=== - -//== Класифікація даних, що зберігаються в об'єктному сховищі -== Object storage data classification -//// - - -|=== -|Бакет|Підсистема власник|Опис - -|xref:arch:architecture/registry/operational/bpms/ceph-storage.adoc#_lowcode_file_storage[lowcode-file-storage] -|xref:arch:architecture/registry/operational/bpms/overview.adoc[Підсистема виконання бізнес-процесів] -|Тимчасове зберігання цифрових документів, завантажених в рамках виконання БП - -|xref:arch:architecture/registry/operational/registry-management/ceph-storage.adoc#_datafactory_ceph_bucket[datafactory-ceph-bucket] -.3+|xref:arch:architecture/registry/operational/registry-management/overview.adoc[Підсистема управління даними реєстру] -|Зберігання підписаних даних при внесенні в реєстр - -|xref:arch:architecture/registry/operational/registry-management/ceph-storage.adoc#_file_ceph_bucket[file-ceph-bucket] -|Зберігання цифрових документів реєстру - -|xref:arch:architecture/registry/operational/registry-management/ceph-storage.adoc#_response_ceph_bucket[response-ceph-bucket] -|Тимчасове зберігання даних для передачі в рамках міжсервісної взаємодії - -|xref:arch:architecture/registry/operational/excerpts/ceph-storage.adoc#_file_excerpt_bucket[file-excerpt-bucket] -.3+|xref:arch:architecture/registry/operational/excerpts/overview.adoc[Підсистема формування витягів реєстру] -|Зберігання згенерованих та підписаних витягів з реєстру - -|xref:arch:architecture/registry/operational/excerpts/ceph-storage.adoc#_excerpt_signature_bucket_deprecated[excerpt-signature-bucket (deprecated)] -|Зберігання підписаних витягів з реєстру - -|xref:arch:architecture/registry/operational/excerpts/ceph-storage.adoc#_excerpt_templates[excerpt-templates] -|Зберігання шаблонів витягів - -|xref:arch:architecture/registry/administrative/regulation-management/ceph-storage.adoc#_user_import[user-import] -.2+|xref:arch:architecture/registry/administrative/regulation-management/overview.adoc[Підсистема моделювання регламенту реєстру] -|Зберігання файлів з переліком посадових осіб для імпорту в реєстр - -|xref:arch:architecture/registry/administrative/regulation-management/ceph-storage.adoc#_user_import_archive[user-import-archive] -|Зберігання файлів з переліком посадових осіб, які було імпортовано в реєстр - -|=== -//// - - -|=== - == Object storage data classification |=== @@ -315,7 +267,6 @@ https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/rep |=== -//== Технологічний стек == Technology stack * xref:arch:architecture/platform-technologies.adoc#ceph[Ceph] @@ -327,7 +278,7 @@ https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/rep === _Scalability_ //Підсистема розподіленого зберігання даних розроблена для горизонтального масштабування на сотні або навіть тисячі вузлів зберігання даних, забезпечуючи при цьому величезні обсяги зберігання даних. Підсистема має динамічну здатність масштабування що дозволяє кластерам зростати або зменшуватися за потреби. -Distributed data storage subsystem was designed for horizontal scaling to hundreds or even thousands of data storing nodes, providing data storage on extensive scale. The subsystem has dynamic scaling capabilities, which allows the clusters to scale up or down on demand. +Distributed data storage subsystem was designed for horizontal scaling to hundreds or even thousands of data storing nodes, providing data storage on an extensive scale. The subsystem has dynamic scaling capabilities, which allows the clusters to scale up or down on demand. === _Reliability_ diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc new file mode 100644 index 0000000000..b58339edf2 --- /dev/null +++ b/docs/en/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc @@ -0,0 +1,94 @@ += Request tracing subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] + +== Overview + +_The Request Tracing Subsystem_ assists administrators and registry developers in tracking, profiling, and debugging in microservice-oriented distributed systems like the Registry Platform. It provides the ability to trace requests as they navigate through a complex architecture, allowing administrators and developers to understand how different Platform services interact and where there might be performance issues. + +_The Request Tracing Subsystem_ comprises several components: agents, collectors, a storage repository for traces, and a query service. Agents collect data from microservices and forward it to the collectors. Collectors store and index this data, and the query service facilitates the searching and visualization of this data in a user-friendly manner. + +The subsystem allows for tracking individual requests across multiple Platform services and viewing detailed information about each request, such as response time, error rate, and service dependencies. This information can be utilized to identify performance bottlenecks, optimize service communication, and enhance the overall system reliability. + +== Subsystem Features + +* Visualization and analysis of tracing data, enabling developers to identify problems and optimize their systems quickly. +* Display of request chain and individual request execution times. +* The subsystem provides detailed metrics for tracing data, such as the number of collected spans, the number of discrete traces, and the number of errors encountered. +* Searching request chains based on request identifiers (`trace_id`). +* The subsystem features a user-friendly web interface for the visualization and analysis of tracing data, facilitating quick problem identification within the Platform. + +[NOTE] +==== +A span represents a segment of code that measures the execution time of an operation and gathers information about it, such as an identifier, the start and end time of the operation, and tags that describe the operation's context. + +A trace is a sequence of spans that form a request structure. Each span has a unique identifier, thus allowing for the assembly of a tree of spans, displaying the sequence of operations and their dependencies during the request execution. +==== + +== Technical Design + +This diagram depicts the subsystem's technical design. + +image::architecture/platform/operational/distributed-tracing/distributed-tracing-subsystem.drawio.svg[width=600,float="center",align="center"] + +== Subsystem сomponents + +|=== +|Component Name|Namespace|Deployment|Origin|Repository|Purpose + +|_Jaeger Operator_ +|`istio-system` +|`jaeger-operator` +|3rd-party +.3+|https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/infrastructure/service-mesh[gerrit:/mdtu-ddm/infrastructure/service-mesh] +|Auxiliary software that performs deployment, configuration, and recovery functions of Jaeger as a subsystem component. + +|_Jaeger Collector_ +|`istio-system` +|`jaeger-collector` +|3rd-party +|Component designed for the collection, processing, and filtering of tracing data from various sources. It aggregates the data and ensures reliable storage in the required format for further analysis and visualization. + +|_Query Service and Web Interface_ +|`istio-system` +|`jaeger-query` +|3rd-party +|Component provides a web interface for searching and filtering traces and their visualization and analysis. + +|_Elasticsearch Storage_ +|`istio-system` +|`elasticsearch` +|3rd-party +|Component for storing and indexing traces collected by the collector. + +|=== + +== Technology stack + +The following technologies were used during the design and development of the subsystem: + +* xref:arch:architecture/platform-technologies.adoc#jaeger[Jaeger] +* xref:arch:architecture/platform-technologies.adoc#elasticsearch[ElasticSearch] +* xref:arch:architecture/platform-technologies.adoc#jaeger-operator[Jaeger Operator] + +== Subsystem quality attributes + +=== _Observability_ +The _Request tracing subsystem_ provides a comprehensive overview of the Platform's behavior, allowing administrators and developers to monitor performance, detect anomalies, and identify potential operational issues. + +=== _Performance_ +The _Request tracing subsystem_ offers unobtrusive instrumentation support for tracing and efficient data storage and indexing. This functionality enables high-performance monitoring of requests within the Platform without expending excessive computational resources. + +=== _Scalability_ +The _Request tracing subsystem_ is designed considering large volumes of tracing data, supporting horizontal scalability and distributed data storage. + +=== _Security_ + +An additional proxy component protects the user interface. In conjunction with the centralized xref:architecture/platform/operational/user-management/overview.adoc[Users and roles management subsystem], it is responsible for granting access and segregating rights. By default, users are granted minimal rights necessary to accomplish their tasks. + +A mechanism is present to restrict access to the interface, which minimizes the subsystem's attack surface from the outside. + +All events within the subsystem are logged and available for further analysis when needed by the xref:arch:architecture/platform/operational/logging/overview.adoc[Event logging subsystem]. + +The subsystem does not have access to sensitive data and does not store it. diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/external-traffic-management/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/external-traffic-management/overview.adoc index 771f2fbe7d..de54ee4606 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/external-traffic-management/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/external-traffic-management/overview.adoc @@ -1,7 +1,8 @@ -//= Підсистема управління зовнішнім трафіком = External traffic management subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис підсистеми == Overview //Підсистема представлена інтегрованою в _OpenShift_ платформу програмною компонентою _OpenShift Router_, яка використовує _HAProxy_ у якості зворотного проксі-сервера / балансувальника та забезпечує надійну та захищену взаємодію зовнішніх клієнтів з сервісами Платформи. diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc index e201d59c3c..0277167bb6 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc @@ -1,13 +1,13 @@ -//= Підсистема поштових повідомлень = Email messaging subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == Overview //Підсистема, призначенням якої є обслуговування поштових скриньок реєстрів, аналіз поштових повідомлень на спам та віруси та відправлення поштових повідомлень користувачам. Subsystem, designed for Registry mailbox service, antivirus/antispam email analysis and sending emails to the users. -//== Функції підсистеми == Subsystem functions //* Адміністрування поштових служб екземпляра _Платформи Реєстрів_ @@ -21,18 +21,14 @@ Subsystem, designed for Registry mailbox service, antivirus/antispam email analy //* Аналіз поштових повідомлень на наявність троянів, вірусів, тощо. * Email analysis for trojans, viruses, etc. -//== Технічний дизайн підсистеми == Subsystem technical design -//На даній діаграмі зображено компоненти, які входять в _Підсистему поштових повідомлень_ та їх взаємодію з іншими підсистемами в рамках реалізації функціональних сценаріїв. The following diagram displays the components that are included in _Email messaging subsystem_, and their interaction with other subsystems within functional scenarios realization. image::arch:architecture/platform/operational/mail-delivery/mail-subsystem-design.drawio.svg[float="center",align="center"] -//== Складові підсистеми == Subsystem components - //// |=== |Назва компоненти|Namespace|Deployment|Походження|Репозиторій|Призначення @@ -89,7 +85,6 @@ image::arch:architecture/platform/operational/mail-delivery/mail-subsystem-desig //// - |=== |Component name|Namespace|Deployment|Source|Repository|Function @@ -143,7 +138,6 @@ image::arch:architecture/platform/operational/mail-delivery/mail-subsystem-desig |Distributed key-value pairs storage for antispam filter data storing. |=== -//== Технологічний стек == Technology stack The following technologies were used in system design and development: @@ -157,7 +151,6 @@ The following technologies were used in system design and development: * xref:arch:architecture/platform-technologies.adoc#nginx[Nginx] * xref:arch:architecture/platform-technologies.adoc#redis[Redis] -//== Атрибути якості підсистеми == Subsystem quality attributes === _Security_ diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc index 15db2f394f..30af6aaad6 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc @@ -1,265 +1,265 @@ -= Підсистема моніторингу подій та сповіщення += Event monitoring and notification subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] -== Загальний опис +include::platform:ROOT:partial$admonitions/language-en.adoc[] -Підсистема, що забезпечує збирання моніторингових даних додатків та інфраструктури, зберігає інформацію як часовий ряд -(`time series)`, надає можливість побудови пошукових запитів і дозволяє створювати інформаційні оповіщення на їх підставі. +== Overview -== Функції підсистеми +The _Event monitoring and notification subsystem_ is responsible for collecting monitoring data from applications, and infrastructure stores information as a time series (`time series`). It offers capabilities for constructing search queries and allows the creation of alerts based on these queries. -* Збирання та збереження моніторингових даних Платформних та реєстрових компонентів. -* Побудова інформаційних оповіщень на підставі даних моніторингу. -* Побудова візуальних представлень на підставі даних моніторингу. -* Надання уніфікованого інтерфейсу для збирання метрик. +== Subsystem functions -== Технічний дизайн підсистеми +* Collection and storage of monitoring data from Platform and Registry components. +* Generation of alerts based on monitoring data. +* Visualization based on monitoring data. +* Provision of a unified interface for metrics collection. -На даній діаграмі зображено компоненти, які входять в _Підсистему моніторингу подій та сповіщення_ та їх взаємодію з іншими підсистемами. +== Technical design +The following diagram depicts the components of the _Event monitoring and notification subsystem_ and their interaction with other subsystems. + +//TODO: Translate diagram, it is already exported as svg + embedded images image::architecture/platform/operational/monitoring/monitoring-subsystem.drawio.svg[width=800,float="center",align="center"] -Підсистема моніторингу подій та сповіщення може бути розширена власними отримувачами сповіщень (Alertmanager Recievers) -та створені власні інформаційні панелі на додачу до вже встановлених за замовчуванням. +The _Event monitoring and notification subsystem_ can be expanded with custom alert receivers (Alertmanager Receivers) and the creation of custom dashboards in addition to the default ones. -== Складові підсистеми +== Subsystem Components |=== -|Назва компоненти|Namespace|Deployment|Походження|Репозиторій|Призначення +|Component Name|Namespace|Deployment|Origin|Repository|Purpose -|_Веб-інтерфейс моніторингу Платформи_ +|_Platform Monitoring Web Interface_ |`grafana-monitoring` |`grafana` |3rd-party .11+|https://github.com/epam/edp-ddm-monitoring[github:/epam/edp-ddm-monitoring] -|Візуалізація та надання доступу до даних моніторингу +|Visualization and access to monitoring data -|_Розширення для рендерінгу зображень_ +|_Image Rendering Extension_ |`grafana-monitoring` |`grafana-image-renderer` |3rd-party -|Розширення для Grafana призначене для генерування PNG зображень при експорті графіків та чартів +|Grafana extension for generating PNG images during chart and graph export -|_Сервіс сповіщень_ +|_Alert Service_ |`openshift-monitoring` |`alertmanager-main` |3rd-party -|Система сповіщення адміністраторів при аномаліях або нештатних ситуаціях з компонентами Платформи або реєстрів +|Notification system for administrators during anomalies or issues with Platform or Registry components -|_Оператор Prometheus_ +|_Prometheus Operator_ |`openshift-monitoring` |`prometheus-operator` |3rd-party -|Компонент моніторингу, що забезпечує налаштування, розгортання та обслуговування компонентів Prometheus -підсистеми моніторингу Платформи +|Monitoring component providing configuration, deployment, and maintenance of Prometheus monitoring subsystem components -|_Оператор підсистеми моніторингу_ +|_Monitoring Subsystem Operator_ |`openshift-monitoring` |`cluster-monitoring-operator` |3rd-party -|Забезпечення налаштування, розгортання та обслуговування підсистеми моніторингу Платформи в OpenShift. +|Configuration, deployment, and maintenance of the Platform's monitoring subsystem in OpenShift. -|_Сервіс виконання запитів до Prometheus_ +|_Prometheus Query Service_ |`openshift-monitoring` |`thanos-querier` |3rd-party -|Агрегує та дедублікує основні метрики платформи оркестрації контейнерів OpenShift та реєстрові метрики під одним багатокористувацьким інтерфейсом. +|Aggregates and deduplicates primary orchestration platform metrics of OpenShift and Registry metrics under a multi-user interface. -|_Експортери метрик віртуальних машин_ +|_Virtual Machine Metrics Exporters_ |`openshift-monitoring` |`node-exporter` |3rd-party -|Збирання метрик з віртуальних машин Платформи та реєстрів +|Collection of metrics from the Platform and Registry virtual machines -|_Сервіс моніторингу_ +|_Monitoring Service_ |`openshift-monitoring` |`prometheus-k8s` |3rd-party -|Збирання та зберігання метрик компонентів Платформи та реєстрів. Центральний компонент, на якому базується підсистема моніторингу подій та сповіщення. Prometheus - це time-series база даних та механізм створення правил для метрик. Він також відправляє сповіщення до Alertmanager для обробки. +|Collection and storage of Platform and Registry component metrics. Central component on which the Event and Alert Monitoring Subsystem is based. Prometheus is a time-series database and metric rule engine. It also sends alerts to Alertmanager for processing. -|_Служба моніторингу k8s обʼєктів_ +|_k8s Object Monitoring Service_ |`openshift-monitoring` |`kube-state-metrics` |3rd-party -|Збирає метрики, що стосуються стану ресурсів та об'єктів kubernetes API-сервера в Платформі оркестрації контейнерів +|Collects metrics related to the state of resources and objects of the Kubernetes API server in the container orchestration platform. -|_Служба моніторингу openshift обʼєктів_ +|_OpenShift Object Monitoring Service_ |`openshift-monitoring` |`openshift-state-metrics` |3rd-party -|Збирає метрики, що стосуються стану ресурсів та об'єктів OpenShift API-сервера в Платформі оркестрації контейнерів +|Collects metrics related to the state of resources and objects of the OpenShift API server in the container orchestration platform. -|_Компонент інтеграції метрик з механізмами масштабування кластера OKD_ +|_OKD Cluster Scaling Metric Integration Component_ |`openshift-monitoring` |`prometheus-adapter` |3rd-party -|Передача метрик між Prometheus та компонентами автомасштабування Платформи оркестрації контейнерів. +|Metrics transfer between Prometheus and the container orchestration platform's auto-scaling components. -|_Служба валідації конфігурації ресурсів_ +|_Resource Configuration Validation Service_ |`openshift-monitoring` |`prometheus-operator-admission-webhook` |3rd-party -|Взаємодіє з API сервером Платформи оркестрації контейнерів для перевірки та модифікації конфігурацій ресурсів підсистеми моніторингу -перед їхнім застосуванням. +|Interacts with the container orchestration platform's API server to check and modify monitoring subsystem resource configurations before applying them. |=== -== Інформаційні панелі Grafana +== Grafana dashboards -Наведені нижче інформаційні панелі встановлюються одразу в момент інсталяції Платформи реєстрів. +The dashboards listed below are installed immediately upon installation of the Registries Platform. -Цей набір дозволяє адміністраторам Платформи та реєстрів відстежувати продуктивність компонентів протягом часу та виявляти потенційні проблеми до того, як вони стануть критичними. +This set allows Platform and registry administrators to track component performance over time and identify potential problems before they become critical. |=== -|Інформаційна панель|Технічна назва|Підсистема власник|Призначення +|*Dashboard*|*Technical name*|*Owner subsystem*|*Purpose* -|Інформаційна панель Camunda +|Camunda dashboard |camunda-metrics -|xref:arch:architecture/registry/operational/bpms/overview.adoc[Підсистема виконання бізнес-процесів] -|Дозволяє бачити загальні метрики виконання бізнес-процесів та задач користувачів (обмін повідомленнями, видалення історичних даних) +|xref:arch:architecture/registry/operational/bpms/overview.adoc[Business Process Execution Subsystem] +|Allows visibility into general metrics of business process execution and user tasks (message exchange, deletion of historical data) -|Інформаційна панель Ceph +|Ceph dashboard |ceph -|xref:arch:architecture/platform/operational/distributed-data-storage/overview.adoc[Підсистема розподіленого зберігання даних] -|Дозволяє аналізувати загальні метрики стану Ceph та його компонентів (поточний стан, обʼєми вільного та зайнятого сховища та метрики швидкодії). +|xref:arch:architecture/platform/operational/distributed-data-storage/overview.adoc[Distributed Data Storage Subsystem] +|Allows general Ceph state metrics analysis and its components (current status, volumes of free and occupied storage, and performance metrics). -|Інформаційна панель etcd +|etcd dashboard |etcd -.15+|xref:arch:architecture/container-platform/container-platform.adoc[Платформа оркестрації контейнерів] -|Дозволяє переглядати загальні метрики сховища etcd платформи оркестрації контейнерів OKD (статистику по вибору лідера алгоритмом RAFT, поточний статус та розмір сховища) +.15+|xref:arch:architecture/container-platform/container-platform.adoc[Container Orchestration Platform] +|Allows viewing general etcd storage metrics of the OKD container orchestration platform (leader election statistics by the RAFT algorithm, current status, and storage size). -|Інформаційна панель метрик кластера OpenShift +|OpenShift Cluster Metrics dashboard |cluster-total -|Загальні метрики використання ресурсів платформи оркестрації контейнерів OKD. Надає детальні метрики про завантаженість CPU, RAM, мережу та диски кластера OpenShift. +|General metrics for using the OKD container orchestration platform resources. It provides detailed metrics about the CPU, RAM, network, and disk load of the OpenShift cluster. -|Інформаційна панель Java Management Extensions +|Java Management Extensions dashboard |jmx -|Відображає метрики, що пов'язані з Java-застосунками, які запущені у платформи оркестрації контейнерів. +|Displays metrics related to Java applications running in the container orchestration platform. -|Інформаційна панель Spring Boot +|Spring Boot dashboard |springboot -|Додатково до JMX панелі, показує метрики spring boot, а саме кількість, час відгуку та помилки HTTP запитів, використання кешу та інші корисні метрики для аналізу роботи Spring Boot застосунків. +|In addition to the JMX panel, it shows spring boot metrics, namely the number, response time, and errors of HTTP requests, cache usage, and other valuable metrics for analyzing the operation of Spring Boot applications. -|Загальна інформаційна панель Kubernetes +|General Kubernetes dashboard |k8s-resources-cluster -|Дозволяє аналізувати загальні метрики стану OpenShift кластеру, використання ресурсів на кластерному рівні. +|This tool enables the analysis of OpenShift cluster state metrics and resource usage at a cluster level. -|Інформаційна панель Kubernetes рівня namespaces +|Kubernetes Namespace Level dashboard |k8s-resources-namespace -|Дозволяє аналізувати загальні метрики використання ресурсів на рівні namespaces +|Allows analysis of general resource usage metrics at the namespace level. -|Інформаційна панель Kubernetes рівня віртуальних машин +|Kubernetes Virtual Machine Level dashboard |k8s-resources-node -|Дозволяє аналізувати загальні метрики використання ресурсів на рівні окремої віртуальної машини. +|Allows analysis of general resource usage metrics at the level of an individual virtual machine. -|Інформаційна панель Kubernetes рівня pods +|Kubernetes Pod Level dashboard |k8s-resources-pod -|Дозволяє аналізувати загальні метрики використання ресурсів на рівні окремих под. +|Allows analysis of general resource usage metrics at the level of individual pods. -|Інформаційна панель типів розгортань Kubernetes +|Kubernetes Deployment Type dashboard |k8s-resources-workload -|Дозволяє аналізувати загальні метрики використання ресурсів з можливістю фільтрування по окремим типам розгортань в Kubernetes (deployments, jobs, daemonsets, statefulsets). +|Allows analysis of general resource usage metrics with the possibility of filtering by specific deployment types in Kubernetes (deployments, jobs, daemonsets, statefulsets). -|Інформаційна панель типів розгортань Kubernetes +|Kubernetes Deployment Types Dashboard |k8s-resources-workload-namespace -|Дозволяє аналізувати загальні метрики використання ресурсів на рівні окремих типів розгортань в Kubernetes в загальному вигляді на рівні namespace. +|Allows analysis of general resource usage metrics at the level of individual deployment types in Kubernetes, presented at the namespace level. -|Інформаційна панель Kubernetes рівня под +|Kubernetes Pod Level Dashboard |namespace-by-pod -|Дозволяє аналізувати загальні метрики використання ресурсів подамі в узагальненому вигляді на рівні namespace. +|Provides a comprehensive overview of pod resource usage metrics at the namespace level. -|Інформаційна панель Kubernetes рівня дисків +|Kubernetes Disk Level Dashboard |volume-load -|Дозволяє аналізувати загальні метрики використання дисків сховища на рівні кластера та віртуальних машин. +|Allows analysis of general disk storage usage metrics at the cluster and virtual machine levels. -|Інформаційна панель Kubernetes рівня кластеру +|Kubernetes Cluster Level Dashboard |node-cluster-rsrc-use -|Відображає загальні метрики всього кластеру +|Displays general metrics of the entire cluster. -|Інформаційна панель Kubernetes рівня кластеру +|Kubernetes Cluster Level Dashboard |node-rsrc-use -|Відображає загальні метрики всього кластеру з можливістю фільтрування за окремими віртуальними машинами. +|Displays general metrics of the entire cluster with the possibility of filtering by individual virtual machines. -|Мережева інформаційна панель +|Network Dashboard |pod-total -|Відображає метрики поточного трафіку між подами в окремих неймспейсах. +|Displays metrics of current traffic between pods in individual namespaces. -|Інформаційна панель підсистеми асинхронного обміну повідомленнями +|Asynchronous Message Exchange Subsystem Dashboard |kafka-data -.2+|xref:arch:architecture/registry/operational/messaging/overview.adoc[Підсистема асинхронного обміну повідомленнями] -|Інформаційна панель для даних Kafka призначена для відображення метрик, пов'язаних з роботою Kafka брокерів та споживачів у кластері. +.2+|xref:arch:architecture/registry/operational/messaging/overview.adoc[Asynchronous Message Exchange Subsystem] +|The Kafka data dashboard is designed to display metrics related to the operation of Kafka brokers and consumers in the cluster. -|Інформаційна панель підсистеми асинхронного обміну повідомленнями від Strimzi +|Strimzi Asynchronous Message Exchange Subsystem Dashboard |strimzi-kafka -|Призначена для відображення метрик, пов'язаних з роботою Kafka брокерів та споживачів у кластері. +|Designed to display metrics related to the operation of Kafka brokers and consumers in the cluster. -|Інформаційна панель підсистеми управління користувачами та ролями +|User and Role Management Subsystem Dashboard |keycloak-metrics -.4+|xref:arch:architecture/platform/operational/user-management/overview.adoc[Підсистема управління користувачами та ролями] -|Відображає метрики Keycloak у розрізі Realms з можливістю фільтрувати за екземплярами Keycloak. +.4+|xref:arch:architecture/platform/operational/user-management/overview.adoc[User and Role Management Subsystem] +|Displays Keycloak metrics broken down by Realms with the possibility to filter by Keycloak instances. -|Інформаційна панель підсистеми управління користувачами та ролями +|User and Role Management Subsystem Dashboard |keycloak-x-microprofile-metrics -|Призначена для відображення метрик, пов'язаних з роботою Java метрик компонента Keycloak +|Designed to display metrics related to the operation of the Java metrics component of Keycloak. -|Інформаційна панель бази даних PostgreSQL +|PostgreSQL Database Dashboard |postgresql-db -|Надає детальну інформацію про екземпляр бази даних PostgreSQL. +|Provides detailed information about the PostgreSQL database instance. -|Інформаційна панель запитів PostgreSQL +|PostgreSQL Queries Dashboard |postgresql-queries -|Надає додаткову інформацію про запити. +|Provides additional information about queries. -|Інформаційна панель публічного API підсистеми управління зовнішнім трафіком операційної зони реєстру +|Public API Dashboard for External Traffic Management Subsystem of the Operational Zone Registry |kong-public-api -|xref:arch:architecture/registry/operational/ext-api-management/overview.adoc[Підсистема управління зовнішнім трафіком операційної зони реєстру] -|Дозволяє переглядати запити по кожному публічному search condition та їх кількість, тренд виконання запитів та статистку по швидкодії. +|xref:arch:architecture/registry/operational/ext-api-management/overview.adoc[External Traffic Management Subsystem of the Operational Zone Registry] +|Allows viewing requests for each public search condition and their quantity, request execution trend, and performance statistics. -|Інформаційна панель підсистеми моніторингу та подій та сповіщення +|Monitoring, Events, and Notifications Subsystem Dashboard |prometheus -|xref:arch:architecture/platform/operational/monitoring/overview.adoc[Підсистема моніторингу та подій та сповіщення] -|Дозволяє моніторити стан та продуктивність компонентів підсистеми моніторингу. +|xref:arch:architecture/platform/operational/monitoring/overview.adoc[Monitoring, Events, and Notifications Subsystem] +|Allows monitoring of the status and performance of monitoring subsystem components. -|Інформаційна панель підсистеми аналітичної звітності реєстру +|Registry Analytical Reporting Subsystem Dashboard |redash -|xref:arch:architecture/registry/operational/reporting/overview.adoc[Підсистема аналітичної звітності реєстру] -|Надає статистику по запитам в компоненті Redash. +|xref:arch:architecture/registry/operational/reporting/overview.adoc[Registry Analytical Reporting Subsystem] +|Provides statistics on queries in the Redash component. -|Інформаційна панель підсистеми управління нереляційними базами даних +|Non-Relational Database Management Subsystem Dashboard |redis -|xref:arch:architecture/registry/operational/nonrelational-data-storage/overview.adoc[Підсистема управління нереляційними базами даних] -|Надає інформацію про конкретний кластер _Redis_. +|xref:arch:architecture/registry/operational/nonrelational-data-storage/overview.adoc[Non-Relational Database Management Subsystem] +|Provides information about a specific Redis cluster. -|Інформаційна панель резервного копіювання PostgreSQL +|PostgreSQL Backup Dashboard |crunchy-pgbackrest -.6+|xref:arch:architecture/registry/operational/relational-data-storage/overview.adoc[Підсистема управління реляційними базами даних] -|Надає інформацію про загальний стан резервних копій _pgBackRest_. +.6+|xref:arch:architecture/registry/operational/relational-data-storage/overview.adoc[Relational Database Management Subsystem] +|Provides information about the general status of pgBackRest backups. -|Детальна інформаційна панель PostgreSQL под +|Detailed PostgreSQL Pod Dashboard |crunchy-pod-details -|Надає інформацію про використання ресурсів конкретними подами, які використовуються кластером PostgreSQL. +|Provides information about resource usage by specific pods used by the PostgreSQL cluster. -|Детальна інформаційна панель PostgreSQL +|Detailed PostgreSQL Dashboard |crunchy-postgresql-details -|Надає більше інформації про конкретний кластер _PostgreSQL_. Включає багато ключових, специфічних для PostgreSQL, метрик. +|Provides more information about a specific PostgreSQL cluster. It includes many critical PostgreSQL-specific metrics. -|Оглядова інформаційна панель PostgreSQL +|Overview PostgreSQL Dashboard |crunchy-postgresql-overview -|Надає огляд усіх кластерів _PostgreSQL_ розгорнутих на Платформі. +|Provides an overview of all PostgreSQL clusters deployed on the Platform. -|Сервісна інформаційна панель PostgreSQL +|PostgreSQL Service Dashboard |crunchy-postgresql-service-health -|Містить інформацію про служби Kubernetes, які розташовані перед _PostgreSQL_ Pods. Це надає інформацію про стан мережі. +|Contains information about Kubernetes services located in front of PostgreSQL Pods. It allows us to get information about network status. -|Інформаційна панель запитів PostgreSQL +|PostgreSQL Queries Dashboard |crunchy-query-statistics -|Надає інформацію про загальну продуктивність запитів. +|Provides information about the overall query performance. |=== -== Технологічний стек +== Technology stack -При проєктуванні та розробці підсистеми, були використані наступні технології: +The following technologies were used during the design and development of the subsystem: * xref:arch:architecture/platform-technologies.adoc#okd[OKD] * xref:arch:architecture/platform-technologies.adoc#prometheus[Prometheus] @@ -267,16 +267,16 @@ image::architecture/platform/operational/monitoring/monitoring-subsystem.drawio. * xref:arch:architecture/platform-technologies.adoc#thanosquerier[Thanos Querier] * xref:arch:architecture/platform-technologies.adoc#grafana[Grafana] -== Атрибути якості підсистеми +== Subsystem quality attributes === _Scalability_ -Підсистема моніторингу подій та сповіщення розроблена з урахуванням горизонтального масштабування для підтримки великих -кластерів та високого обсягу метрик з Платформи та реєстрів. + +The event monitoring and notification subsystem is designed with horizontal scaling in mind to support large clusters and high volumes of metrics from the Platform and registries. === _Reliability_ -Підсистема моніторингу подій та сповіщення використовує стабільні та надійні компоненти, такі як Prometheus, Grafana та -Alertmanager, для надання точних та стабільних рішень щодо моніторингу Платформи та реєстрів та аналізу вже зібраних метрик. + +The event monitoring and notification subsystem employs stable and reliable components, such as Prometheus, Grafana, and Alertmanager, to provide accurate and consistent solutions for monitoring the Platform and registries and analyzing the collected metrics. === _Extensibility_ -Підсистема моніторингу подій та сповіщення має гнучкі механізми та точки розширення власними інформаційними панелями або -власними каналами сповіщень, які не підтримуються за замовчуванням (telegram, тощо). + +The event monitoring and notification subsystem offers flexible mechanisms and extension points for custom dashboards or custom notification channels that aren't supported by default (e.g., telegram, etc.). diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/secret-management/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/secret-management/overview.adoc index 7fac2968c9..a5482634c2 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/secret-management/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/secret-management/overview.adoc @@ -1,7 +1,8 @@ -//= Підсистема управління секретами та шифруванням = Secret and encryption management subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == Overview //Підсистема безпечного зберігання чутливої інформації та контролю доступу до токенів, паролів, сертифікатів та ключів шифрування Платформи та Реєстрів. @@ -13,7 +14,7 @@ The subsystem for the storing of critical data and access control to tokens, pas //* Зберігання токенів, паролів, сертифікатів * Storing of tokens, passwords, certificates //* Надання підсистемі моделювання регламенту реєстру ключів шифрування -* Provision of encryption keys to the regulations modelling subsystem +* Provision of encryption keys to the regulations modeling subsystem //* Контроль доступу до чутливої інформації збереженої в підсистемі * Access control to the critical data stored in the subsystem diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/istio-jwt-token-validation.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/istio-jwt-token-validation.adoc index 39347de141..4bb14381ca 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/istio-jwt-token-validation.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/istio-jwt-token-validation.adoc @@ -1,21 +1,11 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Validating JWT with Istio Envoy +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] -NOTE: 🌐 This document is available in both English and Ukrainian. Use the language toggle in the top right corner to switch between versions. +include::platform:ROOT:partial$admonitions/language-en.adoc[] //TIP: JWT-token (_eng. **JSON Web Token**_) -- формат безпечного обміну даними, який використовується найчастіше для передачі чутливої інформації або авторизації HTTP-запитів користувачів. JWT-токен може бути підписаний секретом (за допомогою HMAC алгоритму) або пар відкритий/приватний ключ використовуючи алгоритми RSA або ECDSA. Стандартизований у RFC 7519. TIP: JWT-token (_eng. **JSON Web Token**_) -- a secure data exchange format that is most commonly used to transfer sensitive information or authorize user HTTP requests. The JWT token can be signed with a secret (using the HMAC algorithm) or a public/private key pair using the RSA or ECDSA algorithms. Standardized in RFC 7519. -//== Вступ == Introduction //JWT-токен зазвичай відправляється як Bearer токен у заголовку користувацького HTTP запиту. Перед тим як запит досягне мікросервісу, Istio Envoy може: diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/overview.adoc index 1a48e20aca..3b4cf61943 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/overview.adoc @@ -1,10 +1,8 @@ -//= Підсистема управління міжсервісною взаємодією = Cross-service communication management subsystem include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == General description //// @@ -14,7 +12,7 @@ _Підсистема управління міжсервісною взаємо політиками, телеметрією та безпекою, забезпечує балансування навантаження, маршрутизацію трафіку та шифрування. //// -_Interservice interaction management subsystem_ implementing the _Service Mesh_ network pattern helps developers and +The *_Cross-service communication management subsystem_* implementing the *_Service Mesh_* network pattern helps developers and registry administrators securely connect external systems to the Registry Platform and vice versa, protects and monitors components of the Platform and registries, provides a set of components for managing external/internal traffic, network policies, telemetry and security, provides load balancing, traffic routing and encryption. diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/service-mesh-components.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/service-mesh-components.adoc index 3cf41692c9..e7d45675e3 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/service-mesh-components.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/service-mesh/service-mesh-components.adoc @@ -1,19 +1,10 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: += Service Mesh: Platform and registry components +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] -= Service Mesh and Platform components - -NOTE: 🌐 This document is available in both English and Ukrainian. Use the language toggle in the top right corner to switch between versions. +include::platform:ROOT:partial$admonitions/language-en.adoc[] //В даній секції приведені компоненти _Платформи Реєстрів_, що утворюють _Service Mesh_. -This section lists the components of the _Registry Platform_ that make up the _Service Mesh_. +This section lists the components of the _Registries Platform_ that make up the _Service Mesh_. //// |=== diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/user-management/overview.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/user-management/overview.adoc index ddc4398f76..98eea54907 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/user-management/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/user-management/overview.adoc @@ -1,13 +1,13 @@ -//= Підсистема управління користувачами та ролями = Users and roles management subsystem +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == Overview //Підсистема, що забезпечує управління користувачами та їх доступом, налаштуваннями автентифікації, авторизації, single sign-on (SSO) та інтеграції з зовнішніми _Identity Providers_ в Платформи реєстрів. The subsystem that provides management for users, user management, authentication/authorization settings, signle sign-on (SSO), and external _Identity Providers_ integration in the Registry Platform. -//== Функції підсистеми == Subsystem functions //* Автентифікація користувачів diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/user-management/platform-actors-roles.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/user-management/platform-actors-roles.adoc index affea48a30..538ce9a9fd 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/user-management/platform-actors-roles.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/user-management/platform-actors-roles.adoc @@ -1,112 +1,12 @@ - -//// -: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: -//// - - -//= Актори та ролі Платформи = Platform actors and roles +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Користувачі реєстру == Registry users -//=== Актори === Actors -//// - -|=== -|Підкатегорія|Актор|Keycloak Realm|Системна роль|Системний атрибут|Опис - -|*Неавторизовані користувачі* -|Анонімний користувач -|- -|- -|- -|Неавторизований користувач. Має доступ виключно до публічних даних та сторінки автентифікації. - -.4+|*Отримувачі послуг* -|Особа (Громадянин) -|citizen -a|* citizen -* unregistered-individual -* individual -a|* SUBJECT_TYPE=INDIVIDUAL -|Фізична особа що отримує послуги від Посадової Особи/Системи. Має доступ до даних про себе. - -|Фізична Особа Підприємець (ФОП) -|citizen -a|* citizen -* unregistered-entrepreneur -* entrepreneur -a|* REPRESENTATIVE=false -* SUBJECT_TYPE=ENTREPRENEUR -|Фізична особа підприємець що отримує послуги від Посадової Особи/Системи. Має доступ до даних про свій ФОП. - -|Представник Фізичної Особи Підприємця (ФОП) -|citizen -a|* citizen -* unregistered-entrepreneur -* entrepreneur -a|* REPRESENTATIVE=true -* SUBJECT_TYPE=ENTREPRENEUR -|Представник Фізична особа підприємець що отримує послуги від Посадової Особи/Системи. Має доступ до даних про свій ФОП. - -|Представник Юридичної Особи -|citizen -a|* citizen -* unregistered-legal -* legal -a|* REPRESENTATIVE=true -* SUBJECT_TYPE=LEGAL -|Представник юридичної особи що отримує послуги від Посадової Особи/Системи. Має доступ до даних про юридичну особу. - -.4+|*Надавачі послуг* -|Особа -|officer -|unregistered_officer -|- -|Особа, яка самостійно зареєструвалась як надавач послуг, якщо це передбачено конфігурацією реєстру. - -|Посадова Особа -|officer -|officer -|- -|Представник державного органу, що взаємодіє із Реєстром у рамках виконання своїх службових обов'язків та працює через інтерфейс Платформи. - -|[red]#Посадова Особа - кадровик# -|officer -a|* officer -* [red]#Потребує реалізації окремої ролі# -|- -|Керує користувачами через БП (спеціальні бізнес-процеси для створення/зміни користувачів та їх ролей). Налаштовує ролі в рамках свого підрозділу - -|[red]#Посадова Особа - керівник підрозділу# -|officer -a|* officer -* [red]#Потребує реалізації окремої ролі# -|- -|Переглядає дашборди ефективності виконання задач іншими посадовими особами -|=== -//// - |=== |Subcategory|Actor|Keycloak Realm|System role|System attribute|Description diff --git a/docs/en/modules/arch/pages/architecture/platform/operational/user-management/registry-roles.adoc b/docs/en/modules/arch/pages/architecture/platform/operational/user-management/registry-roles.adoc index 7b5ddc083a..97b74575a0 100644 --- a/docs/en/modules/arch/pages/architecture/platform/operational/user-management/registry-roles.adoc +++ b/docs/en/modules/arch/pages/architecture/platform/operational/user-management/registry-roles.adoc @@ -1,47 +1,17 @@ -//== Ролі регламенту -== Registry roles += Registry roles +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] //Система надає можливість розширювати перелік ролей для чиновників та громадян. В подальшому ролі регламенту можуть бути використані для налаштування карти доступу на рівні фізичною моделі чи налаштування доступу до окремих бізнес-процесів регламенту. The system allows for the extension of the role list for citizens and officers. Eventually, Regulations roles will be used to configure access map on the physical model level, or configure access to separate Regulations Business Processes. [NOTE] -// Детальніше про налаштування доступу до бізнес-процесів можна ознайомитися xref:architecture/platform/operational/user-management/registry-authz.adoc[за посиланням]. Learn more about configuring access to Business Processes xref:architecture/platform/operational/user-management/registry-authz.adoc[here]. -//=== Структура файлів -=== File structure -//Регламентні ролі є частиною регламенту та зберігається у директорії з назвою *roles*. Ролі налаштовуються окремо для чиновників та громадян у відповідних файлах *officer.yml* та *citizen.yml* +== File structure Regulations roles are part of Regulations, and are stored in the *roles* directory. Roles for citizens and officers are stored in the corresponding files - *officer.yml* and *citizen.yml*. - -//// -[plantuml] ----- -@startsalt -{ -{T -+ <&folder> registry-regulations -++ <&folder> bpmn -++ <&folder> dmn -++ ... - -++ <&folder> roles -+++ <&file> officer.yml -+++ <&file> citizen.yml -} -} -@endsalt ----- -[source, yaml] ----- -roles: - - name: officer-first-rank - description: Роль для чиновників першого рангу - - name: officer-second-rank - description: Роль для чиновників другого рангу ----- -//// - [plantuml] ---- @startsalt @@ -68,24 +38,9 @@ roles: description: Role for second-rank officers ---- -//=== Опис структури елементів конфігурації === Configuration elements structure ==== Role -//// -|=== -|Назва |Схема |Коментар - -|*name* -|string -|Назва регламентної ролі. Повинна мати унікальне значення у реалмі. - -|*description* (_optional_) -|string -|Короткий опис для ролі -|=== -//// - |=== |Name |Scheme |Comment @@ -99,8 +54,7 @@ roles: |=== -//=== Публікація змін -=== Changes publication +== Publishing changes //Регламентні ролі підпадають під загальні правила роботи з регламентом реєстру в контексті відстеження та публікації змін. Тобто, у разі наявності змін до файлів регламентних ролей (*roles/officer.yml*, *roles/citizen.yml*) пайплайн публікації змін до регламенту буде запущений. В рамках виконання пайплайну крок *create-keycloak-roles* відповідає за публікацію змін до регламентних ролей. При успішному проходженні цього кроку система буде мати регламентні ролі відповідно до змісту файлів. Regulations roles are subject to the general Registry regulations operation rules in terms of changes monitoring and publication. In case there are changes to regulations roles files (*roles/officer.yml*, *roles/citizen.yml*), the changes publication pipeline will be started. Pipeline execution includes the *create-keycloak-roles* step that is responsible for regulations roles changes publication. After successful execution of this step the system will have regulations roles according to the files contents. @@ -109,10 +63,7 @@ Regulations roles are subject to the general Registry regulations operation rule Kubernetes CR KeycloakRealmRoleBatch is used as part of API for role configuration: https://github.com/epam/edp-keycloak-operator/tree/master#keycloak-operator[Keycloak operator] -//=== Діаграма послідовності публікації змін -=== Changes publication sequence diagram - -//TODO check if the uml diagram translated +== Changes publication sequence diagram [plantuml] ---- diff --git a/docs/en/modules/arch/pages/architecture/registry/administrative/registry-regulation/registry-regulation.adoc b/docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc similarity index 98% rename from docs/en/modules/arch/pages/architecture/registry/administrative/registry-regulation/registry-regulation.adoc rename to docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc index a6bf6a95b5..91531c968e 100644 --- a/docs/en/modules/arch/pages/architecture/registry/administrative/registry-regulation/registry-regulation.adoc +++ b/docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc @@ -14,7 +14,7 @@ NOTE: 🌐 This document is available in both English and Ukrainian. Use the lan == General description -_Registry Regulations_ is a digital representation of important aspects of the registry functioning, consisting of declarative descriptions of the organizational structure, data model, information and administrative services, access rights, templates of excerpts and messages, settings of integrations with external systems, etc. +The **_Registry regulations**_ is a digital representation of important aspects of the registry functioning, consisting of declarative descriptions of the organizational structure, data model, information and administrative services, access rights, templates of excerpts and messages, settings of integrations with external systems, etc. //_Регламент реєстру_ - це цифрове представлення важливих аспектів функціонування реєстру, що складається з декларативних описів організаційної структури, моделі даних, інформаційних та адміністративних послуг, прав доступу, шаблонів витягів та повідомлень, налаштувань інтеграцій з зовнішніми системами, тощо. The _registry regulation_ together with the _operational registry configuration_ constitute a necessary and sufficient description of the functionalities implemented in the registry and settings to ensure that the appropriate level of quality of their provision to end users. @@ -129,7 +129,7 @@ The registry regulations are represented in the _Git_ repository as a set of dir [IMPORTANT] -- -Redesign planned and documented. You can find out more in the xref:arch:architecture-workspace/platform-evolution/registry-settings/registry-settings.adoc[Management of registry settings at the regulation level] section. +Redesign planned and documented. You can find out more in the xref:architecture-workspace/platform-evolution/registry-settings/registry-settings.adoc[Management of registry settings at the regulation level] section. //Заплановано та задокументовано редизайн. Детальніше можна ознайомитись у розділі xref:arch:architecture-workspace/platform-evolution/registry-settings/registry-settings.adoc[] -- diff --git a/docs/en/modules/arch/pages/architecture/registry/operational/bpms/bpm-save-ext-documents.adoc b/docs/en/modules/arch/pages/architecture/registry/operational/bpms/bpm-save-ext-documents.adoc index 51b5d9cbf1..03b3d5aec1 100644 --- a/docs/en/modules/arch/pages/architecture/registry/operational/bpms/bpm-save-ext-documents.adoc +++ b/docs/en/modules/arch/pages/architecture/registry/operational/bpms/bpm-save-ext-documents.adoc @@ -55,7 +55,7 @@ image::architecture/registry/operational/bpms/remote-file-transfer.svg[remote-fi Downloading digital documents from external sources requires the presence of a corresponding _Istio Service Entry_, which was created in automatic or manual mode. //В цільовому рішенні, для вивантаження файлів з віддаленої системи у процесі виконання БП, технічний адміністратор реєстру попередньо має налаштувати відповідну зовнішню систему через _адмін-консоль_ згідно дизайну xref:arch:architecture-workspace/platform-evolution/registry-regulation-secrets.adoc[]. -In the target solution, for retrieving files from a remote system during the BP execution, the registry's technical administrator must preconfigure the respective external system through the _admin console_, following the design in xref:arch:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc[] +In the target solution, for retrieving files from a remote system during the BP execution, the registry's technical administrator must preconfigure the respective external system through the _admin console_, following the design in xref:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc[] -- //=== API збереження цифрового документу за віддаленою адресою diff --git a/docs/en/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc b/docs/en/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc index da0cd3f626..3ca8e20373 100644 --- a/docs/en/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc +++ b/docs/en/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc @@ -72,7 +72,7 @@ image::arch:architecture/registry/operational/ext-systems-simulation/mocking/ena //Важливо відзначити, що після збереження конфігурації відбувається виконнаня флоу яке описане в рамках дизайну It is important to note that after the configuration is saved, the flow described in the design is executed -xref:arch:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc#_технічний_дизайн_рішення[Management of settings and secrets of external integrations] including the following remarks: +xref:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc#_технічний_дизайн_рішення[Management of settings and secrets of external integrations] including the following remarks: //// * [#required-changes]#Якщо користувач хоче замокувати зовнішню REST систему (не Трембіту) яка була створена - необхідно видалити service entry для неї# diff --git a/docs/en/modules/arch/pages/architecture/security/access-control.adoc b/docs/en/modules/arch/pages/architecture/security/access-control.adoc index 5266b101c5..a13ccff10c 100644 --- a/docs/en/modules/arch/pages/architecture/security/access-control.adoc +++ b/docs/en/modules/arch/pages/architecture/security/access-control.adoc @@ -1,10 +1,8 @@ -//= Управління доступом = Managing access control -include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == General description //Управління доступом на платформі відіграє критичну роль у забезпеченні безпеки та зручності. Воно дозволяє обмежувати доступ до ресурсів лише авторизованим користувачам, що мінімізує ризик витоку конфіденційної інформації та несанкціонованого використання. Одночасно це сприяє ефективності, оскільки користувачі мають швидкий доступ до того, що їм потрібно, не витрачаючи час на пошук або очікування дозволів. Такий підхід забезпечує баланс між захистом від потенційних загроз та створенням зручного середовища для взаємодії користувачів з платформою. diff --git a/docs/en/modules/arch/pages/architecture/security/data-classification.adoc b/docs/en/modules/arch/pages/architecture/security/data-classification.adoc index c8272b5e3a..9be556fdde 100644 --- a/docs/en/modules/arch/pages/architecture/security/data-classification.adoc +++ b/docs/en/modules/arch/pages/architecture/security/data-classification.adoc @@ -3,13 +3,6 @@ include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] -[NOTE] --- -//Сторінка технічної документації у процесі розробки... -The page is under development. --- - -//== Рівні конфіденційності, цілісності та доступності інформації == Confidentiality, integrity, and information availability levels |=== diff --git a/docs/en/modules/arch/pages/architecture/security/data-encryption-at-rest.adoc b/docs/en/modules/arch/pages/architecture/security/data-encryption-at-rest.adoc index a3861ad236..e4bae327b1 100644 --- a/docs/en/modules/arch/pages/architecture/security/data-encryption-at-rest.adoc +++ b/docs/en/modules/arch/pages/architecture/security/data-encryption-at-rest.adoc @@ -1,4 +1,3 @@ -//= Шифрування даних при зберіганні = Data at Rest Encryption include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] @@ -8,7 +7,7 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] == General overview //_Шифрування даних при зберіганні (at-rest encryption)_ є методом захисту конфіденційності та цілісності даних під час їх зберігання на носіях, таких як диски, файлові системи або бази даних. Воно відрізняється від шифрування в транспорті, яке застосовується для захисту даних під час їх передачі мережею. Такий підхід забезпечує конфіденційність даних в разі фізичного доступу до носія, наприклад, в разі втрати, викрадення або несанкціонованого доступу до фізичного пристрою. -_Data at Rest Encryption_ is a method for safeguarding the confidentiality and integrity of data while it is stored on media such as disks, file systems, or databases. It differs from transport encryption, which is employed to protect data during its transmission over a network. This approach ensures data confidentiality in cases of physical access to the storage media, such as loss, theft, or unauthorized access to the physical device. +*_Data at Rest Encryption (DARE)_* is a method for safeguarding the confidentiality and integrity of data while it is stored on media such as disks, file systems, or databases. It differs from transport encryption, which is employed to protect data during its transmission over a network. This approach ensures data confidentiality in cases of physical access to the storage media, such as loss, theft, or unauthorized access to the physical device. //== Застосування шифрування даних при зберіганні == Application of Data at Rest Encryption diff --git a/docs/en/modules/arch/pages/architecture/security/data-encryption-in-transit.adoc b/docs/en/modules/arch/pages/architecture/security/data-encryption-in-transit.adoc index e72ed8238d..429b64703d 100644 --- a/docs/en/modules/arch/pages/architecture/security/data-encryption-in-transit.adoc +++ b/docs/en/modules/arch/pages/architecture/security/data-encryption-in-transit.adoc @@ -1,14 +1,12 @@ -//= Шифрування даних у русі = Data encryption in transit include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис -== General overview +== General description //_Шифрування у русі_ - це процес перетворення інформації таким чином, щоб вона стала незрозумілою для несанкціонованих осіб, які не мають відповідних ключів для розшифрування. Цей процес використовується для забезпечення конфіденційності та безпеки даних під час передачі. -_Data encryption in transit_ is the process of transforming information in such a way that it becomes unintelligible to unauthorized individuals who lack the corresponding keys for decryption. This process is employed to ensure the confidentiality and security of data during transmission. +*_Data encryption in transit_* is the process of transforming information in such a way that it becomes unintelligible to unauthorized individuals who lack the corresponding keys for decryption. This process is employed to ensure the confidentiality and security of data during transmission. //Основні ідеї шифрування у русі: Key concepts of data encryption in transit: @@ -22,8 +20,7 @@ Key concepts of data encryption in transit: //* _Дотримання регуляторних вимог_: Шифрування у русі є однією з основних вимог безпеки профільних стандартів. * _Compliance with regulatory requirements_: Encryption in transit is a fundamental security requirement of industry standards. -//=== Шифрування трафіку між користувачами та платформою -=== Encryption of traffic between users and the Platform +=== Encrypting traffic between users and Platform //Для забезпечення безпечного каналу звязку та обміну даними між користувачем та платформою використовується криптографічний протокол TLS 1.2. To establish a secure communication channel and data exchange between users and the Platform, the cryptographic protocol TLS 1.2 is utilized. diff --git a/docs/en/modules/arch/pages/architecture/security/data-retention.adoc b/docs/en/modules/arch/pages/architecture/security/data-retention.adoc index 9d3b9971ea..5a9651392a 100644 --- a/docs/en/modules/arch/pages/architecture/security/data-retention.adoc +++ b/docs/en/modules/arch/pages/architecture/security/data-retention.adoc @@ -1,11 +1,9 @@ -//= Збереження даних = Data retention include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис -== General overview +== General description //Опис збереження даних на платформі є важливою складовою інформаційної безпеки та прозорої роботи з даними. У цьому документі описуються ключові аспекти політики та стратегії збору, зберігання та видалення даних з платформи реєстрів. Description of the data retention on the Platform is a crucial component of information security and transparent data handling. This document outlines key aspects of the policy and strategy for data collection, storage, and deletion from the Platform for state registries. diff --git a/docs/en/modules/arch/pages/architecture/security/overview.adoc b/docs/en/modules/arch/pages/architecture/security/overview.adoc index 703a0c579e..a356514498 100644 --- a/docs/en/modules/arch/pages/architecture/security/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/security/overview.adoc @@ -1,12 +1,9 @@ -//= Архітектура безпеки Платформи -= Security architecture of the Platform - += Platform security architecture include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис -== General overview +== General description //_Безпека_ — це показник здатності системи захищати дані та інформацію від несанкціонованого доступу, забезпечуючи при цьому доступ авторизованим користувачам і системам. _Security_ is a measure of a system's ability to protect data and information from unauthorized access while ensuring authorized users and systems have access. @@ -15,14 +12,14 @@ _Security_ is a measure of a system's ability to protect data and information fr The security architecture of the Platform for state registries is responsible for three commonly accepted characteristics: //* _Конфіденційність_ – властивість захисту даних або сервісів від несанкціонованого доступу. -* _Confidentiality_ -- the property of protecting data or services from unauthorized access. +* *_Confidentiality_* -- the property of protecting data or services from unauthorized access. //* _Цілісність_ – властивість того, що дані або послуги не піддаються несанкціонованим маніпуляціям. -* _Integrity_ -- the property that data or services are not susceptible to unauthorized manipulation. +* *_Integrity_* -- the property that data or services are not susceptible to unauthorized manipulation. //* _Доступність_ - властивість, що система буде доступна для цільового використання. -* Availability -- the property that the system will be available for its intended use. +* *_Availability_* -- the property that the system will be available for its intended use. //Архітектура безпеки покриває наступні частини: -The security architecture covers the following components: +The security architecture covers the following components: :: //* Розроблені компоненти з яких складається платформа. //* Вбудовані компоненти @@ -31,7 +28,7 @@ The security architecture covers the following components: //* Інфраструктурні компоненти на яких побудована платформа //* Процес безпечної розробки програмного забезпечення //* Вимоги до безпеки -* Developed components that make up the Platform. +* Developed components that make up the Platform * Embedded components * Third-party services used by the system * Software architecture @@ -39,22 +36,21 @@ The security architecture covers the following components: * Secure software development process * Security requirements -//== Розділи технічній документації == Sections of technical documentation +* xref:arch:architecture/security/standards-and-compliance.adoc[] page underscores the fundamental role that data privacy and regulatory compliance play in safeguarding the integrity, confidentiality, and accessibility of the information entrusted to the Registries Platform. + //* xref:arch:architecture/security/data-classification.adoc[] - визначення та встановлення рівня конфіденційності, цілісності та доступності даних залежно від їх важливості, чутливості та потенційного впливу на організацію або платформу. -* xref:arch:architecture/security/data-classification.adoc[] -- defining and establishing the level of confidentiality, integrity, and availability of data based on their importance, sensitivity, and potential impact on the organization or platform. +* xref:arch:architecture/security/data-classification.adoc[Data classification] -- defining and establishing the level of confidentiality, integrity, and availability of data based on their importance, sensitivity, and potential impact on the organization or platform. //* xref:arch:architecture/security/data-encryption-at-rest.adoc[] - опис криптографічних механізмів платформи перетворення даних в незрозумілий для несанкціонованого доступу формат з метою захисту конфіденційності та запобігання несанкціонованому доступу до цих даних під час їх зберігання. -* xref:arch:architecture/security/data-encryption-at-rest.adoc[] -- description of the Platform's cryptographic mechanisms for transforming data into an unreadable format to protect confidentiality and prevent unauthorized access to this data while it is stored. +* xref:arch:architecture/security/data-encryption-at-rest.adoc[Encryption at rest] -- description of the Platform's cryptographic mechanisms for transforming data into an unreadable format to protect confidentiality and prevent unauthorized access to this data while it is stored. //* xref:arch:architecture/security/data-encryption-in-transit.adoc[] - опис криптографічних механізмів платформи перетворення даних в незрозумілу форму з метою забезпечення їх конфіденційності та захисту від несанкціонованого доступу під час передачі по мережі. -* xref:arch:architecture/security/data-encryption-in-transit.adoc[] -- description of the Platform's cryptographic mechanisms for transforming data into an unintelligible form to ensure its confidentiality and protection against unauthorized access during transmission over the network. +* xref:arch:architecture/security/data-encryption-in-transit.adoc[Encryption in transit] -- description of the Platform's cryptographic mechanisms for transforming data into an unintelligible form to ensure its confidentiality and protection against unauthorized access during transmission over the network. //* xref:arch:architecture/security/data-retention.adoc[] - опис процедур та технічних заходів, що регулюють тривалість зберігання даних на платформі з метою забезпечення вимог законодавства, внутрішніх правил або бізнес-потреб. -* xref:arch:architecture/security/data-retention.adoc[] -- description of procedures and technical measures that regulate the duration of data retention on the Platform to meet legal requirements, internal policies, or business needs. +* xref:arch:architecture/security/data-retention.adoc[Data retention] -- description of procedures and technical measures that regulate the duration of data retention on the Platform to meet legal requirements, internal policies, or business needs. //* xref:arch:architecture/security/secret-management.adoc[] - документація стосовно використання, обігу та гарантування безпеки ключів доступу всередині платформи. -* xref:arch:architecture/security/secret-management.adoc[] -- documentation regarding the usage, handling, and security assurance of access keys within the Platform. +* xref:arch:architecture/security/secret-management.adoc[Secrets management] -- documentation regarding the usage, handling, and security assurance of access keys within the Platform. //* xref:arch:architecture/security/access-control.adoc[] - механізми контролю та регулювання доступу до ресурсів, систем, даних та інших активів платформи з метою забезпечення конфіденційності, цілісності та доступності інформації а також механізми контролю життєвого циклу користувачів та сутностей. -* xref:arch:architecture/security/access-control.adoc[] -- mechanisms for controlling and regulating access to Platform resources, systems, data, and other assets to ensure the confidentiality, integrity, and availability of information, as well as mechanisms for controlling the lifecycle of users and entities. +* xref:arch:architecture/security/access-control.adoc[Access control] -- mechanisms for controlling and regulating access to Platform resources, systems, data, and other assets to ensure the confidentiality, integrity, and availability of information, as well as mechanisms for controlling the lifecycle of users and entities. //* xref:arch:architecture/security/data-integrity.adoc[] - опис процесу забезпечення правдивості, недоступності змін та цілісності даних, систем, процесів платформи.= Security Architecture -* xref:arch:architecture/security/data-integrity.adoc[] -- description of the process of ensuring the truthfulness, non-alteration, and integrity of data, systems, and processes within the Platform. - -CAUTION: The page is under development. +* xref:arch:architecture/security/data-integrity.adoc[Data integrity] -- description of the process of ensuring the truthfulness, non-alteration, and integrity of data, systems, and processes within the Platform. \ No newline at end of file diff --git a/docs/en/modules/arch/pages/architecture/security/standarts-and-compliance.adoc b/docs/en/modules/arch/pages/architecture/security/standards-and-compliance.adoc similarity index 72% rename from docs/en/modules/arch/pages/architecture/security/standarts-and-compliance.adoc rename to docs/en/modules/arch/pages/architecture/security/standards-and-compliance.adoc index 708f8ce711..32b21b4a63 100644 --- a/docs/en/modules/arch/pages/architecture/security/standarts-and-compliance.adoc +++ b/docs/en/modules/arch/pages/architecture/security/standards-and-compliance.adoc @@ -8,9 +8,7 @@ :sectlinks: :partnums: -= Standartds and Compliance - -CAUTION: The page is under development. += Standards and compliance == Overview @@ -18,12 +16,12 @@ In the context of data registries, where valuable information is collected, proc The document underscores the fundamental role that data privacy and regulatory compliance play in safeguarding the integrity, confidentiality, and accessibility of the information entrusted to the Registry Platform. -== Applicable Regulations and Standards +== Applicable regulations and standards -The Registry platform has been developed according to Ukrainian national standards and data privacy laws. +The Registry platform has been developed according to Ukrainian national standards and data privacy laws. It holds the Certificate of Compliance of Comprehensive information protection system (The Ukrainian term 'КСЗІ' stands for 'Комплексна система захисту інформації'). It is the result of a state examination in the field of technical information protection. -The Registry Platform complying with key concepts of the Ukrainian Personal Data Protection Law. +The Registry Platform complying with key concepts of the Ukrainian Personal Data Protection Law. While aligning of technical controls with Ukrainian Personal Data Protection Law, The Registry Platform also has the potential to extend its compliance to the GDPR-ready state, as many of the key concepts and requirements overlap. @@ -37,11 +35,11 @@ Addititonally The Registries Platform is developed following the next security s * Center for Internet Security Software Supply Chain Security Guide (CIS SSCS) as a basis for supply chain security -== Scope of Compliance +== Scope of compliance The Registry Platform is subject to compliance with mentioned regulations and standards to ensure the secure and lawful handling of user data. This section defines the scope of compliance efforts, delineates the specific product-related responsibilities, and focuses on the platform's readiness to adhere to GDPR principles. -Platform-Specific Compliance: +Platform-Specific compliance: :: * The compliance and regulatory efforts are solely focused on the functionalities and data processing activities of the Registry Platform. Any compliance measures mentioned in this document refer exclusively to the platform's data handling capabilities. @@ -49,7 +47,7 @@ Platform-Specific Compliance: * The compliance efforts center on the protection of personal data collected, stored, processed, and transmitted within the Registry Platform. Other data processing activities within the organization (platform owner) fall outside the scope of this compliance documentation. -GDPR-Readiness: +GDPR-readiness: :: * The Registry Platform is designed with a focus on Personal Data Protection Law thus transitively on GDPR-readiness, aiming to align with the key principles and requirements of data privacy regulations. @@ -59,7 +57,7 @@ GDPR-Readiness: * The platform's compliance efforts also encompass ensuring data transparency and accountability in its data processing activities. -Exclusions: +Exclusions: :: * This compliance document does not cover target organization's (platform owner) general data protection practices or policies. It solely addresses the software part of platform's compliance scope. @@ -67,16 +65,16 @@ Exclusions: * Third-party applications, services, or integrations utilized by the product are the responsibility of their respective owners and fall outside the scope of this compliance documentation -== Data Protection Measures +== Data protection measures The Data Protection Measures implemented in the Registry Platform are designed to ensure the security, confidentiality, and integrity of personal data processed by the software. Below are the key data protection measures implemented: -=== Encryption at Rest and in Transit +=== Encryption at rest and in transit * All data is stored on encrypted file systems. For more information, please visit xref:arch:architecture/security/data-encryption-at-rest.adoc[Data encryption at rest] * Data transmitted between the software and external systems, such as APIs or user devices, is encrypted using industry-standard cryptographic protocols (e.g., TLS/SSL). For more information, please visit xref:arch:architecture/security/data-encryption-in-transit.adoc[Data encryption in transit] -=== Access Controls +=== Access controls Role-based access controls (RBAC) are implemented to restrict access to personal data based on the principle of least privilege. Access to personal data is limited to authorized personnel only, and authentication mechanisms are in place to verify users' identities. @@ -91,19 +89,19 @@ For more information, please visit: -- -=== Data Minimization and Retention +=== Data minimization and retention -The platform by itself follows the principle of data minimization. Hovewer forms and data modeling capabilities are fully owned by developers of registry regulations. Thus developers should carefully select the type and amount of information requested and collected. By doing so, they aim to limit the data collection process to the bare essentials, thereby reducing the potential risks associated with excessive data exposure. This not only safeguards user privacy but also aligns with prevailing data protection regulations that emphasize the importance of minimizing personal data processing. +The platform by itself follows the principle of data minimization. Hovewer forms and data modeling capabilities are fully owned by developers of registry regulations. Thus, developers should carefully select the type and amount of information requested and collected. By doing so, they aim to limit the data collection process to the bare essentials, thereby reducing the potential risks associated with excessive data exposure. This not only safeguards user privacy but also aligns with prevailing data protection regulations that emphasize the importance of minimizing personal data processing. -Personal data is retained only for as long as required to fulfill the intended purposes, since Registry Platform has been developed to meet a legal obligation under national legislation for govermental organizations the prolonged storage of user data is utilized. +Personal data is retained only for as long as required to fulfill the intended purposes, since Registries Platform has been developed to meet a legal obligation under national legislation for government organizations, the prolonged storage of user data is utilized. === Pseudonymization -The Registry Platform doesn't utilize pseudonymization techniques to replace identifiable information with reversible identifiers in order to reducing the risk of unauthorized access in favour of other more critical security controls. +The Registry Platform doesn't utilize pseudonymization techniques to replace identifiable information with reversible identifiers in order to reduce the risk of unauthorized access in favour of other more critical security controls. -=== Secure Development Practices +=== Secure development practices -* Secure coding guidelines are followed during the software development process to mitigate common vulnerabilities (e.g., injection attacks, cross-site scripting). +* Secure coding guidelines are followed during the software development process to mitigate common vulnerabilities, (e.g., injection attacks, cross-site scripting). * Regular code reviews and static analysis tools are employed to identify and address security weaknesses. [TIP] @@ -116,7 +114,7 @@ For more information, please visit: -- -=== Data Access Logging and Monitoring +=== Data access logging and monitoring * The platform logs all data access and processing activities, including user actions and system events. * Centralized monitoring and log analysis tools are used to detect and respond to suspicious activities and potential security incidents. @@ -131,23 +129,23 @@ For more information, please visit: -- -== User Data Processing +== User data processing === Limit collection -The Registry Platform limit the collection of PII to the minimum that is relevant, proportional and necessary for the identified purposes. It means that platform limits the amount of PII that the organization (platform owner) collects indirectly (e.g. through web logs, system logs, etc.). +The _Registries Platform_ limits the collection of PII to the minimum that is relevant, proportional and necessary for the identified purposes. It means that platform limits the amount of PII that the organization (platform owner) collects indirectly (e.g. through web logs, system logs, etc.). -The organization (platform owner) should limit the collection of PII to what is adequate, relevant and necessary in relation to the identified purposes throught the registry regulations modeling. There is only one place where personal data leave the footprint beyond the bussiness process scope is a historical data which is gathered as non-repudiation control. +The organization (platform owner) should limit the collection of PII to what is adequate, relevant and necessary in relation to the identified purposes throught the registry regulations modeling. There is only one place where personal data leave the footprint beyond the business process scope is a historical data which is gathered as non-repudiation control. === Limit processing -The Registry Platform limit the processing of PII to that which is adequate, relevant and necessary for -the identified purposes. All the personal data collected through the modeled bussiness processes processed to fulfill objectives of user-initiated request only. Default settings prioritize data protection, minimizing the processing of personal data by disabling external system integrations. All the data related to bussiness processes are transparently available for the data principal in user cabinet. +The _Registries Platform_ limits the processing of PII to that, which is adequate, relevant and necessary for +the identified purposes. All the personal data collected through the modeled business processes handled to fulfill the objectives of user-initiated request only. Default settings prioritize data protection, minimizing the processing of personal data by disabling external system integrations. All the data related to business processes are transparently available for the data principal in user portal. === Accuracy and quality -The Registry Platform ensure that PII is as accurate and complete as is necessary for the purposes for which it is processed. -In order to achieve it ambedded data validation control on bussiness process modeling stage, digital documents validation and registry regultaion changes as well. +The _Registries Platform_ ensures that PII is as accurate and complete as is necessary for the purposes for which it is processed. +In order to achieve its ambedded data validation control on business process modeling stage, digital documents validation and registry regulations' changes as well. === Temporary files @@ -159,43 +157,43 @@ The Registry Platform currently does not implement any specific data disposal ap === PII transmission controls -Transmission of PII is controlled by ensuring that only authorized systems have access to transmission systems, and by following the appropriate processes to ensure that PII is transmitted without compromise to the correct recipients. +Transmission of PII is controlled by ensuring that only authorized systems have access to transmission systems, and by following the appropriate processes to ensure that PII is transmitted without a compromise to the correct recipients. -The Registry Platform utilize secure data exchange gateway. Its a modern organizational and technical solution that allows state bodies and local self-government bodies to use secure information interdepartmental interactions via the Internet by exchanging electronic messages between their information systems. +The _Registries Platform_ utilizes secure data exchange gateway. Its a modern organizational and technical solution that allows state bodies and local self-government bodies to use secure information interdepartmental interactions via the Internet by exchanging electronic messages between their information systems. == Data Subject Rights === Right to Access and Rectification -The Registry Platform is designed to satisfy almost all requirements of organisation in terms of data processing due to extensive registry regulation development capabilities. +The Registry Platform is designed to satisfy almost all requirements of organization in terms of data processing due to extensive registry regulation development capabilities. -Registry regulation modeler can create a bussiness processes which will let the data principal to access provided information in order to satisfy right to access. +Registry regulation modeler can create a business processes which will let the data principal to access provided information in order to satisfy the right to access. -Another bussiness process can be created and designed in a way to satisfy the right for rectification. It can utilize different approaches such as data re-upload for actualisation or correction purposes. +Another business process can be created and designed in a way to satisfy the right for rectification. It can utilize different approaches such as data re-upload for actualization or correction purposes. -=== Right to Erasure (Right to be Forgotten): +=== Right to erasure (Right to be forgotten): -The Registry Platform has been developed to meet legal obligation under national legislation for govermental organizations thus the prolonged storage of user data is utilized. +The Registry Platform has been developed to meet legal obligation under national legislation for government organizations, thus the prolonged storage of user data is utilized. The platform is still subject to data protection laws and regulations, which may include provisions regarding the right to erasure. These laws outline the circumstances under which individuals can request the deletion of their personal data. -User is able to submit written erasure requests in order to trigger data erasure process. Upon receiving a valid erasure request, the organization (platform owner) assesses whether the conditions for erasure are met based on legal requirements and the specific context of the data processing. +User is able to submit written erasure requests in order to trigger a data erasure process. Upon receiving a valid erasure request, the organization (platform owner) assesses whether the conditions for erasure are met based on legal requirements and the specific context of the data processing. If the erasure request is approved, the platform administrator takes steps to delete the personal data in accordance with the applicable laws. -There is only one place where personal data leave the footprint so far is a historical data which is gathered as non-repudiation control. +There is only one place where personal data leaves the footprint so far is a historical data which is gathered as non-repudiation control. Certain exceptions may apply, such as legal obligations or public interest considerations that override the right to erasure. Organization (platform owner) must carefully balance individual rights with other legal obligations. -== Security Testing and Validation +== Security testing and validation -Security testing process is comprehensively described on xref:testing:security-testing/security-testing.adoc[Security Testing] page +The security testing process is comprehensively described on xref:testing:security-testing/security-testing.adoc[Security testing] page. // == Audit and Monitoring // * Explanation of how the software product is audited and monitored for compliance. // * Description of any internal or external audit processes. -== Training and Awareness +== Training and awareness Effective training and awareness programs play a crucial role in ensuring the responsible and secure use of the platform and the protection of personal data. It is important to emphasize that while the platform facilitates data processing and security measures, training is the responsibility of the organization (platform owner) and is not inherently built into the platform itself. \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/container-platform/nav.adoc b/docs/en/modules/arch/partials/architecture/container-platform/nav.adoc index ee1f32a462..0af80f2f52 100644 --- a/docs/en/modules/arch/partials/architecture/container-platform/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/container-platform/nav.adoc @@ -1,3 +1,3 @@ -*** xref:arch:architecture/container-platform/container-platform.adoc[Платформа оркестрації контейнерів] -**** Ключові аспекти підсистеми -***** xref:arch:architecture/container-platform/cluster_node_autoscaler.adoc[] +*** xref:arch:architecture/container-platform/container-platform.adoc[Container orchestration platform] +**** Key subsystem aspects +***** xref:arch:architecture/container-platform/cluster_node_autoscaler.adoc[Automatic horizontal scaling of cluster node instances] diff --git a/docs/en/modules/arch/partials/architecture/nav.adoc b/docs/en/modules/arch/partials/architecture/nav.adoc index a10ed327a0..d74e782183 100644 --- a/docs/en/modules/arch/partials/architecture/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/nav.adoc @@ -1,21 +1,21 @@ -** xref:arch:architecture/overview.adoc[] -*** xref:arch:architecture/platform-conceptual.adoc[] -*** xref:arch:architecture/platform-logical.adoc[] -// Архітектура безпеки Платформи +** xref:arch:architecture/overview.adoc[Architectural documentation] +*** xref:arch:architecture/platform-conceptual.adoc[Platform conceptual architecture] +*** xref:arch:architecture/platform-logical.adoc[Platform logical architecture] +*** xref:arch:architecture/platform-deployment.adoc[Platform deployment architecture] +// Системні вимоги Платформи +include::arch:partial$architecture/platform-system-requirements/nav.adoc[] +// Platform security architecture include::arch:partial$architecture/security/nav.adoc[] -//*** xref:arch:architecture/platform-asr.adoc[Архітектурно-значимі вимоги] -//*** xref:arch:architecture/platform-quality-attributes.adoc[Атрибути якості Платформи] -*** xref:arch:architecture/platform-technologies.adoc[] -//*** xref:arch:architecture/platform-deployment.adoc[Діаграма розгортання Платформи] -//*** xref:arch:architecture/registry-cost.adoc[Розрахунок вартості реєстру] -// Адміністративна зона +*** xref:arch:architecture/platform-technologies.adoc[Platform technology stack] +// Platform quality attributes +include::arch:partial$architecture/platform-quality-attributes/nav.adoc[] // Платформа оркестрації контейнерів -//include::arch:partial$architecture/container-platform/nav.adoc[] +include::arch:partial$architecture/container-platform/nav.adoc[] *** Platform subsystems // Адміністративна зона include::arch:partial$architecture/platform/administrative/nav.adoc[] // Операційна зона -//include::arch:partial$architecture/platform/operational/nav.adoc[] +include::arch:partial$architecture/platform/operational/nav.adoc[] //*** Підсистеми Реєстру // Адміністративна зона //include::arch:partial$architecture/registry/administrative/nav.adoc[] diff --git a/docs/en/modules/arch/partials/architecture/platform-system-requirements/nav.adoc b/docs/en/modules/arch/partials/architecture/platform-system-requirements/nav.adoc new file mode 100644 index 0000000000..906c6a6299 --- /dev/null +++ b/docs/en/modules/arch/partials/architecture/platform-system-requirements/nav.adoc @@ -0,0 +1,2 @@ +*** xref:arch:architecture/platform-system-requirements/overview.adoc[Platform system requirements] +**** xref:arch:architecture/platform-system-requirements/registry-cost.adoc[Calculating registry cost] \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/platform/administrative/config-management/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/administrative/config-management/nav.adoc index ba4d9f2f30..b5f41fa0eb 100644 --- a/docs/en/modules/arch/partials/architecture/platform/administrative/config-management/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/administrative/config-management/nav.adoc @@ -1,7 +1,7 @@ -***** xref:arch:architecture/platform/administrative/config-management/overview.adoc[] +***** xref:arch:architecture/platform/administrative/config-management/overview.adoc[Subsystem for deploying and configuring the Platform and registries] ****** Subsystem evolution -******* xref:arch:architecture/platform/administrative/config-management/custom-dns.adoc[] -******* xref:arch:architecture/platform/administrative/config-management/secure-endpoints.adoc[] +******* xref:arch:architecture/platform/administrative/config-management/custom-dns.adoc[Configuring custom DNS name for registry portals in OpenShift 4.x] +******* xref:arch:architecture/platform/administrative/config-management/secure-endpoints.adoc[Secure resource publishing in OpenShift 4.x cluster] ******* xref:arch:architecture/platform/administrative/config-management/gitops-administrators.adoc[Setting up Platform and registry administrators] ******* xref:arch:architecture/platform/administrative/config-management/dev-prod-deployment-mode.adoc[Platform deployment in production without registry development tools] ******* xref:arch:architecture/platform/administrative/config-management/registry-platform-keys.adoc[Updating platform and registry keys and digital signature service configuration] \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc index 373e2780f7..3a02903691 100644 --- a/docs/en/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc @@ -2,9 +2,9 @@ ****** xref:arch:architecture/platform/administrative/control-plane/configuration-structure/registry-configuration-structure.adoc[Registry configuration structure] ****** xref:arch:architecture/platform/administrative/control-plane/configuration-structure/platform-configuration-structure.adoc[Platform configuration structure] ****** Subsystem evolution -******* xref:architecture/platform/administrative/control-plane/platform-evolution/backup-schedule.adoc[Managing registry backup schedule and retention] -******* xref:architecture/platform/administrative/control-plane/platform-evolution/update-certs-without-keys.adoc[Separating digital certificate and key updating processes] -******* xref:architecture/platform/administrative/control-plane/platform-evolution/keycloak-custom-url.adoc[Configuring custom URL for Keycloak] -******* xref:architecture/platform/administrative/control-plane/platform-evolution/handling-cp-console-versions.adoc[Editing registry settings by version] +******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/backup-schedule.adoc[Managing registry backup schedule and retention] +******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/update-certs-without-keys.adoc[Separating digital certificate and key updating processes] +******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/keycloak-custom-url.adoc[Configuring custom URL for Keycloak] +******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/handling-cp-console-versions.adoc[Editing registry settings by version] ******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc[Managing settings and secrets for external integrations] ******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/demo-registry/demo-registry.adoc[Deploying a demo registry with reference modeling examples] \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/platform/administrative/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/administrative/nav.adoc index 7f26eb5609..805cde242e 100644 --- a/docs/en/modules/arch/partials/architecture/platform/administrative/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/administrative/nav.adoc @@ -1,5 +1,5 @@ -**** xref:arch:architecture/platform/administrative/overview.adoc[] +**** xref:arch:architecture/platform/administrative/overview.adoc[Platform administrative zone] // Підсистема управління Платформою та Реєстрами -//include::arch:partial$architecture/platform/administrative/control-plane/nav.adoc[] +include::arch:partial$architecture/platform/administrative/control-plane/nav.adoc[] // Підсистема розгортання змін налаштувань Платформи та Реєстрів include::arch:partial$architecture/platform/administrative/config-management/nav.adoc[] \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/platform/operational/backup-recovery/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/operational/backup-recovery/nav.adoc index d3d53c4712..6fcc7ccd16 100644 --- a/docs/en/modules/arch/partials/architecture/platform/operational/backup-recovery/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/operational/backup-recovery/nav.adoc @@ -1 +1 @@ -***** xref:arch:architecture/platform/operational/backup-recovery/overview.adoc[Підсистема резервного копіювання та відновлення] +***** xref:arch:architecture/platform/operational/backup-recovery/overview.adoc[Backup and restore subsystem] diff --git a/docs/en/modules/arch/partials/architecture/platform/operational/monitoring/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/operational/monitoring/nav.adoc index 3ab220a83b..3c8283f49a 100644 --- a/docs/en/modules/arch/partials/architecture/platform/operational/monitoring/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/operational/monitoring/nav.adoc @@ -1,5 +1,5 @@ -***** xref:arch:architecture/platform/operational/monitoring/overview.adoc[Підсистема моніторингу подій та сповіщення] -****** Ключові аспекти підсистеми -******* xref:arch:architecture/platform/operational/monitoring/multi-cluster-monitoring.adoc[Дизайн моніторингу мультикластерів Openshift] -****** Еволюція підсистеми -******* xref:arch:architecture/platform/operational/monitoring/camunda-metrics.adoc[Моніторинг загальних показників виконання бізнес-процесів] +***** xref:arch:architecture/platform/operational/monitoring/overview.adoc[Event monitoring and notification subsystem] +//****** Key subsystem aspects +//******* xref:arch:architecture/platform/operational/monitoring/multi-cluster-monitoring.adoc[Дизайн моніторингу мультикластерів Openshift] +****** Subsystem evolution +******* xref:arch:architecture/platform/operational/monitoring/camunda-metrics.adoc[Monitoring the general metrics of business process execution] diff --git a/docs/en/modules/arch/partials/architecture/platform/operational/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/operational/nav.adoc index d92dc51499..319321fc09 100644 --- a/docs/en/modules/arch/partials/architecture/platform/operational/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/operational/nav.adoc @@ -1,15 +1,15 @@ -**** xref:arch:architecture/platform/operational/overview.adoc[Операційна зона] -***** xref:arch:architecture/platform/operational/external-traffic-management/overview.adoc[Підсистема управління зовнішнім трафіком] +**** xref:arch:architecture/platform/operational/overview.adoc[Platform operational zone] +***** xref:arch:architecture/platform/operational/external-traffic-management/overview.adoc[External traffic management subsystem] // Підсистема управління користувачами та ролями include::arch:partial$architecture/platform/operational/user-management/nav.adoc[] // Підсистема управління міжсервісною взаємодією include::arch:partial$architecture/platform/operational/service-mesh/nav.adoc[] -***** xref:arch:architecture/platform/operational/secret-management/overview.adoc[Підсистема управління секретами та шифруванням] -***** xref:arch:architecture/platform/operational/logging/overview.adoc[Підсистема журналювання подій] +***** xref:arch:architecture/platform/operational/secret-management/overview.adoc[Secret and encryption management subsystem] +***** xref:arch:architecture/platform/operational/logging/overview.adoc[Event logging subsystem] // Підсистема моніторингу подій та сповіщення include::arch:partial$architecture/platform/operational/monitoring/nav.adoc[] -***** xref:arch:architecture/platform/operational/distributed-tracing/overview.adoc[Підсистема трасування запитів] -***** xref:arch:architecture/platform/operational/distributed-data-storage/overview.adoc[Підсистема розподіленого зберігання даних] -***** xref:arch:architecture/platform/operational/mail-delivery/overview.adoc[Підсистема поштових повідомлень] +***** xref:arch:architecture/platform/operational/distributed-tracing/overview.adoc[Request tracing subsystem] +***** xref:arch:architecture/platform/operational/distributed-data-storage/overview.adoc[Distributed data storage subsystem] +***** xref:arch:architecture/platform/operational/mail-delivery/overview.adoc[Email messaging subsystem] // Підсистема резервного копіювання та відновлення include::arch:partial$architecture/platform/operational/backup-recovery/nav.adoc[] \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/platform/operational/service-mesh/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/operational/service-mesh/nav.adoc index fe370fe668..0143a3befa 100644 --- a/docs/en/modules/arch/partials/architecture/platform/operational/service-mesh/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/operational/service-mesh/nav.adoc @@ -1,4 +1,4 @@ -***** xref:arch:architecture/platform/operational/service-mesh/overview.adoc[Підсистема управління міжсервісною взаємодією] -****** xref:arch:architecture/platform/operational/service-mesh/service-mesh-components.adoc[Service Mesh та компоненти Платформи та реєстрів] -****** Ключові аспекти підсистеми -******* xref:arch:architecture/platform/operational/service-mesh/istio-jwt-token-validation.adoc[Валідація JWT-токенів за допомогою Istio Envoy] \ No newline at end of file +***** xref:arch:architecture/platform/operational/service-mesh/overview.adoc[Cross-service communication management subsystem] +****** xref:arch:architecture/platform/operational/service-mesh/service-mesh-components.adoc[Service Mesh: Platform and registry components] +****** Key subsystem aspects +******* xref:arch:architecture/platform/operational/service-mesh/istio-jwt-token-validation.adoc[Validating JWT with Istio Envoy] \ No newline at end of file diff --git a/docs/en/modules/arch/partials/architecture/platform/operational/user-management/nav.adoc b/docs/en/modules/arch/partials/architecture/platform/operational/user-management/nav.adoc index b973669255..b11e2476fc 100644 --- a/docs/en/modules/arch/partials/architecture/platform/operational/user-management/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/platform/operational/user-management/nav.adoc @@ -1,24 +1,24 @@ -***** xref:arch:architecture/platform/operational/user-management/overview.adoc[Підсистема управління користувачами та ролями] -****** xref:arch:architecture/platform/operational/user-management/platform-actors-roles.adoc[Актори та ролі Платформи] -****** Еволюція підсистеми -******* Автореєстрація користувачів -******** xref:arch:architecture/platform/operational/user-management/citizen-authentication.adoc[Процес первинної автентифікації/автореєстрації громадян] -******** xref:arch:architecture/platform/operational/user-management/citizen-onboarding.adoc[Процес онбордингу громадян та управління ролями представників суб'єктів] -******** xref:arch:architecture/platform/operational/user-management/officer-auto-registration.adoc[Автоматичне створення користувачів для надавачів послуг при першій успішній автентифікації] -******** xref:arch:architecture/platform/operational/user-management/user-profile.adoc[Управління профілем користувача] -******* Автентифікація користувачів -******** xref:arch:architecture/platform/operational/user-management/id-gov-ua-flow.adoc[Аутентифікація посадових осіб через портал id.gov.ua] -******** xref:arch:architecture/platform/operational/user-management/edr-check-for-business-login.adoc[Управління перевіркою в ЕДР для автентифікації бізнес-користувачів] -******** xref:arch:architecture/platform/operational/user-management/diia-sign.adoc[Автентифікація та підпис документів за допомогою Дія.Підпису] -******** xref:arch:architecture/platform/operational/user-management/certificate-admin-login.adoc[Двофакторна автентифікація за допомогою КЕП] -******** xref:arch:architecture/platform/operational/user-management/user-relaxed-authentication.adoc[Стратегія нечіткого порівняння імені користувача при автентифікації] -******** xref:arch:architecture/platform/operational/user-management/services/ds-officer-authenticator/index.adoc[Автентифікація з допомогою КЕП] -******** xref:arch:architecture/platform/operational/user-management/authentication/cloud-sign.adoc[Використання хмарного підпису для автентифікації та підпису даних] -******** xref:arch:architecture/platform/operational/user-management/platform-evolution/registry-federation/registry-federation.adoc[Автентифікація посадових осіб, єдина для групи реєстрів завдяки ручним налаштуванням] -******* Авторизація користувачів -******** xref:arch:architecture/platform/operational/user-management/ddm-auth.adoc[] -******** xref:arch:architecture/platform/operational/user-management/auth.adoc[Розмежування прав доступу на рівні ролей] -******** xref:arch:architecture/platform/operational/user-management/registry-authz.adoc[Налаштування прав доступу до бізнес-процесів регламенту] -******** xref:arch:architecture/platform/operational/user-management/registry-roles.adoc[Ролі регламенту] -****** Сервіси підсистеми -******* xref:arch:architecture/platform/operational/user-management/keycloak/overview.adoc[Сервіс управління користувачами та ролями] +***** xref:arch:architecture/platform/operational/user-management/overview.adoc[Users and roles management subsystem] +****** xref:arch:architecture/platform/operational/user-management/platform-actors-roles.adoc[Platform actors and roles] +****** Subsystem evolution +//******* Self-registering users +//******** xref:arch:architecture/platform/operational/user-management/citizen-authentication.adoc[Процес первинної автентифікації/автореєстрації громадян] +//******** xref:arch:architecture/platform/operational/user-management/citizen-onboarding.adoc[Процес онбордингу громадян та управління ролями представників суб'єктів] +//******** xref:arch:architecture/platform/operational/user-management/officer-auto-registration.adoc[Автоматичне створення користувачів для надавачів послуг при першій успішній автентифікації] +//******** xref:arch:architecture/platform/operational/user-management/user-profile.adoc[Управління профілем користувача] +//******* Authenticating users +//******** xref:arch:architecture/platform/operational/user-management/id-gov-ua-flow.adoc[Аутентифікація посадових осіб через портал id.gov.ua] +//******** xref:arch:architecture/platform/operational/user-management/edr-check-for-business-login.adoc[Управління перевіркою в ЕДР для автентифікації бізнес-користувачів] +//******** xref:arch:architecture/platform/operational/user-management/diia-sign.adoc[Автентифікація та підпис документів за допомогою Дія.Підпису] +//******** xref:arch:architecture/platform/operational/user-management/certificate-admin-login.adoc[Двофакторна автентифікація за допомогою КЕП] +//******** xref:arch:architecture/platform/operational/user-management/user-relaxed-authentication.adoc[Стратегія нечіткого порівняння імені користувача при автентифікації] +//******** xref:arch:architecture/platform/operational/user-management/services/ds-officer-authenticator/index.adoc[Автентифікація з допомогою КЕП] +//******** xref:arch:architecture/platform/operational/user-management/authentication/cloud-sign.adoc[Використання хмарного підпису для автентифікації та підпису даних] +//******** xref:arch:architecture/platform/operational/user-management/platform-evolution/registry-federation/registry-federation.adoc[Автентифікація посадових осіб, єдина для групи реєстрів завдяки ручним налаштуванням] +******* Authorizing users +//******** xref:arch:architecture/platform/operational/user-management/ddm-auth.adoc[] +//******** xref:arch:architecture/platform/operational/user-management/auth.adoc[Розмежування прав доступу на рівні ролей] +//******** xref:arch:architecture/platform/operational/user-management/registry-authz.adoc[Налаштування прав доступу до бізнес-процесів регламенту] +******** xref:arch:architecture/platform/operational/user-management/registry-roles.adoc[Registry roles] +//****** Subsystem services +//******* xref:arch:architecture/platform/operational/user-management/keycloak/overview.adoc[Сервіс управління користувачами та ролями] diff --git a/docs/en/modules/arch/partials/architecture/security/nav.adoc b/docs/en/modules/arch/partials/architecture/security/nav.adoc index edec3e8e81..7103ea26cf 100644 --- a/docs/en/modules/arch/partials/architecture/security/nav.adoc +++ b/docs/en/modules/arch/partials/architecture/security/nav.adoc @@ -1,5 +1,5 @@ -*** xref:arch:architecture/security/overview.adoc[Security Architecture] -**** xref:arch:architecture/security/standarts-and-compliance.adoc[Standarts and compliance] +*** xref:arch:architecture/security/overview.adoc[Security architecture] +**** xref:arch:architecture/security/standards-and-compliance.adoc[Standards and compliance] **** xref:arch:architecture/security/data-classification.adoc[Data classification] **** xref:arch:architecture/security/data-encryption-at-rest.adoc[Encryption at rest] **** xref:arch:architecture/security/data-encryption-in-transit.adoc[Encryption in transit] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc b/docs/en/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc index 4e10a44066..07862aafb6 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc @@ -1,16 +1,7 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Налаштування автентифікації надавачів послуг = Configuring authentication for officers -//TODO: Which translation option is better for this case: the above one or "Configuring authentication for the officers user group"? +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] [IMPORTANT] ==== diff --git a/docs/en/modules/registry-develop/pages/registry-admin/index.adoc b/docs/en/modules/registry-develop/pages/registry-admin/index.adoc index 76bafd7d92..f2b5f6ac2b 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/index.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/index.adoc @@ -10,7 +10,7 @@ Dive deeper into the section for a comprehensive understanding facets of their p == Section overview * xref:registry-develop:registry-admin-study/registry-admin-profile.adoc[Who are the registry administrators] -* xref:registry-develop:registry-admin/cp-deploy-consent-data.adoc[Deploying demo-registry with reference examples] +* xref:registry-develop:registry-admin/cp-deploy-consent-data.adoc[Deploying demo registry with reference examples] * xref:registry-develop:registry-admin/admin-portal/overview.adoc[Administrative portal] * xref:registry-develop:registry-admin/regulations-deploy/registry-admin-introduction.adoc[Working with registry regulations in Gerrit] * xref:registry-develop:registry-admin/create-users/overview.adoc[Creating users in the system] diff --git a/docs/en/modules/testing/pages/performance-testing/performance-testing.adoc b/docs/en/modules/testing/pages/performance-testing/performance-testing.adoc index 1386199cb6..cc51959a27 100644 --- a/docs/en/modules/testing/pages/performance-testing/performance-testing.adoc +++ b/docs/en/modules/testing/pages/performance-testing/performance-testing.adoc @@ -1,14 +1,7 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Performance testing +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] == Introduction diff --git a/docs/ua/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg b/docs/ua/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg index 55fe00be9a..17feef1006 100644 --- a/docs/ua/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg +++ b/docs/ua/modules/arch/images/architecture/ddm-platform-infrastructure-deployment.drawio.svg @@ -1,4 +1,4 @@ - + -
AWS Cloud
AWS Cloud
AWS Region
AWS Region
Private bastion subnet
Private bastion subnet
OpenShift VPC 10.0.0.0/16
OpenShift VPC 10.0.0.0/16
Public OpenShift
subnet
Public OpenShift...
Route Table
Rout...
Private OpenShift
subnet
Private OpenShift...
3
3
3
3
Route Table
Rou...
3
3
3
3
N
N

Elastic IP
E...
Platform VPC 192.168.100.0/24
Platform VPC 192.168.100.0/24
Public platform subnet
Public platform subnet
KMS
KMS
Platform MinIO
Platform MinIO
Platform Vault
Platform Vault
Route Table
Rou...
Platform
Internet Gateway
Plat...
OpenShift
Internet Gateway
Open...
Unseal
Unseal
External
API NLB
Ext...
External
Router Balancer
Ext...
Internal
API NLB
Int...
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
OpenShift
Master Nodes
OpenShift...
Logging
Worker nodes
Logging...
Platform
Storage Nodes
Platform...
Platform
Nodes
Platform...
Registry
Nodes
Registry...
EBS
EBS
EBS
EBS
Elastic IPs
Elastic IPs
VPC S3
Endpoint
VPC S...
Bastion VPC
Bastion VPC
Public bastion subnet
Public bastion subnet
Route Table
Rou...
Internet
Gateway
Inte...
Route Table
Rou...

Elastic IP
E...
NAT
Gateway
NAT...
Bastion Host
Bastion...
EBS
EBS
3
3
3
3
N
N
3
3
N
N
Simple Storage
Service (S3)
Simple...
AWS Route53
AWS Route53
Програмно-апаратний
криптомодуль "Гряда"
Програмно-апаратний...
ШБО "Трембіта"
ШБО "Трембіта"
Platform
NAT Gateway
Platform...
Text is not SVG - cannot display
\ No newline at end of file +
AWS Cloud
AWS Cloud
AWS Region
AWS Region
Private bastion subnet
Private bastion subnet
OpenShift VPC 10.0.0.0/16
OpenShift VPC 10.0.0.0/16
Public OpenShift
subnet
Public OpenShift...
Route Table
Rout...
Private OpenShift
subnet
Private OpenShift...
3
3
3
3
Route Table
Rou...
3
3
3
3
N
N

Elastic IP
E...
Platform VPC 192.168.100.0/24
Platform VPC 192.168.100.0/24
Public platform subnet
Public platform subnet
KMS
KMS
Platform MinIO
Platform MinIO
Platform Vault
Platform Vault
Route Table
Rou...
Platform
Internet Gateway
Plat...
OpenShift
Internet Gateway
Open...
Unseal
Unseal
External
API NLB
Ext...
External
Router Balancer
Ext...
Internal
API NLB
Int...
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
EBS
OpenShift
Master Nodes
OpenShift...
Logging
Worker nodes
Logging...
Platform
Storage Nodes
Platform...
Platform
Nodes
Platform...
Registry
Nodes
Registry...
EBS
EBS
EBS
EBS
Elastic IPs
Elastic IPs
VPC S3
Endpoint
VPC S...
Bastion VPC
Bastion VPC
Public bastion subnet
Public bastion subnet
Route Table
Rou...
Internet
Gateway
Inte...
Route Table
Rou...

Elastic IP
E...
NAT
Gateway
NAT...
Bastion Host
Bastion...
EBS
EBS
3
3
3
3
N
N
3
3
N
N
Simple Storage
Service (S3)
Simple...
AWS Route53
AWS Route53
Програмно-апаратний
криптомодуль "Гряда"
Програмно-апаратний...
ШБО "Трембіта"
ШБО "Трембіта"
Platform
NAT Gateway
Platform...
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/ua/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc b/docs/ua/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc index d2de56d0dd..ff7fd590d8 100644 --- a/docs/ua/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc +++ b/docs/ua/modules/arch/pages/architecture/container-platform/cluster_node_autoscaler.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] - = Автоматичне горизонтальне масштабування екземплярів нод кластера +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::platform:ROOT:partial$admonitions/language-ua.adoc[] diff --git a/docs/ua/modules/arch/pages/architecture/container-platform/container-platform.adoc b/docs/ua/modules/arch/pages/architecture/container-platform/container-platform.adoc index 6c9760ec92..0dbdfec7c3 100644 --- a/docs/ua/modules/arch/pages/architecture/container-platform/container-platform.adoc +++ b/docs/ua/modules/arch/pages/architecture/container-platform/container-platform.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] - = Платформа оркестрації контейнерів +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::platform:ROOT:partial$admonitions/language-ua.adoc[] diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc index 2dfefd1799..f2fca53e73 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/overview.adoc @@ -1,4 +1,7 @@ = Атрибути якості Платформи +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-auditability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-auditability.adoc index 8fedc4363b..e9a2dbe1aa 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-auditability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-auditability.adoc @@ -1,4 +1,7 @@ = Auditability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-availability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-availability.adoc index fa7fd3f7fe..05f7b257d0 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-availability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-availability.adoc @@ -1,4 +1,7 @@ = Availability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-interoperability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-interoperability.adoc index f0059c0dac..62959fd995 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-interoperability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-interoperability.adoc @@ -1,4 +1,7 @@ = Interoperability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-observability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-observability.adoc index 29d36c0cfe..8c720e9f4d 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-observability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-observability.adoc @@ -1,4 +1,7 @@ = Observability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-operability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-operability.adoc index 1b2a6494d0..5cbd71c477 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-operability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-operability.adoc @@ -1,4 +1,7 @@ = Operability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc index dca9a2decc..84e39522db 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-performance.adoc @@ -1,4 +1,7 @@ = Performance +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-portability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-portability.adoc index 386a279f91..30d307a337 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-portability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-portability.adoc @@ -1,4 +1,7 @@ = Portability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-scalability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-scalability.adoc index 560c18b575..0bbf3af352 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-scalability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-scalability.adoc @@ -1,4 +1,7 @@ = Scalability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-security.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-security.adoc index 9ca8f6096b..bf703f0229 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-security.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-security.adoc @@ -1,4 +1,7 @@ = Security +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-verifiability.adoc b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-verifiability.adoc index a480927bde..b205b26e5d 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-verifiability.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-quality-attributes/platform-verifiability.adoc @@ -1,4 +1,7 @@ = Verifiability +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc b/docs/ua/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc index e272aa8cb0..10e62daa2e 100644 --- a/docs/ua/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform-system-requirements/registry-cost.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] - = Розрахунок вартості реєстру +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::platform:ROOT:partial$admonitions/language-ua.adoc[] @@ -15,7 +14,6 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[] * Сховище резервних копій платформи Minio * Шлюз безпечного обміну Trembita - == Типові конфігурації При розгортанні реєстру за типовими шаблонами можна орієнтуватися на наступну вартість обчислювальних ресурсів. diff --git a/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc b/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc index ce720510ee..4d729f78f4 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/custom-dns.adoc @@ -1,6 +1,5 @@ -include::ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] - = Налаштування кастомного DNS імені для кабінетів реєстру в OpenShift 4.x +include::ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::ROOT:partial$admonitions/language-ua.adoc[] diff --git a/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc b/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc index 789058e95c..2fa3e2e343 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/administrative/config-management/secure-endpoints.adoc @@ -1,6 +1,5 @@ -include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] - = Механізм безпечного опублікування ресурсів в OpenShift 4.x кластері +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::platform:ROOT:partial$admonitions/language-ua.adoc[] diff --git a/docs/ua/modules/arch/pages/architecture/platform/administrative/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/administrative/overview.adoc index 4a6e159752..5fa3af9edf 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/administrative/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/administrative/overview.adoc @@ -1,6 +1,5 @@ -include::ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] - = Адміністративна зона Платформи +include::ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::ROOT:partial$admonitions/language-ua.adoc[] @@ -8,7 +7,7 @@ include::ROOT:partial$admonitions/language-ua.adoc[] _Адміністративна зона Платформи_ - це сукупність підсистем, що забезпечують керування станом та налаштуваннями екземпляра _Платформи_ та розгорнутих на ній реєстрів за допомогою _GitOps_-підходу шляхом внесення змін у відповідні репозиторії системи контроля версій та автоматичного їх застосування. -_Підсистема управління Платформою та Реєстрами_ адміністративної зони надає веб-інтерфейси для адміністраторів, за допомогою яких можна керувати оновленням, конфігурацією, масштабуванням, резервним копіюванням, відновленням та іншими службовими функціями _Платформи_. +_Підсистема управління Платформою та Реєстрами_ адміністративної зони надає вебінтерфейс для адміністраторів, за допомогою яких можна керувати оновленням, конфігурацією, масштабуванням, резервним копіюванням, відновленням та іншими службовими функціями _Платформи_. [TIP] -- diff --git a/docs/ua/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc index caa1091ada..4e9b9f5af3 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/operational/backup-recovery/overview.adoc @@ -1,4 +1,7 @@ = Підсистема резервного копіювання та відновлення +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc index 5edd5427e2..8153c28930 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-data-storage/overview.adoc @@ -1,4 +1,7 @@ = Підсистема розподіленого зберігання даних +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc index 3dc83984cb..cf4f545c0b 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/operational/distributed-tracing/overview.adoc @@ -1,4 +1,7 @@ = Підсистема трасування запитів +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис @@ -72,7 +75,7 @@ image::architecture/platform/operational/distributed-tracing/distributed-tracing == Технологічний стек -При проектуванні та розробці підсистеми, були використані наступні технології: +При проєктуванні та розробці підсистеми, були використані наступні технології: * xref:arch:architecture/platform-technologies.adoc#jaeger[Jaeger] * xref:arch:architecture/platform-technologies.adoc#elasticsearch[ElasticSearch] @@ -85,12 +88,12 @@ _Підсистема трасування запитів_ забезпечує реєстрів спостерігати продуктивність, виявляти аномалії та ідентифікувати можливі проблеми при експлуатації Платформи. === _Performance_ -_Підсистема трасування запитів_ надає низькопомітну інструментальну підтримку трейсінгу та ефективне зберігання та +_Підсистема трасування запитів_ надає низькопомітну інструментальну підтримку трейсингу та ефективне зберігання та індексування даних, що дозволяє проводити високопродуктивний моніторинг запитів в Платформі не витрачаючи зайві обчислювальні ресурси. === _Scalability_ -_Підсистема трасування запитів_ розроблена з урахуванням великих обсягів даних трейсінгу, з підтримкою горизонтальної +_Підсистема трасування запитів_ розроблена з урахуванням великих обсягів даних трейсингу, з підтримкою горизонтальної масштабованості та розподіленого зберігання даних. === _Security_ @@ -98,8 +101,8 @@ _Підсистема трасування запитів_ розроблена Користувацький інтерфейс захищений додатковим проксі компонентом який разом з централізованою xref:architecture/platform/operational/user-management/overview.adoc[підсистемою управління користувачами та ролями] відповідає за надання доступу та розмежування прав. За замовчуванням користувачу надаються мінімальні права необхідні для виконання поставлених завдань. -Присутній механізм обмеження доступу до інтерфейсу який в свою чергу мінімізує поверхню атаки підсистеми ззовні. +Присутній механізм обмеження доступу до інтерфейсу який своєю чергою мінімізує поверхню атаки підсистеми ззовні. -Усі події всередині підсистеми логуютсья та доступні для подальшого аналізу при потребі xref:arch:architecture/platform/operational/logging/overview.adoc[підсистемою журналювання подій]. +Усі події всередині підсистеми логуються та доступні для подальшого аналізу при потребі xref:arch:architecture/platform/operational/logging/overview.adoc[підсистемою журналювання подій]. -Підсистема не має доступу до та не зберігає чутливі дані. +Підсистема не має доступу до чутливих даних та не зберігає їх. diff --git a/docs/ua/modules/arch/pages/architecture/platform/operational/logging/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/operational/logging/overview.adoc index 9c7521d157..49e6e11a25 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/operational/logging/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/operational/logging/overview.adoc @@ -1,4 +1,5 @@ = Підсистема журналювання подій +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::platform:ROOT:partial$admonitions/language-ua.adoc[] diff --git a/docs/ua/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc index 77e90d7660..2ff973c545 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/operational/mail-delivery/overview.adoc @@ -1,4 +1,7 @@ = Підсистема поштових повідомлень +include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc b/docs/ua/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc index 15db2f394f..40fa9e0c1c 100644 --- a/docs/ua/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/platform/operational/monitoring/overview.adoc @@ -1,4 +1,7 @@ = Підсистема моніторингу подій та сповіщення +include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc b/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc index acd8b292b8..3458f56b58 100644 --- a/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc +++ b/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc @@ -6,7 +6,7 @@ _Регламент реєстру_ - це цифрове представлен _Регламент реєстру_ разом з _операційною конфігурацією реєстру_ складають необхідний та достатній опис функціональних можливостей, які реалізує реєстр та налаштувань для забезпечення відповідного рівня якості їх надання кінцевим користувачам. -_Платформа Реєстрів_ реалізує _Low-code_ підхід до розробки цифрового регламенту за допомогою службових веб-інтерфейсів xref:arch:architecture/registry/administrative/regulation-management/overview.adoc[Підсистеми моделювання регламенту реєстру]. Регламент реєстру разом з історією змін зберігається у відповідному репозиторії системи контролю версій _Git_ (_Gerrit_) екземпляра реєстру на _Платформі_ задля забезпечення вимог аудиту та можливості відновлення до попередніх версій. +_Платформа Реєстрів_ реалізує _Low-code_ підхід до розробки цифрового регламенту за допомогою службових вебінтерфейсів xref:arch:architecture/registry/administrative/regulation-management/overview.adoc[Підсистеми моделювання регламенту реєстру]. Регламент реєстру разом з історією змін зберігається у відповідному репозиторії системи контролю версій _Git_ (_Gerrit_) екземпляра реєстру на _Платформі_ задля забезпечення вимог аудиту та можливості відновлення до попередніх версій. За валідацію, автоматизоване тестування та застосування змін регламенту до сервісів _Операційної зони_ екземпляра реєстру відповідає xref:arch:architecture/registry/administrative/regulation-publication/overview.adoc[]. diff --git a/docs/ua/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc b/docs/ua/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc index 6de7776985..94b0960ed3 100644 --- a/docs/ua/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc +++ b/docs/ua/modules/arch/pages/architecture/registry/operational/ext-systems-simulation/custom-mocking-wiremock.adoc @@ -47,7 +47,7 @@ image::arch:architecture/registry/operational/ext-systems-simulation/mocking/cur .Налаштування конфігурації моку зовнішньої точки інтеграції image::arch:architecture/registry/operational/ext-systems-simulation/mocking/enable-mocking-flow.svg[enable-mocking] -Важливо відзначити, що після збереження конфігурації відбувається виконнаня флоу яке описане в рамках дизайну xref:arch:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc#_технічний_дизайн_рішення[Управління налаштуваннями та секретами зовнішніх інтеграцій] з врахуванням наступних ремарок: +Важливо відзначити, що після збереження конфігурації відбувається виконнаня флоу яке описане в рамках дизайну xref:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc#_технічний_дизайн_рішення[Управління налаштуваннями та секретами зовнішніх інтеграцій] з врахуванням наступних ремарок: * [#required-changes]#Якщо користувач хоче замокувати зовнішню REST систему (не Трембіту) яка була створена - необхідно видалити service entry для неї# * Якщо користувач хоче додати мок зовнішньої REST системи - необхідно створити секрет без service entry diff --git a/docs/ua/modules/arch/pages/architecture/security/data-integrity.adoc b/docs/ua/modules/arch/pages/architecture/security/data-integrity.adoc index 3056bb4c8e..59eeeffb13 100644 --- a/docs/ua/modules/arch/pages/architecture/security/data-integrity.adoc +++ b/docs/ua/modules/arch/pages/architecture/security/data-integrity.adoc @@ -11,7 +11,7 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Класифікація та ідентифікація даних -Ідентифікація та класифікація даних на платформі доступна за xref:arch:architecture/security/data-classification.adoc[посиланням] +Ідентифікація та класифікація даних на Платформі доступна на сторінці xref:arch:architecture/security/data-classification.adoc[]. == Заходи інформаційної безпеки diff --git a/docs/ua/modules/arch/pages/architecture/security/overview.adoc b/docs/ua/modules/arch/pages/architecture/security/overview.adoc index ae71271715..9d59d4bacf 100644 --- a/docs/ua/modules/arch/pages/architecture/security/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/security/overview.adoc @@ -25,11 +25,11 @@ _Безпека_ — це показник здатності системи з == Розділи технічній документації -* xref:arch:architecture/security/data-classification.adoc[] - визначення та встановлення рівня конфіденційності, цілісності та доступності даних залежно від їх важливості, чутливості та потенційного впливу на організацію або платформу. -* xref:arch:architecture/security/data-encryption-at-rest.adoc[] - опис криптографічних механізмів платформи перетворення даних в незрозумілий для несанкціонованого доступу формат з метою захисту конфіденційності та запобігання несанкціонованому доступу до цих даних під час їх зберігання. -* xref:arch:architecture/security/data-encryption-in-transit.adoc[] - опис криптографічних механізмів платформи перетворення даних в незрозумілу форму з метою забезпечення їх конфіденційності та захисту від несанкціонованого доступу під час передачі по мережі. -* xref:arch:architecture/security/data-retention.adoc[] - опис процедур та технічних заходів, що регулюють тривалість зберігання даних на платформі з метою забезпечення вимог законодавства, внутрішніх правил або бізнес-потреб. -* xref:arch:architecture/security/secret-management.adoc[] - документація стосовно використання, обігу та гарантування безпеки ключів доступу всередині платформи. -* xref:arch:architecture/security/access-control.adoc[] - механізми контролю та регулювання доступу до ресурсів, систем, даних та інших активів платформи з метою забезпечення конфіденційності, цілісності та доступності інформації а також механізми контролю життєвого циклу користувачів та сутностей. -* xref:arch:architecture/security/data-integrity.adoc[] - опис процесу забезпечення правдивості, недоступності змін та цілісності даних, систем, процесів платформи. +* xref:arch:architecture/security/data-classification.adoc[] -- визначення та встановлення рівня конфіденційності, цілісності та доступності даних залежно від їх важливості, чутливості та потенційного впливу на організацію або платформу. +* xref:arch:architecture/security/data-encryption-at-rest.adoc[] -- опис криптографічних механізмів платформи перетворення даних в незрозумілий для несанкціонованого доступу формат з метою захисту конфіденційності та запобігання несанкціонованому доступу до цих даних під час їх зберігання. +* xref:arch:architecture/security/data-encryption-in-transit.adoc[] -- опис криптографічних механізмів платформи перетворення даних в незрозумілу форму з метою забезпечення їх конфіденційності та захисту від несанкціонованого доступу під час передачі мережею. +* xref:arch:architecture/security/data-retention.adoc[] -- опис процедур та технічних заходів, що регулюють тривалість зберігання даних на платформі з метою забезпечення вимог законодавства, внутрішніх правил або бізнес-потреб. +* xref:arch:architecture/security/secret-management.adoc[] -- документація стосовно використання, обігу та гарантування безпеки ключів доступу всередині платформи. +* xref:arch:architecture/security/access-control.adoc[] -- механізми контролю та регулювання доступу до ресурсів, систем, даних та інших активів платформи з метою забезпечення конфіденційності, цілісності та доступності інформації, а також механізми контролю життєвого циклу користувачів та сутностей. +* xref:arch:architecture/security/data-integrity.adoc[] -- опис процесу забезпечення правдивості, недоступності змін та цілісності даних, систем, процесів платформи. * xref:arch:architecture/security/secure-design-principles.adoc[] - опис принципів, які застосовуються у процесі проектування та розробки з ціллю забезпечення вимог безпеки. \ No newline at end of file diff --git a/docs/ua/modules/arch/pages/architecture/security/secret-management.adoc b/docs/ua/modules/arch/pages/architecture/security/secret-management.adoc index 8f45eed38f..32dfa4f563 100644 --- a/docs/ua/modules/arch/pages/architecture/security/secret-management.adoc +++ b/docs/ua/modules/arch/pages/architecture/security/secret-management.adoc @@ -5,9 +5,9 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис -Керування секретами на платформі включає в себе методи та процедури для безпечного створення, зберігання та обробки конфіденційних даних, таких як паролі, ключі та інші важливі відомості. Ця практика відіграє важливу роль у гарантуванні недоступності таких даних для неуповноважених осіб, що забезпечує захист інформації, уникнення можливих витоків та підвищення довіри до безпеки платформи та її користувачів. +Керування секретами на Платформі включає методи та процедури для безпечного створення, зберігання та обробки конфіденційних даних, таких як паролі, ключі та інші важливі відомості. Ця практика відіграє важливу роль у гарантуванні недоступності таких даних для неуповноважених осіб, що забезпечує захист інформації, уникнення можливих витоків та підвищення довіри до безпеки платформи та її користувачів. -== Принципи Керування Секретами +== Принципи керування секретами // - Принципи безпеки для зберігання та обробки секретів // - Принцип "найдавнішого доступу" та принцип "принципу найменшого доступу" diff --git a/docs/ua/modules/arch/pages/architecture/security/secure-design-principles.adoc b/docs/ua/modules/arch/pages/architecture/security/secure-design-principles.adoc index 6a234373c4..5afe22746a 100644 --- a/docs/ua/modules/arch/pages/architecture/security/secure-design-principles.adoc +++ b/docs/ua/modules/arch/pages/architecture/security/secure-design-principles.adoc @@ -1,79 +1,83 @@ -= Принципи Безпечного Дизайну += Принципи безпечного дизайну include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] -include::platform:ROOT:partial$admonitions/language-ua.adoc[] +//include::platform:ROOT:partial$admonitions/language-ua.adoc[] -== Мінімізація площини атак (Minimise attack surface area): +Ця сторінка присвячена ключовим принципам безпеки інформаційних систем. Вона допоможе читачам зрозуміти важливість мінімізації площини атак, встановлення безпечних налаштувань за замовчуванням, а також дотримання принципів, таких як принцип найменших привілеїв, захист на всіх рівнях та інші. Крім того, розглядаються підходи до обробки помилок, інтеракції з зовнішніми сервісами, розділення обов'язків та аудиту системи. + +_Основна мета_ -- надати чітке розуміння того, як підтримувати безпеку на високому рівні та уникати поширених пасток у сфері інформаційної безпеки. + +== Мінімізація площини атак (Minimise attack surface area) Цей принцип передбачає зменшення площини атак, тобто зниження кількості можливих місць, через які можливий злом системи або додатка. Це досягається шляхом обмеження функцій, служб і привілеїв до необхідного мінімуму, щоб знизити ризики зовнішніх атак та зломів. - - [ ] Перевірити, чи тільки необхідні служби та порти відкриті на серверах. - - [ ] Вимкнути або деактивувати зайві або непотрібні функції та сервіси. - - [ ] Перевірити та обмежити доступ до даних та функцій тільки для авторизованих користувачів. +- [ ] Перевірити, чи тільки необхідні служби та порти відкриті на серверах. +- [ ] Вимкнути або деактивувати зайві або непотрібні функції та сервіси. +- [ ] Перевірити та обмежити доступ до даних та функцій тільки для авторизованих користувачів. -== Встановлення безпечних значень за замовчуванням (Establish secure defaults): +== Встановлення безпечних значень за замовчуванням (Establish secure defaults) Цей принцип передбачає встановлення безпечних налаштувань та параметрів за замовчуванням для системи або додатка. Це допомагає уникнути небезпечних або слабких налаштувань, які можуть стати вразливістьми, які використовуються зловмисниками. - - [ ] Перевірити, що всі налаштування за замовчуванням є безпечними та не створюють потенційних ризиків. - - [ ] Відключити або заборонити всі ненадійні функції або послуги за замовчуванням. - - [ ] Застосувати сильні паролі та налаштування шифрування за замовчуванням. +- [ ] Перевірити, що всі налаштування за замовчуванням є безпечними та не створюють потенційних ризиків. +- [ ] Відключити або заборонити всі ненадійні функції або послуги за замовчуванням. +- [ ] Застосувати сильні паролі та налаштування шифрування за замовчуванням. -== Принцип найменших привілеїв (The principle of Least privilege): +== Принцип найменших привілеїв (The principle of Least privilege) Цей принцип передбачає те, що кожен користувач або компонент системи повинен мати доступ лише до необхідних ресурсів та прав. Забезпечення лише обмеженого доступу, необхідного для виконання своїх обов'язків, допомагає зменшити ризик несанкціонованого доступу і розповсюдження даних. - - [ ] Перевірити та обмежити привілеї користувачів та компонент системи тільки до тих даних та операцій, які вони повинні мати доступ. - - [ ] Визначити рівні доступу для різних користувачів та груп користувачів з урахуванням їхніх обов'язків та ролей. - - [ ] Обмеження прав доступу повинно бути реалізовано на основі потреби, а не за замовчуванням. +- [ ] Перевірити та обмежити привілеї користувачів та компонент системи тільки до тих даних та операцій, які вони повинні мати доступ. +- [ ] Визначити рівні доступу для різних користувачів та груп користувачів з урахуванням їхніх обов'язків та ролей. +- [ ] Обмеження прав доступу повинно бути реалізовано на основі потреби, а не за замовчуванням. -== Принцип захисту на всіх рівнях (The principle of Defence in depth): +== Принцип захисту на всіх рівнях (The principle of Defence in depth) Цей принцип передбачає застосування кількох шарів захисту на різних рівнях інформаційної системи. Шляхом використання різноманітних контролів та заходів безпеки, які доповнюють один одного, забезпечується більший рівень безпеки та опіки над інформацією. - - [ ] Встановити брандмауери та фільтри, щоб контролювати вхідний та вихідний трафік. - - [ ] Використовувати механізми шифрування для захисту даних під час передачі та зберігання. - - [ ] Застосувати системи виявлення та захисту від вторгнень (IDS/IPS) для реагування на вразливості та атаки. +- [ ] Встановити брандмауери та фільтри, щоб контролювати вхідний та вихідний трафік. +- [ ] Використовувати механізми шифрування для захисту даних під час передачі та зберігання. +- [ ] Застосувати системи виявлення та захисту від вторгнень (IDS/IPS) для реагування на вразливості та атаки. -== Безпечна обробка помилок (Fail securely): +== Безпечна обробка помилок (Fail securely) -Цей принцип передбачає правильну обробку помилок та непередбачених ситуацій в програмному забезпеченні. При виникненні помилок або відмов система повинна бути спроектована таким чином, щоб забезпечити безпечне відновлення та відновлення роботи без витоку інформації. +Цей принцип передбачає правильну обробку помилок та непередбачених ситуацій в програмному забезпеченні. При виникненні помилок або відмов система повинна бути спроєктована таким чином, щоб забезпечити безпечне відновлення та відновлення роботи без витоку інформації. - - [ ] Забезпечити правильну обробку та відображення помилок на клієнтській стороні без розкриття конфіденційної інформації. - - [ ] Записувати деталі помилок у логи на сервері для подальшого аналізу та виправлення. - - [ ] Встановити механізми виявлення та автоматичного відновлення системи після непередбачених помилок. +- [ ] Забезпечити правильну обробку та відображення помилок на клієнтській стороні без розкриття конфіденційної інформації. +- [ ] Записувати деталі помилок у логи на сервері для подальшого аналізу та виправлення. +- [ ] Встановити механізми виявлення та автоматичного відновлення системи після непередбачених помилок. -== Недовіра до зовнішніх сервісів (Don’t trust services): +== Недовіра до зовнішніх сервісів (Don’t trust services) -Цей принцип вказує на те, що додатки і системи не повинні довіряти зовнішнім сервісам і джерелам даних без перевірки. Потрібно передбачати механізми перевірки достовірності інформації, що надходить від зовнішніх джерел. +Цей принцип вказує на те, що додатки й системи не повинні довіряти зовнішнім сервісам і джерелам даних без перевірки. Потрібно передбачати механізми перевірки правдивості інформації, що надходить від зовнішніх джерел. - - [ ] Перевірити дані, що надходять від зовнішніх сервісів, на валідність та правильність. - - [ ] Застосувати механізми перевірки достовірності та автентифікації до кожного зовнішнього сервісу. +- [ ] Перевірити дані, що надходять від зовнішніх сервісів, на валідність та правильність. +- [ ] Застосувати механізми перевірки правдивості та автентифікації до кожного зовнішнього сервісу. -== Розділення обов'язків (Separation of duties): +== Розділення обов'язків (Separation of duties) Цей принцип передбачає розподіл повноважень між різними особами чи ролями в організації. Це допомагає уникнути конфлікту інтересів та недобросовісних дій, забезпечуючи контроль і збалансованість в доступі до ресурсів. - - [ ] Визначити різні ролі та обов'язки в системі та забезпечити, щоб кожна роль виконувала лише свої функції. - - [ ] Обмежити можливість одночасного виконання конфліктуючих обов'язків однією особою або роллю. +- [ ] Визначити різні ролі та обов'язки в системі та забезпечити, щоб кожна роль виконувала лише свої функції. +- [ ] Обмежити можливість одночасного виконання конфліктних обов'язків однією особою або роллю. -== Уникання безпеки через прихованість (Avoid security by obscurity): +== Уникання безпеки через прихованість (Avoid security by obscurity) Цей принцип застерігає від залежності безпеки системи або додатка від того, що деталі їхньої реалізації є прихованими або неявними. Замість цього, потрібно покладатися на відкриті та встановлені методи захисту. - - [ ] Застосовувати стандартні та відкриті криптографічні алгоритми та протоколи. - - [ ] Не приховувати деталі реалізації системи або механізмів безпеки від команди розробників та тестувальників. +- [ ] Застосовувати стандартні та відкриті криптографічні алгоритми та протоколи. +- [ ] Не приховувати деталі реалізації системи або механізмів безпеки від команди розробників та тестувальників. -== Простота безпеки (Keep security simple): +== Простота безпеки (Keep security simple) Цей принцип підкреслює важливість простоти та зрозумілості механізмів безпеки. Складні системи та рішення часто призводять до помилок і вразливостей, тому краще використовувати прості та ефективні методи. - - [ ] Використовувати прості та зрозумілі методи захисту та шифрування. - - [ ] Не дублювати складні та заплутані механізми безпеки, які можуть стати джерелом помилок. +- [ ] Використовувати прості та зрозумілі методи захисту та шифрування. +- [ ] Не дублювати складні та заплутані механізми безпеки, які можуть стати джерелом помилок. == Принцип аудиту та моніторингу (Audit and Monitoring) Запровадження механізмів аудиту та моніторингу, які дозволяють виявляти і реагувати на події безпеки, включаючи незвичайні активності та спроби злому. - - [ ] Запровадження механізмів аудиту та моніторингу для виявлення та реагування на події безпеки. - - [ ] Виявлення незвичайних активностей та спроб злому. +- [ ] Запровадження механізмів аудиту та моніторингу для виявлення та реагування на події безпеки. +- [ ] Виявлення незвичайних активностей та спроб злому. diff --git a/docs/ua/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc b/docs/ua/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc index e609f8ad41..79890840d9 100644 --- a/docs/ua/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc +++ b/docs/ua/modules/arch/partials/architecture/platform/administrative/control-plane/nav.adoc @@ -6,6 +6,6 @@ ******* xref:architecture/platform/administrative/control-plane/platform-evolution/update-certs-without-keys.adoc[Розділення процесу оновлення сертифікатів надавачів послуг та процесу оновлення ключів] ******* xref:architecture/platform/administrative/control-plane/platform-evolution/keycloak-custom-url.adoc[Конфігурація Custom URL для сервісу управління користувачами та ролями Keycloak] ******* xref:architecture/platform/administrative/control-plane/platform-evolution/handling-cp-console-versions.adoc[Надання можливості редагувати параметри реєстру в залежності від його версії] -******* xref:arch:architecture/platform/administrative/control-plane/registry-regulation-secrets.adoc[Управління налаштуваннями та секретами зовнішніх інтеграцій] +******* xref:architecture/platform/administrative/control-plane/platform-evolution/registry-regulation-secrets.adoc[Управління налаштуваннями та секретами зовнішніх інтеграцій] ******* xref:arch:architecture/platform/administrative/control-plane/platform-evolution/demo-registry/demo-registry.adoc[Розгортання демо реєстру з прикладами як правильно моделювати бізнес-процеси] ******* xref:architecture/platform/administrative/control-plane/platform-evolution/single-registry-template.adoc[Мінімізація кількості шаблонів розгортання реєстру] diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc index 90c1e71f34..ad74c05bc8 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/cp-auth-setup/cp-auth-setup-officers.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[] [IMPORTANT] ==== diff --git a/docs/ua/modules/testing/pages/performance-testing/performance-testing.adoc b/docs/ua/modules/testing/pages/performance-testing/performance-testing.adoc index cec5fd5cbb..be214cd6dd 100644 --- a/docs/ua/modules/testing/pages/performance-testing/performance-testing.adoc +++ b/docs/ua/modules/testing/pages/performance-testing/performance-testing.adoc @@ -1,14 +1,7 @@ -:toc-title: На цій сторінці -:toc: auto -:toclevels: 5 -:experimental: -: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[] == Вступ @@ -38,7 +31,7 @@ == Тактика продуктивності -Тактика продуктивності - це методики та стратегії оптимізації продуктивності сервісів платформи. Ці тактики адресують різні аспекти продуктивності системи, включаючи час відповіді сервісів, пропускну спроможність, використання ресурсів, масштабованість та стабільність. Нижче наведено список тактик, які використовуються для оптимізації продуктивності платформи. +Тактика продуктивності -- це методики та стратегії оптимізації продуктивності сервісів платформи. Ці тактики адресують різні аспекти продуктивності системи, включаючи час відповіді сервісів, пропускну спроможність, використання ресурсів, масштабованість та стабільність. Нижче наведено список тактик, які використовуються для оптимізації продуктивності платформи. === Контроль над навантаженням на ресурси