Skip to content

Commit

Permalink
[EDP-DDM-28658] github: issue 44, updated screenshots, updated conten…
Browse files Browse the repository at this point in the history
…t structure, added minor fixes and aligned ua-en versions

Change-Id: I840b07f1db199795246ab5faca94c8f525ec81d3
(cherry picked from commit 8446eee33c8bfd978c37ef1cc91fd14cfcb625db)
  • Loading branch information
[email protected] committed Oct 4, 2023
1 parent cca0971 commit c3231a1
Show file tree
Hide file tree
Showing 18 changed files with 92 additions and 82 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,86 +1,97 @@
:toc-title: On this page:
:toc: auto
:toclevels: 5
:experimental:
:sectnums:
:sectnumlevels: 5
:sectanchors:
:sectlinks:
:partnums:

= Manually backing up and restoring the registry
include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]

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

== Backing up registry

//Після успішного розгортання реєстру та регламентів адміністратор Платформи має можливість створити резервну копію реєстру, що буде збережена до захищеного сховища бекапів (для прикладу, Minio).
After a successful deployment of the registry and regulations, the Platform administrator can create a backup of the registry, which will be stored in a secure backup repository (for example, Minio).
After a successful deployment of the registry and regulations, the Platform administrator can create a backup of the registry, which will be stored in a secure backup repository—*MinIO*.

//Для цього необхідно виконати наступні кроки:
To back up a registry this, follow these steps:
To back up a registry this, follow these steps: ::

//* Увійдіть до **Control Plane**, використовуючи створені попередньо створені логін та пароль.
* Log in to the **Control Plane** using the previously created login and password.
//* Перейдіть до розділу **Реєстри** та оберіть реєстр для резервного копіювання.
* Go to the **Registries** section and select the registry for backup.
//* Перейдіть до секції **Конфігурація** на сторінці xref:admin:registry-management/control-plane-view-registry.adoc#sections[Перегляд конфігурації створеного реєстру], натисніть на посилання до Jenkins (**CI**) Платформи та у вкладці **Всі** (**All**) знайдіть job із назвою `Create-registry-backup-backup-test` (див. зображення нижче).
//TODO: У програмі, замість назви підсторінки "Перегляд конфігурації створеного реєстру" я бачу табу "Інформація про реєстр", і нижче переклала її саме так.
* Go to the **Configuration** section at the xref:admin:registry-management/control-plane-edit-registry.adoc#sections[Registry information] tab, click on the link under **CI** to open Jenkins, navigate to the *All* tab, and find the job named `Create-registry-backup-backup-test` (see the image below).
. Log in to the **Control Plane** using the previously created login and password.

//TIP: Детальніше -- див. xref:admin:registry-management/control-plane-view-registry.adoc#registry-deploy-status[Перевірка відомостей про розгортання реєстру].
//TODO: Can I translate the below page name in such a way? How do I check the reference at the below address?
TIP: For more details, see xref:admin:registry-management/control-plane-edit-registry.adoc#registry-deploy-status[Checking registry deployment details]
. Go to the **Registries** section and select the registry for backup.

. Open the **Configuration** section at the xref:admin:registry-management/control-plane-edit-registry.adoc#sections[Registry information] tab, click on the link under *CI* to open Jenkins, navigate to the *All* tab, and find the job named *Create-registry-backup-`<registry-name>`* where `<registry-name>` means the name for your registry (_see the image below_).
+
TIP: For more details on Jenkins jobs, see xref:admin:registry-management/control-plane-edit-registry.adoc#registry-deploy-status[Checking registry deployment details]
+
image:backup-restore/registry/control-plane-create-backup-job.png[]

//* Відкрийте job та натисніть `Зібрати з параметрами`, щоб запустити `Create-registry-backup-backup-test` job.
* Open the job and click `Build with Parameters` to launch the `Create-registry-backup-backup-test` job.

