Управление конфигурациями в ADBM
Обзор
В ADBM конфигурация (configuration) означает набор опций, используемых для формирования бинарных бэкапов ADB. Эти опции включают в себя расписания для различных типов бэкапов, пути для сохранения бэкапов, уровни логирования, тайм-ауты, настройки сжатия данных и так далее. ADBM поддерживает несколько версий конфигураций. Но в каждый момент времени может быть только одна активная версия, которая отмечена статусом current
в web-интерфейсе.
Возможные операции с конфигурациями описаны ниже. Все операции запускаются на вкладке Configuration. Чтобы открыть эту вкладку, выполните шаги:
-
Откройте страницу Backup Manager в web-интерфейсе ADB Control.
-
Нажмите на имя кластера ADB в таблице, расположенной в секции Clusters открывшейся страницы.
Выбор кластера ADBВыбор кластера ADB -
Выберите вкладку Configuration.
Вкладка ConfigurationВкладка Configuration
Изначально конфигурации в списке отсутствуют. Чтобы начать работу с бэкапами в ADBM, требуется добавить новую конфигурацию.
Добавление новой конфигурации
ВАЖНО
Обратите внимание, что в результате сохранения любой конфигурации (даже без настроенных расписаний) к кластеру применяется |
-
Откройте вкладку Configuration, как описано выше.
-
Заполните поля, расположенные в секциях General configuration, Timeout, Repository и Compression. При заполнении полей обратите внимание на следующее:
-
Обязательные параметры выделены красным цветом.
-
Для параметров, определяющих время, допускаются следующие единицы измерения:
-
ms
— миллисекунды; -
sec
— секунды; -
min
— минуты; -
hr
— часы; -
d
— дни; -
w
— недели.
-
-
Для параметров, определяющих объем данных, можно использовать следующие единицы измерения:
-
b
— байты; -
kb
— килобайты; -
mb
— мегабайты; -
gb
— гигабайты.
-
-
При заполнении параметров, обозначающих время или объем данных, используйте следующий формат:
<value><unit>
(без пробела), где<value>
— количество;<unit>
— единица измерения (см. выше). Например,1min
,2hr
. Если необходимо составное значение, используйте пробел (например,30min 30sec
). -
Нажав на иконку , которая появляется справа от названий некоторых полей во время их заполнения, можно вывести справочную информацию по полям: допустимые единицы измерения, минимальное и максимальное значения и так далее.
-
Иконка указывает на возможность редактирования значения поля в отдельной форме, которую можно открыть нажатием на иконку. В настоящий момент иконка используется в полях, где вводятся расписания создания и очистки бэкапов. Нажмите на иконку, чтобы открыть окно Cron expression generator, в котором можно установить расписание путем выбора секунд, минут, часов, дней, месяцев и лет. Выбранные на форме параметры автоматически трансформируются в cron-выражение, которое будет сохранено как значение поля. Выражение и его описание можно увидеть в верхней части окна. Для сохранения текущего выражения и возврата на основную страницу нажмите Save.
Окно "Cron expression generator"Окно "Cron expression generator"General configurationПараметр Описание Значение по умолчанию Number of full backups
Максимальное количество полных (full) бэкапов. При достижении этого лимита наиболее старые бэкапы с типом full будут удалены во время следующего автоматического или ручного запуска действия Cleanup. Дополнительную информацию можно получить в разделе Cleanup
3
Number of differential backups
Максимальное количество дифференциальных (differential) бэкапов. При достижении этого лимита наиболее старые бэкапы с типом differential будут удалены во время следующего автоматического или ручного запуска действия Cleanup. Дополнительную информацию можно получить в разделе Cleanup
6
Full Backup schedule
Расписание для автоматического создания полных (full) бэкапов. Если бэкапы предполагается формировать вручную, оставьте переключатель напротив поля в неактивном состоянии
—
Differential backup schedule
Расписание для автоматического создания дифференциальных (differential) бэкапов. Если бэкапы предполагается формировать вручную, оставьте переключатель напротив поля в неактивном состоянии
—
Incremental backup schedule
Расписание для автоматического создания инкрементных (incremental) бэкапов. Если бэкапы предполагается формировать вручную, оставьте переключатель напротив поля в неактивном состоянии
—
Restore point creation schedule
Расписание для автоматического создания точек восстановления (restore points). Если точки восстановления предполагается формировать вручную, оставьте переключатель напротив поля в неактивном состоянии
—
Cleanup schedule
Раписание для автоматического удаления избыточных бэкапов (см. Number of full backups и Number of differential backups выше) и бэкапов со статусами
failed
иinvalid
. Если процедуру очистки предполагается осуществлять вручную, оставьте переключатель напротив поля в неактивном состоянии—
File Log level
Уровень логирования.
Возможные значения:
-
off
— отсутствие логов; -
error
; -
warn
; -
info
; -
detail
; -
debug
; -
trace
.
info
Log path
Путь к месту хранения логов
/home/gpadmin/gpAdminLogs
Bundle size
Целевой размер бандлов с файлами. Бандл (bundle) означает группировку отдельных файлов в один перед формированием бэкапа. Значение параметра не рекомендуется устанавливать слишком большим, поскольку при повторных попытках снятия бэкапов будет необходимо формировать весь бандл целиком
100mb
Bundle limit
Ограничение на размер файлов, включаемых в бандл (см. Bundle size выше). Файлы большего размера будут сохраняться отдельно (вне бандла). Файлы в бандлах не могут быть переиспользованы при возобновлении бэкапа (resume) — поэтому параметр фактически контролирует файлы для возобновления бэкапов
2mb
Use block incremental backup
Переключатель, определяющий следует ли создавать более гранулярные резервные копии путем разделения файлов на блоки, которые могут быть забэкапированы независимо друг от друга
false
Секция "General configuration"Секция "General configuration"TimeoutПараметр Описание Значение по умолчанию Database query timeout
Устанавливает тайм-аут для запросов к базе данных, включая функции запуска/остановки резервного копирования, которые могут занять значительное время. Следует установить большое значение, если нет уверенности, что функции быстро возвращают результат. Значение Database query timeout должно быть меньше, чем Protocol timeout
30min
Protocol timeout
Устанавливает время, в течение которого локальный или удаленный процесс может ожидать получения нового сообщения на протокольном уровне. Использование тайм-аута предотвращает бесконечное ожидание со стороны процессов. Значение Protocol timeout должно быть больше, чем Database query timeout
30min 30sec
I/O timeout
Тайм-аут, используемый для подключений и операций чтения/записи. Следует учесть, что операция чтения/записи не должна завершиться полностью в течение указанного времени, однако должен быть достигнут некоторый прогресс, даже если это всего лишь один байт
1min
Job wait timeout
Тайм-аут ожидания захвата блокировки на уровне кластера перед началом выполнения задачи (job)
15min
Секция TimeoutСекция TimeoutRepositoryПараметр Описание Значение по умолчанию Archive command
Команда, выполняемая когда файлы WAL (Write Ahead Log) передаются в archive directory. Если значение параметра Archive command изменяется, то при применении конфигурации кластер ADB автоматически перезапускается (для изменения значения GUC
archive_command
).
Префикс имени конфигурации stanza для сегментов, используемый в Archive command, должен совпадать со значением Stanza template (см. ниже):--stanza=<Stanza template>%c
PGOPTIONS=\"-c gp_session_role=utility\" /usr/lib/gpdb/bin/pgbackrest --stanza=seg%c archive-push %p
Archive timeout
Максимальное время, в течение которого каждый WAL-сегмент (необходимый для консистентности бэкапа) должен достигнуть архивного репозитория
1min
Stanza template
Префикс имени конфигурации stanza для сегментов. Должен совпадать с префиксом, используемым в Archive command (см. выше):
--stanza=<Stanza template>%c
seg
Repository type
Тип репозитория.
Возможные значения:
-
posix
-
s3
-
cifs
posix
Upload chunk size
Размер загружаемого чанка данных (part size — в терминологии S3). Отображается, если в поле Repository type указано значение
s3
. Обратите внимание, что ограничения, отображаемые во всплывающей подсказке (64kb-1tb
), исходят со стороны pgbackrest. Хранилище S3 может иметь свои собственные ограничения5MB
Exclude path
Определяет пути и файлы, которые необходимо исключить из процесса бэкапирования
-
pg_log/gp_era
-
backups
-
gpperfmon/data/
-
gpbackup_history.yaml
Repository path
Репозиторий, в котором будут храниться бэкапы и архив WAL-сегментов. Указанная директория должна быть предварительно создана и доступна с хостов Master и Segment. Можно использовать shared-директорию NFS, которая подключена ко всем сегмент-хостам. Если в кластере настроено зеркалирование сегментов, не используйте локальную директорию (созданную на сегментах) — в этом случае на хостах с зеркалами не будет необходимых stanza
—
URI Type
Тип Endpoint для S3-хранилища. Отображается, если в поле Repository type указано значение
s3
. Возможные значения:-
host
— хост; -
path
— путь.
—
Endpoint
Конечная точка (endpoint) для S3-хранилища. Отображается, если в поле Repository type указано значение
s3
—
Bucket
Бакет в S3-хранилище. Имя бакета не должно содержать точек. Отображается, если в поле Repository type указано значение
s3
—
Key
Ключ S3-хранилища. Отображается, если в поле Repository type указано значение
s3
—
Key secret
Секретный ключ S3-хранилища. Отображается, если в поле Repository type указано значение
s3
—
Region
Регион S3-хранилища. Отображается, если в поле Repository type указано значение
s3
—
Repository storage CA file
PEM-файл от доверенного центра сертификации (Certificate Authority, CA) S3-хранилища. Отображается, если в поле Repository type указано значение
s3
. Для загрузки файла нажмите Upload—
Certificate verification
Необходима ли верификация сертификата S3-хранилища. Отображается, если в поле Repository type указано значение
s3
. При активации переключателя становится доступно для заполнения поле Repository storage CA filetrue
Секция RepositoryСекция RepositoryCompressionПараметр Описание Значение по умолчанию Compression type
Алгоритм сжатия данных.
Возможные значения:
-
none
— сжатие данных не используется; -
bz2
; -
gz
; -
lz4
; -
zst
.
gz
Compression level
Уровень сжатия данных. Возможные значения:
0
—9
0
Max processes to use for compress/transfer
Максимальное количество процессов, используемых на каждом сегменте для сжатия/передачи данных
1
Buffer size
Размер буфера для операций I/O
1mb
Секция CompressionСекция Compression -
-
-
Нажмите Save. Эта кнопка расположена до и после секций с параметрами.
Сохранение конфигурацииСохранение конфигурации -
В результате запускается действие Start 'Apply backup configuration' action. Это действие, в свою очередь, порождает несколько дочерних действий (subactions). Просмотреть их можно на вкладке Actions (см. Просмотр действий в ADBM).
До успешного завершения всех действий конфигурация будет иметь статус Draft.
-
После успешного применения действий конфигурация получает статус
Current
. Наряду со статусом, становится доступна следующая информация о конфигурации:-
Номер версии (начиная с
1
). -
Имя пользователя, создавшего текущую версию.
-
Дата создания в формате
DD/MM/YYYY
.Успешный результатУспешный результат
-
Редактирование конфигурации
После добавления конфигурации отредактировать ее параметры нельзя. Однако можно создать новую версию конфигурации на базе одной из добавленных ранее. Для этого выполните следующие шаги:
-
Откройте вкладку Configuration, как описано выше.
-
В списке доступных версий выберите ту, на основе которой необходимо создать новую. Значения всех параметров выбранной версии выводятся под списком версий (недоступные для редактирования).
ПРИМЕЧАНИЕДобавить конфигурацию можно на базе любой имеющейся версии, не только последней.
Выбор версииВыбор версии -
Нажмите Create new.
-
Внесите необходимые изменения в секции General configuration, Timeout, Repository и Compression. Параметры в этих секциях полностью идентичны описанным выше.
-
Нажмите Save для добавления новой версии конфигурации. Эта кнопка расположена до и после секций с параметрами.
Сохранение новой версии конфигурацииСохранение новой версии конфигурации -
В результате запускается действие Start 'Apply backup configuration' action. Это действие, в свою очередь, порождает несколько дочерних действий (subactions). Просмотреть их можно на вкладке Actions (см. Просмотр действий в ADBM).
-
После успешного применения всех действий новая версия конфигурации становится доступной на вкладке Configuration и приобретает статус
Current
.ПРИМЕЧАНИЕ-
ADBM использует версию конфигурации, добавленную последней.
-
Неактивные версии конфигурации, которые не имеют связанных бэкапов, будут удалены при следующем автоматическом либо ручном запуске действия Cleanup.
Новая версия конфигурацииНовая версия конфигурации -
Черновики конфигураций
В ADBM 1.6.3 добавлен начальный статус Draft
для конфигураций бэкапов. Этот статус присваивается всем конфигурациям при попытке их сохранения до успешного применения всех действий и перевода в статус Current
. Однако, если конфигурация не может быть успешно провалидирована, она остается в статусе Draft
— во избежание повторного ввода всей информации в дальнейшем. Черновик конфигурации можно отредактировать (и попытаться повторно применить) либо удалить, нажав на кнопки Edit и Delete, соответственно.
Начиная с версии 1.7.3 в ADBM доступен дополнительный статус Verified
, означающий, что валидация конфигурации успешно завершена, однако во время ее применения возникла ошибка. Конфигурации в статусе Verified
могут быть отредактированы либо удалены, как и черновики.