Skip to content

Commit

Permalink
[EDP-DDM-28658] github: updated docs, fixed diagram, removed old comm…
Browse files Browse the repository at this point in the history
…ents

Change-Id: Ie7ffcb1c748ab3a459ccdccb1806a193c64c3b5f
(cherry picked from commit c6b187a03094d2a2fe479116faa5f76961d12b0b)
  • Loading branch information
[email protected] committed Oct 5, 2023
1 parent 9508752 commit 6a9202d
Show file tree
Hide file tree
Showing 9 changed files with 91 additions and 378 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,105 +5,82 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[]

== Overview

//Підсистема, призначенням якої є управління зовнішнім трафіком та контроль доступу до API-сервісів операційної зони Реєстру.
The subsystem is designed to manage external traffic and control access to API services of the registry operational zone.

== Subsystem functions

//* Аутентифікація та авторизація запитів
// зони реєстру
//* Налаштування та контроль рейт-лімітів
//* Трансформація запитів та відповідей
//* Логування вхідних запитів
* Authentication and authorization of requests
* Traffic routing to API services of the registry operational zone subsystems
* Configuration and control of rate limits
* Transformation of requests and responses
* Logging of incoming requests

//== Технічний дизайн підсистеми
== Technical design of the subsystem
== Subsystem technical design

image::architecture/registry/operational/ext-api-management/registry-ext-traffic-subsystem.drawio.svg[width=600,float="center",align="center"]

