Справочник ресурсов резервного копирования

Содержание

Справочник ресурсов резервного копирования#

Справочник содержит формальное описание полей spec ресурсов резервного копирования и восстановления.

AstraAutomationBackup#

Секция spec ресурса AstraAutomationBackup содержит следующие поля:

Поле	По умолчанию	Назначение
`deployment_name`	–	Обязательное поле. Название ресурса `AstraAutomation`, состояние которого сохраняется
`backup_pvc`	`""`	Использовать существующий том PVC (Persistent Volume Claim). Если не задано, создается том `<name>-backup-claim`
`backup_storage_class`	класс по умолчанию	StorageClass для нового тома PVC
`backup_storage_requirements`	`5Gi`	Размер нового тома PVC
`backup_resource_requirements`	запросы 25m / 32Mi, лимиты 1 / 4Gi	Ресурсы служебного пода
`postgres_image`	образ из поставки	Образ служебного пода; мажорная версия клиента PostgreSQL должна быть не ниже версии сервера
`postgres_image_version`	тег из поставки	Тег образа служебного пода
`postgres_label_selector`	автоматически	Селектор пода PostgreSQL для внутренней базы данных
`pg_dump_suffix`	`""`	Дополнительные параметры `pg_dump`, например `-Z 9`
`clean_backup_on_delete`	`false`	Удалять каталог копии из тома PVC при удалении ресурса
`remove_owner_references_from_children`	`false`	Снять ссылки `ownerReferences` с дочерних ресурсов `*Backup`, после чего они перестают удаляться каскадом вместе с корневым ресурсом
`no_log`	`true`	Подавлять чувствительные значения в журнале оператора

Здесь:

<name> – название ресурса компонента.

Поля backup_pvc, backup_storage_class, backup_storage_requirements и clean_backup_on_delete, заданные в корневом ресурсе, передаются в дочерние ресурсы *Backup, включая DashboardBackup.

Дочерние ресурсы AutomationControllerBackup, EDABackup и PrivateAutomationHubBackup используют те же поля. Особенностью PrivateAutomationHubBackup является то, что поля postgres_image и postgres_image_version в схеме CRD не описаны. Образ служебного пода Private Automation Hub можно переопределить только переменной окружения RELATED_IMAGE_AUTOMATION_HUB_POSTGRES на самом операторе.

AstraAutomationRestore#

Секция spec ресурса AstraAutomationRestore содержит следующие поля:

Поле	По умолчанию	Назначение
`deployment_name`	–	Обязательное поле. Название нового экземпляра платформы
`backup_name`	–	Название ресурса `AstraAutomationBackup`, который является источником копии (при `backup_source: CR`)
`backup_pvc` / `backup_dir`	–	Альтернатива `backup_name`, то есть том и каталог копии напрямую (при `backup_source: PVC`); значения содержатся в полях `status.backupClaim` и `status.backupDirectory` ресурса резервного копирования
`backup_source`	`CR`	Источник данных для восстановления: `CR` или `PVC`
`cluster_name`	`cluster.local`	Зона DNS кластера
`hostname`	наследуется из копии	Название узла восстановленного экземпляра платформы. Если `public_base_url` не задан, публичный URL выводится как `https://<hostname>`. При `ingress_type: route` не применяется, так как адресом маршрута управляет `route_host`
`public_base_url`	наследуется из копии	Публичный URL восстановленного экземпляра платформы; приоритетнее URL, выведенного из `hostname`
`ingress_tls_secret`	наследуется из копии	Секрет TLS ingress восстановленного экземпляра платформы; сертификат должен быть действителен для нового названия узла (`hostname`)
`force_drop_db`	`false`	Создать заново базы данных перед восстановлением; передается в дочерние ресурсы восстановления (см. Повторное восстановление и создание базы данных заново)
`restore_resource_requirements`	как у резервного копирования	Ресурсы служебного пода
`no_log`	`true`	Подавлять чувствительные значения в журнале оператора

Здесь:

<hostname> – значение поля hostname.

DashboardBackup#

Секция spec ресурса DashboardBackup содержит следующие поля:

Поле	По умолчанию	Назначение
`deployment_name`	–	Обязательное поле. Название ресурса `Dashboard`; корневой ресурс `AstraAutomationBackup` подставляет его автоматически
`backup_pvc`	`""`	Использовать существующий том PVC. Если не задано, создается том `<dashboard>-backup-claim`
`backup_pvc_namespace`	пространство имен ресурса	Устаревшее поле. Пространство имен тома PVC
`backup_storage_class`	класс по умолчанию	StorageClass для нового тома PVC
`backup_storage_requirements`	`5Gi`	Размер нового тома PVC
`clean_backup_on_delete`	`false`	Удалять каталог копии из тома PVC при удалении ресурса; удаление с очисткой занимает обычно 30–60 секунд
`no_log`	`true`	Подавлять чувствительные значения в журнале оператора

Здесь:

<dashboard> – название ресурса Dashboard.

Также поддерживаются поля backup_resource_requirements, postgres_image / postgres_image_version, postgres_label_selector, pg_dump_suffix и image_pull_policy. Их семантика та же, что у остальных ресурсов *Backup.

DashboardRestore#

Секция spec ресурса DashboardRestore содержит следующие поля:

Поле	По умолчанию	Назначение
`deployment_name`	–	Обязательное поле. Название восстановленного ресурса `Dashboard`; корневой ресурс `AstraAutomationRestore` подставляет `<deployment>-dashboard`
`backup_name`	–	Название ресурса `DashboardBackup` (при `backup_source: CR`)
`backup_pvc` / `backup_dir`	–	Альтернатива `backup_name`, то есть том и каталог копии напрямую (при `backup_source: PVC`); значения содержатся в полях `status` ресурса `DashboardBackup`
`force_drop_db`	`false`	Создать заново базу данных перед восстановлением. Для внутренней базы данных команды выполняются через локальный сокет в поде PostgreSQL. Для внешней СУБД команды выполняются по сети (см. Повторное восстановление и создание базы данных заново). Передается корневым ресурсом `AstraAutomationRestore`
`spec_overrides`	–	Переопределения секции `spec` восстановленного ресурса `Dashboard`. Корневой ресурс `AstraAutomationRestore` передает через них секрет авторизации и адреса шлюза восстановленного экземпляра платформы. Поле полезно администратору, например, для восстановления с выключенными репликами (см. Запись кластера в базе данных Automation Dashboard)
`no_log`	`true`	Подавлять чувствительные значения в журнале оператора

Здесь:

<deployment> – название нового экземпляра платформы (значение поля deployment_name).

Корневой ресурс AstraAutomationRestore создает дочерний ресурс DashboardRestore с названием <restore>-dashboard и дожидается его завершения. Состояние Failure дочернего ресурса переводит в состояние Failure и корневой ресурс. Диагностика: kubectl describe dashboardrestore <restore>-dashboard и журнал оператора dashboard-operator-dashboard-manager.

Здесь:

<restore> – название ресурса AstraAutomationRestore.