. Open the job and click *`Build with Parameters`* to launch the *Create-registry-backup* pipeline.
+
image:backup-restore/registry/control-plane-create-backup-01.png[]

//* Натисніть `Зібрати`.
* Click `Build`.

. Click *`Build`*.
+
image:backup-restore/registry/control-plane-create-backup-02.png[]
+
image:backup-restore/registry/control-plane-create-backup-03.png[]
+
If the job is successfully executed, a backup of the registry with its regulations is created and uploaded to the corresponding backup repository directory.

[WARNING]
====
Backup replication of S3 buckets::
After the backup creation pipeline has run, it establishes bucket replication pipelines. These pipelines are scheduled to run at 19:30 (UTC) by default. If you need to launch the pipeline earlier, you can manually modify this schedule:
. Log into OKD.
. In the top-right corner, click Copy login command > Display Token.
. In the *Log in with this token* field, copy the token to log into OpenShift through the terminal. It might look like this:
+
.Example of oc login
[source,bash]
----
oc login --token=sha256~gQa0bxg_aaabbbcccd_D88470E-aabBcQuCn9keIM4I --server=https://api.envone.dev.registry.eua.gov.ua:1234
----
. Open the *OpenShift CLI* and execute the copied command.
+
[TIP]
For more information about *OpenShift CLI*, refer to the guide xref:registry-develop:study-project/index.adoc#preconditions-setup[Getting Started Preparations].
. Start the replication backups of the S3 buckets with the schedule desired by the user. To do this, run the following command:
+
[source,bash]
----
namespace="abc-02";schedule='19 12 * * *'; for cronJob in `oc get cronjob -n velero -o custom-columns="NAME:.metadata.name" --no-headers | grep "${namespace}"`;do oc -n velero patch cronjob/$cronJob -p '{"spec":{"schedule":"'$schedule'"}}'; echo 1;done
----
+
NOTE: Replace the value `namespace="abc-02"` with the name of your registry. For example, `namespace="test-registry"`.
TIP: Also, familiarize yourself with the settings for automatic setup of S3 bucket replications on the page xref:admin:backup-restore/backup-schedule-registry-components.adoc[].
====

//* У разі успішного виконання job, створюється резервна копія реєстру з регламентом та завантажується до відповідної директорії сховища бекапів.
* If the job is successfully executed, a backup of the registry with its regulations is created and uploaded to the corresponding backup repository directory.
== Restoring registry

// image:admin:backup-restore-minio1.png[]
To restore a registry from the created backup, follow these steps: ::

//== Відновлення реєстру (Restore)
== Restoring registry
. Log in to the **Control Plane** using the previously created login and password.

//* Увійдіть до **Control Plane**, використовуючи створені попередньо логін та пароль.
* Login to the **Control Plane** using the previously created login and password.
//* Перейдіть до розділу **Реєстри** та оберіть реєстр, який необхідно відновити.
* Go to the **Registries** section and select the Registry that needs to be restored.
//* Перейдіть до Jenkins (CI) платформи та у вкладці **Всі** (**All**) знайдіть `Restore-registry-backup-test` job (див. зображення нижче).
* Go to the **Configuration** section, click on the link under **CI** to open Jenkins, navigate to the *All* tab, and find the `Restore-registry-backup-test` job (see the image below).
. Go to the **Registries** section and select the Registry that needs to be restored.

. Go to the **Configuration** section, click on the link under **CI** to open Jenkins, navigate to the *All* tab, and find the *Restore-registry-`<registry-name>`* job, where `<registry-name>` means the name for your registry (_see the image below_).
+
image:backup-restore/registry/control-plane-create-restore.png[]

//* Відкрийте job та натисніть `Зібрати з параметрами`, щоб запустити `Restore-registry-backup-backup-test` job.
* Open the job and click `Build with Parameters` to launch the `Restore-registry-backup-backup-test` job.

. Open the job and click *`Build with Parameters`* to launch the *Restore-registry* pipeline.
+
image:backup-restore/registry/control-plane-create-restore-01.png[]