//== Складові підсистеми
[#subsystem-components]
== Subsystem components

|===
//|Назва компоненти|Представлення в реєстрі|Походження|Репозиторій|Призначення
|Component name|Presentation in the registry|Origin|Repository|Purpose

//|_Зовнішній API-шлюз операційної зони_
|_Registry operational zone external API gateway_
|`kong-kong`
|3rd-party
|https://github.com/epam/edp-ddm-kong[github:/epam/edp-ddm-kong]
//|Забезпечує керування трафіком, авторизацію, контроль доступу до API, балансування навантаження, перетворення запитів/відповідей та аналітику/моніторинг.
|Provides traffic management, authorization, API access control, load balancing, request/response transformation, and analytics/monitoring.

//|_ServiceMesh шлюз_
|_ServiceMesh gateway_
|`istio-ingressgateway`
|3rd-party
|https://github.com/istio/proxy[github:/istio/proxy]
//|Мережевий шлюз що працює на межі istio service-mesh та отримує вхідні з'єднання HTTP/TCP.
|Network gateway operating on the edge of the Istio service
-mesh, receiving incoming HTTP/TCP connections.
|Network gateway operating on the edge of the Istio service-mesh, receiving incoming HTTP/TCP connections.

//|xref:arch:architecture/registry/operational/ext-api-management/redis-storage.adoc#_sessions[__Операційне сховище сесій користувача__]
|xref:arch:architecture/registry/operational/ext-api-management/redis-storage.adoc#_sessions[__Operational user sessions storage__]
|`redis:sessions`
|3rd-party
|-
//|Зберігання користувацьких JWT-токенів
|Storage of user JWT tokens
|===

//== Технологічний стек
== Technological stack
== Technology stack

//При проектуванні та розробці підсистеми, були використані наступні технології:
The following technologies were used in the design and development of the subsystem:

* xref:arch:architecture/platform-technologies.adoc#kong[Kong]
* xref:arch:architecture/platform-technologies.adoc#kong-ingress-controller[Kong Ingress Controller]
* xref:arch:architecture/platform-technologies.adoc#redis[Redis]
* xref:arch:architecture/platform-technologies.adoc#istio[Istio ServiceMesh]

//== Атрибути якості підсистеми
== Subsystem quality attributes
=== _Scalability_

//Підсистема управління зовнішнім трафіком операційної зони реєстру підтримує як горизонтальне, так і вертикальне масштабування.
The external traffic management subsystem of the registry operational zone supports both horizontal and vertical scalability.
[TIP]
--
//Детальніше з масштабуванням підсистем можна ознайомитись у розділі
For more details on subsystem scalability, please refer to
xref:architecture/container-platform/container-platform.adoc[]
--

=== _Observability_
//Підсистема управління зовнішнім трафіком операційної зони реєстру підтримує журналювання вхідних запитів та збір метрик продуктивності для подальшого аналізу через веб-інтерфейси відповідних підсистем Платформи.

The external traffic management subsystem of the registry operational zone supports logging of incoming requests and collects performance metrics for further analysis through web interfaces of the corresponding Platform subsystems.

[TIP]
--
//Детальніше з дизайном підсистем можна ознайомитись у відповідних розділах:
For more details on subsystem design, please refer to the relevant sections:

* xref:arch:architecture/platform/operational/logging/overview.adoc[]
* xref:arch:architecture/platform/operational/monitoring/overview.adoc[]
--

=== _Portability_
//Підсистема управління зовнішнім трафіком операційної зони реєстру може бути перенесена, розгорнута та керована однаково та надійно на різних платформах оркестрації контейнерів що розгорнуті в різних хмарних середовищах або власній інфраструктурі в дата-центрі.

The external traffic management subsystem of the registry operational zone can be easily transported, deployed, and reliably managed across different container orchestration platforms in various cloud environments or in proprietary infrastructure within data centers.

[TIP]
--
//Детальніше можна ознайомитись у розділі xref:arch:architecture/container-platform/container-platform.adoc[Платформа оркестрації контейнерів]
For more details, please refer to
xref:arch:architecture/container-platform/container-platform.adoc[Container orchestration platform]
--
For more details, please refer to the
xref:arch:architecture/container-platform/container-platform.adoc[Container orchestration platform].
--
Original file line number Diff line number Diff line change
@@ -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[]

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

Expand All @@ -35,7 +19,6 @@
====

////
TODO: Need this section?
Перелік компонентів реєстру, для яких налаштовується резервне копіювання за розкладом та час зберігання резервних копій: ::
* [*] [.underline]#Портал управління бізнес-процесами реєстру# -- компонент `*bp-admin-portal*`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,29 +1,7 @@
:toc-title: ЗМІСТ
:toc: auto
:toclevels: 5
:experimental:
:important-caption: ВАЖЛИВО
:note-caption: ПРИМІТКА
:tip-caption: ПІДКАЗКА
:warning-caption: ПОПЕРЕДЖЕННЯ
:caution-caption: УВАГА
:example-caption: Приклад
:figure-caption: Зображення
:table-caption: Таблиця
:appendix-caption: Додаток
:sectnums:
:sectnumlevels: 5
:sectanchors:
:sectlinks:
:partnums:

// Use this to make a text bold: +++<b style="font-weight: 600">Компонент для розробки регламенту<b>+++
// Use this to make a text bold and code:
//Option 1: `+++<b style="font-weight: 600">Компонент для розробки регламенту<b>+++`
//Option 2: Use this to make a text bold and code: +++<b style="font-weight: 600"><code>Підтвердити</code><b>+++
//Option 3: `+++<font style="font-weight: bold">Створити новий</font>+++`

= Розгортання екземпляра реєстру
include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[]

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

Після успішного xref:installation/platform-deployment/platform-deployment-overview.adoc[встановлення Платформи на цільовому оточенні], адміністратор Платформи отримує доступ до адміністративної панелі, що має назву *Control Plane*. Вона дозволяє керувати конфігураціями інфраструктурних компонентів Платформи (`cluster-mgmt`), а також компонентів реєстру.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ image:registry-management/registry-edit/cp-edit-registry-2.png[]
. Знайдіть розділ +++<b style="font-weight: 600">Реєстри</b>+++ та відкрийте необхідний.
+
На цій сторінці ви можете побачити 2 основні вкладки:

+
[tabs]
====
Інформація про реєстр::
Expand Down
Original file line number Diff line number Diff line change
@@ -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[]

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

Expand Down Expand Up @@ -245,18 +229,4 @@ image:admin:user-management/user-management-44.png[]
* xref:registry-develop:study-project/index.adoc[]
* xref:admin:registry-management/control-plane-assign-platform-admins.adoc[]
* xref:admin:registry-management/control-plane-edit-registry.adoc[]
* xref:admin:update/update-registry-components.adoc[]

////
KeyCloak:gerrit-administrators
KeyCloak:camunda-admin
KeyCloak:redash-admin
jKeyCloak:jenkins-users (за запитом Адміністратор користувачів може надати jenkins-admin)
KeyCloak:nexus-user
////

<<<
* xref:admin:update/update-registry-components.adoc[]

0 comments on commit 6a9202d

Please sign in to comment.