Skip to content

Commit

Permalink
[EDP-DDM-28658] github: issue 19, removed old note in ua, removed com…
Browse files Browse the repository at this point in the history
…ments in en version for edit-data-model-tables.adoc, added minor fixes

Change-Id: I53dc297ef39bc81552da3d6c37de85a4d6bee66e
(cherry picked from commit c50dbf601d0071d35f2787600550ea9df4ff503f)
  • Loading branch information
[email protected] committed Sep 25, 2023
1 parent c331c3e commit dfcf0f5
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 142 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,24 @@ 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.

//_Підсистема управління Платформою та Реєстрами_ адміністративної зони надає веб-інтерфейси для адміністраторів, за допомогою яких можна керувати оновленням, конфігурацією, масштабуванням, резервним копіюванням, відновленням та іншими службовими функціями _Платформи_.
_The Platform and registries management subsystem_ in the administrative zone offers web interfaces for administrators to manage updates, configurations, scalability, backup, restoration, and other service functions.

[TIP]
--
//Детальніше з ролями службових адміністраторів можна ознайомитись у розділі xref:arch:architecture/platform/operational/user-management/platform-actors-roles.adoc#_службові_адміністратори[Актори та ролі Платформи].
For more information on the roles of service administrators, please refer to the xref:arch:architecture/platform/operational/user-management/platform-actors-roles.adoc#службові_адміністратори[Actors and roles section of the Platform].
--

== Technical design

//На даній діаграмі зображено підсистеми, які входять в _Адміністративну зону Платформи_ та їх взаємодію з іншими підсистемами в рамках реалізації функціональних сценаріїв.
This diagram illustrates the subsystems that are part of the Platform administrative zone and their interactions with other subsystems in the implementation of functional scenarios.

image::architecture/platform/administrative/administrative-zone-subsystems.svg[]

//== Підсистеми адміністративної зони Платформи
== Platform administrative zone subsystems

|===
//|Назва підсистеми|Службова назва
|Subsystem name|Service name

//|xref:architecture/platform/administrative/control-plane/overview.adoc[Підсистема управління Платформою та реєстрами]
|xref:architecture/platform/administrative/control-plane/overview.adoc[]
|_control-plane_

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,24 @@ 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 that provides safe backup copy and restore operations for Registry and central Platform components and performs Registry disaster recovery.

== Subsystem functions

//* Безпечне резервне копіювання та відновлення центральних і реєстрових компонентів Платформи реєстрів
* Safe backup copy and restore operations for Registry and central Platform components
//* Безпечне резервне копіювання та відновлення даних реєстрів
* Safe backup copy and restore operations for Registry data
//* Відновлення центральних та реєстрових компонентів Платформи реєстрів
* Recovery of Registry and central Platform components
//* Виконання аварійного відновлення функціонування Платформи реєстрів
* Registry operation disaster recovery
//* Міграція ресурсів реєстру на інший екземпляр Платформи реєстрів
* Registry resources migration to another Registry Platform instance

== Subsystem technical design

//На даній діаграмі зображено компоненти, які входять в _Підсистему резервного копіювання та відновлення_ та їх взаємодію з іншими підсистемами.
The following diagram displays the components that are included in _Backup and restore subsystem_, and their interaction with other subsystems within functional scenarios realization.
The following diagram displays the components included in the _Backup and restore subsystem_and their interaction with other subsystems within functional scenarios realization.

image::architecture/platform/operational/backup-recovery/backup-subsystem.drawio1.svg[width=800,float="center",align="center"]

== Subsystem components


////
|===
|Назва компоненти|Namespace|Deployment|Походження|Репозиторій|Призначення
|_Сервіс резервного копіювання та відновлення_
|`velero`
|`velero`
|3rd-party
|https://github.com/epam/edp-ddm-backup-management[github:/epam/edp-ddm-backup-management]
|Компонент резервного копіювання та відновлення ресурсів у кластері
|_Служба відновлення обʼєктів S3_
|`velero`
|`restore-job`
|origin
|https://github.com/epam/edp-ddm-backup-management[github:/epam/edp-ddm-backup-management]
|Служба відновлення обʼєктів S3 реєстру
|_Служба реплікації обʼєктів S3_
|`velero`
|`replication-job`
|origin
|https://github.com/epam/edp-ddm-backup-management[github:/epam/edp-ddm-backup-management]
|Служба резервної реплікації обʼєктів S3 реєстру
|===
////

|===
|Component name|Namespace|Deployment|Source|Repository|Function

Expand All @@ -83,29 +48,24 @@ image::architecture/platform/operational/backup-recovery/backup-subsystem.drawio
|Replication service for the S3 objects of the Registry
|===


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

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

* xref:arch:architecture/platform-technologies.adoc#velero[Velero]
* xref:arch:architecture/platform-technologies.adoc#okd[OKD]
* xref:arch:architecture/platform-technologies.adoc#bash[bash]

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

=== _Reliability_
//Підсистема резервного копіювання та відновлення розроблена із забезпеченням надійності створення резервних копій та надає можливість виконання резервного копіювання та відновлювальних операцій систематично та за потребою.
Backup and restore subsystem was designed to provide reliable creation of backup copies, and allows for the use of backup and recovery operations systematically, and on demand.

The _Backup and restore subsystem_ was designed to provide reliable creation of backup copies and allows for the use of backup and recovery operations systematically and on demand.

=== _Scalability_
//Підсистема резервного копіювання та відновлення має можливість працювати з великими обсягами даних реєстрів та Платформи та постійно зростаючими обʼємами даних.
Backup and restore subsystem can operate with large volumes of Registry and Platform data, as well as continuously growing amounts of data.

The _Backup and restore subsystem_ can operate with large volumes of Registry and Platform data and continuously growing amounts of data.

=== _Recoverability_
//Підсистема резервного копіювання та відновлення надає Платформі реєстрів можливість аварійно відновити дані реєстру та Платформи у випадку відмови або при виникненні нештатної ситуації.
Backup and restore subsystem allows the Registry Platform to recover Platform and Registry data in case of failure, or unplanned situations.

_Backup and restore subsystem_ allows the Registry Platform to recover Platform and Registry data in case of failure or unplanned situations.
Loading

0 comments on commit dfcf0f5

Please sign in to comment.