//* Натисніть `Зібрати`.
* Click `Build`.

. Click `Build`.
+
image:backup-restore/registry/control-plane-create-restore-02.png[]

//* Далі, на кроці введення параметрів, оберіть версію резервної копії для відновлення. Для цього перейдіть до виводу консолі (Секція **Console Output** на панелі зліва) та натисніть `Input Requested`.
* Next, in the parameter input step, select the backup version to restore. To do this, go to the console output (the **Console Output** section on the left panel) and click `Input Requested`.

. Next, in the parameter input step, select the backup version to restore. To do this, go to the *Console Output* section on the left panel and click *`Input Requested`*.
+
image:backup-restore/registry/control-plane-create-restore-03.png[]

//* Оберіть версію резервної копії зі списку та натисніть `Proceed`.
* Select the backup version from the list and click `Proceed`.

. Select the backup version from the list and click *`Proceed`*.
+
image:backup-restore/registry/control-plane-create-restore-04.png[]

//* У разі успішного виконання job `Restore-registry-backup-test`, реєстр буде відновлено до стану обраної версії резервної копії.
* If the `Restore-registry-backup-test` job is successfully executed, the registry will be restored to the selected backup version.

+
If the *Restore-registry* pipeline is successfully executed, the registry will be restored to the selected backup version.
+
image:backup-restore/registry/control-plane-create-restore-05.png[]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,26 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[]
[#create-registry-backup]
== Створення резервної копії реєстру (backup)

Після успішного розгортання реєстру та регламентів адміністратор Платформи має можливість створити резервну копію реєстру, що буде збережена до захищеного сховища бекапів (для прикладу, Minio).
Після успішного розгортання реєстру та регламентів адміністратор Платформи має можливість створити резервну копію реєстру, яка зберігатиметься у захищеному сховищі бекапів -- *MinIO*.

Для цього необхідно виконати наступні кроки:
Виконайте наступні кроки, щоб створити бекап реєстру: ::

. Увійдіть до *Control Plane*, використовуючи створені попередньо створені логін та пароль.
. Перейдіть до розділу _Реєстри_ та оберіть реєстр для резервного копіювання.
. Відкрийте секцію _Конфігурація_ на сторінці xref:admin:registry-management/control-plane-edit-registry.adoc#sections[Перегляд конфігурації створеного реєстру], натисніть на посилання до Jenkins (**CI**) Платформи та у вкладці **Всі** (**All**) знайдіть job із назвою `Create-registry-backup-backup-test` (див. зображення нижче).
. Відкрийте секцію _Конфігурація_ на сторінці xref:admin:registry-management/control-plane-edit-registry.adoc#sections[Перегляд конфігурації створеного реєстру], натисніть посилання до Jenkins (**CI**) Платформи та на вкладці *All* знайдіть пайплайн із назвою *Create-registry-backup-`<registry-name>`*, де `<registry-name>` назва реєстру (_див. зображення нижче)_.
+
TIP: Детальніше -- див. xref:admin:registry-management/control-plane-edit-registry.adoc#registry-deploy-status[Перевірка відомостей про розгортання реєстру].
TIP: Детальніше про пайплайни -- див. xref:admin:registry-management/control-plane-edit-registry.adoc#registry-deploy-status[Перевірка відомостей про розгортання реєстру].
+
image:backup-restore/registry/control-plane-create-backup-job.png[]

. Відкрийте job та натисніть `Зібрати з параметрами`, щоб запустити `Create-registry-backup-backup-test` job.
. Відкрийте папку та натисніть *`Build with parameters`*, щоб запустити пайплайн *Create-registry-backup*.
+
image:backup-restore/registry/control-plane-create-backup-01.png[]

. Натисніть `Зібрати`.
. Натисніть *`Build`*.
+
image:backup-restore/registry/control-plane-create-backup-02.png[]
+
image:backup-restore/registry/control-plane-create-backup-03.png[]
+
У разі успішного виконання job, створюється резервна копія реєстру з регламентом та завантажується до відповідної директорії сховища бекапів.
Expand All @@ -33,7 +34,7 @@ image:backup-restore/registry/control-plane-create-backup-03.png[]
====
Резервне копіювання реплікацій S3-бакетів::
Після того, як пайплайн створення резервної копії відпрацював, він створює джоби реплікацій бакетів. Час запуску таких джоб за замовчуванням стоїть 19:30 (UTC). Тому якщо потрібно запустити пайплайн раніше, можна змінити цей розклад вручну:
Після того, як пайплайн створення резервної копії відпрацював, він створює пайплайни реплікацій бакетів. Час запуску таких пайплайнів за замовчуванням стоїть 19:30 (UTC). Тому якщо потрібно запустити пайплайн раніше, можна змінити цей розклад вручну:
. Виконайте вхід в OKD.
. У верхньому правому куті натисніть Copy login command > Display Token.
Expand Down Expand Up @@ -62,35 +63,33 @@ NOTE: Замініть значення `namespace="abc-02"` назвою ваш
TIP: Ознайомтеся також із налаштуванням автоматичного налаштування реплікацій S3-бакетів на сторінці xref:admin:backup-restore/backup-schedule-registry-components.adoc[].
====



// image:admin:backup-restore-minio1.png[]

[#restore-registry]
== Відновлення реєстру (Restore)

* Увійдіть до **Control Plane**, використовуючи створені попередньо логін та пароль.
* Перейдіть до розділу **Реєстри** та оберіть реєстр, який необхідно відновити.
* Перейдіть до Jenkins (CI) платформи та у вкладці **Всі** (**All**) знайдіть `Restore-registry-backup-test` job (див. зображення нижче).
Виконайте наступні кроки, щоб відновити реєстр зі створеної резервної копії: ::

. Увійдіть до **Control Plane**, використовуючи створені попередньо логін та пароль.
. Перейдіть до розділу _Реєстри_ та оберіть реєстр, який необхідно відновити.
. Перейдіть до Jenkins (*CI*) Платформи та на вкладці *All* знайдіть пайплайн *Restore-registry-`<registry-name>`*, де `<registry-name>` -- назва реєстру (_див. зображення нижче_).
+
image:backup-restore/registry/control-plane-create-restore.png[]

* Відкрийте job та натисніть `Зібрати з параметрами`, щоб запустити `Restore-registry-backup-backup-test` job.
. Відкрийте папку та натисніть *`Build with parameters`*, щоб запустити пайплайн *Restore-registry*.
+
image:backup-restore/registry/control-plane-create-restore-01.png[]

* Натисніть `Зібрати`.
. Натисніть *`Build`*.
+
image:backup-restore/registry/control-plane-create-restore-02.png[]

* Далі, на кроці введення параметрів, оберіть версію резервної копії для відновлення. Для цього перейдіть до виводу консолі (Секція **Console Output** на панелі зліва) та натисніть `Input Requested`.
. Далі, на кроці введення параметрів, оберіть версію резервної копії для відновлення. Для цього перейдіть до виводу консолі (Секція *Console Output* на панелі зліва) та натисніть *`Input Requested`*.
+
image:backup-restore/registry/control-plane-create-restore-03.png[]

* Оберіть версію резервної копії зі списку та натисніть `Proceed`.
. Оберіть версію резервної копії зі списку та натисніть *`Proceed`*.
+
image:backup-restore/registry/control-plane-create-restore-04.png[]

* У разі успішного виконання job `Restore-registry-backup-test`, реєстр буде відновлено до стану обраної версії резервної копії.
+
У разі успішного виконання job `Restore-registry-backup-test`, реєстр буде відновлено до стану обраної версії резервної копії.
+
image:backup-restore/registry/control-plane-create-restore-05.png[]

0 comments on commit c3231a1

Please sign in to comment.