Автоматические снимки

Автоматические снимки позволяют Stronghold по расписанию создавать резервные копии встроенного Raft-хранилища и сохранять их на локальный диск или в S3-совместимое объектное хранилище.

Автоматические снимки подходят для регулярного резервного копирования без ручного запуска команд. Они особенно полезны для production-кластеров, где важно иметь повторяемую политику хранения и выносить резервные копии за пределы самого кластера.

Особенности использования автоматических снимков:

• можно создать несколько именованных конфигураций снимков;
• каждая конфигурация определяет интервал запуска, политику хранения и тип хранилища;
• поддерживаются типы хранилища local и aws-s3;
• для production-сред используйте внешнее объектное хранилище, а не локальное: активный узел кластера может меняться, а резервные копии нужно хранить отдельно от защищаемой системы.

Имена снимков формируются в формате <file_prefix>-<N>.snap, где <N> — время создания в наносекундах Unix. Очистка по правилу retain учитывает только файлы или объекты с таким форматом имени в настроенной директории или префиксе. Две конфигурации одного типа хранилища не могут использовать одно и то же место назначения (path_prefix и file_prefix; для aws-s3 также тот же бакет и регион).

Каждая конфигурация выполняется отдельной задачей. После создания или изменения конфигурации её задача перезапускается: если сохранённого статуса ещё нет, первый снимок создаётся через одну десятую от interval (но не более чем через 10 минут); иначе — когда с начала последнего снимка пройдёт interval. Последующие снимки создаются через interval после завершения предыдущего. После неудачного снимка следующая попытка выполняется с экспоненциальной задержкой (начиная с 1 минуты, удваивая её, но не более interval). Изменение конфигурации сбрасывает consecutive_errors.

Создание или обновление конфигурации

Чтобы создать или обновить конфигурацию автоматических снимков, используйте эндпоинт:

Для работы с эндпоинтом требуются права sudo. Запрос заменяет конфигурацию целиком: частичного обновления нет, поэтому всегда передавайте все обязательные параметры, включая storage_type.

Основные параметры

Дополнительные параметры для local

Дополнительные параметры для aws-s3

Примеры конфигурации

Локальный диск

Следующий файл local-snapshot.json создаёт конфигурацию, которая сохраняет снимок каждые 5 минут в директорию /stronghold/data/backups, хранит 4 копии, ограничивает занимаемое снимками место 1 ГиБ и использует префикс main_stronghold:

{
  "interval": "5m",
  "path_prefix": "/stronghold/data/backups",
  "file_prefix": "main_stronghold",
  "retain": "4",
  "storage_type": "local",
  "local_max_space": 1073741824
}

Примените конфигурацию из файла local-snapshot.json следующей командой:

d8 stronghold write sys/storage/raft/snapshot-auto/config/my-local-snapshots @local-snapshot.json

stronghold write sys/storage/raft/snapshot-auto/config/my-local-snapshots @local-snapshot.json

S3-совместимое хранилище

Следующий файл minio-snapshot.json сохраняет снимки в S3-совместимое хранилище:

{
  "interval": "3m",
  "path_prefix": "snapshots",
  "file_prefix": "stronghold_backup",
  "retain": "15",
  "storage_type": "aws-s3",
  "aws_s3_bucket": "my_bucket",
  "aws_s3_endpoint": "minio.domain.ru",
  "aws_s3_region": "us-east-1",
  "aws_access_key_id": "<ACCESS_KEY>",
  "aws_secret_access_key": "<SECRET_ACCESS_KEY>"
}

Примените конфигурацию из файла minio-snapshot.json следующей командой:

d8 stronghold write sys/storage/raft/snapshot-auto/config/my-remote-snapshots @minio-snapshot.json

stronghold write sys/storage/raft/snapshot-auto/config/my-remote-snapshots @minio-snapshot.json

Обновление существующей конфигурации

Конфигурация заменяется целиком, поэтому для изменения части параметров передайте полный документ с новыми значениями (включая storage_type и обязательные параметры выбранного типа хранилища):

{
  "interval": "3m",
  "path_prefix": "/stronghold/data/backups",
  "file_prefix": "main_stronghold",
  "retain": "10",
  "storage_type": "local",
  "local_max_space": 1073741824
}

После любого успешного обновления задача этой конфигурации перезапускается, а расписание пересчитывается.

Примените обновлённую конфигурацию из файла local-snapshot-update.json следующей командой:

d8 stronghold write sys/storage/raft/snapshot-auto/config/my-local-snapshots @local-snapshot-update.json

stronghold write sys/storage/raft/snapshot-auto/config/my-local-snapshots @local-snapshot-update.json

Просмотр списка конфигураций

Чтобы получить список конфигураций автоматических снимков, используйте эндпоинт:

Пример команды:

d8 stronghold list sys/storage/raft/snapshot-auto/config

stronghold list sys/storage/raft/snapshot-auto/config

Получение параметров конфигурации

Чтобы получить параметры конфигурации автоматических снимков, используйте эндпоинт:

Пример команды:

d8 stronghold read sys/storage/raft/snapshot-auto/config/my-remote-snapshots

stronghold read sys/storage/raft/snapshot-auto/config/my-remote-snapshots

Для aws-s3 ответ содержит aws_access_key_id и aws_secret_access_key в открытом виде, поэтому ограничьте доступ к этому эндпоинту.

Удаление конфигурации

Чтобы удалить конфигурацию автоматических снимков, используйте эндпоинт:

Пример команды:

d8 stronghold delete sys/storage/raft/snapshot-auto/config/my-remote-snapshots

stronghold delete sys/storage/raft/snapshot-auto/config/my-remote-snapshots

Получение статуса

Чтобы получить статус автоматических снимков, используйте эндпоинт:

Пример команды:

d8 stronghold read sys/storage/raft/snapshot-auto/status/my-remote-snapshots

stronghold read sys/storage/raft/snapshot-auto/status/my-remote-snapshots

Ключевые поля статуса:

• consecutive_errors — количество идущих подряд ошибок резервного копирования; обнуляется после успешно завершённой процедуры резервного копирования;
• last_snapshot_end — время завершения создания последнего успешного снимка;
• last_snapshot_error — текст последней ошибки при выполнении снимка;
• last_snapshot_start — время начала создания последнего снимка;
• last_snapshot_url — адрес последнего успешно созданного снимка;
• next_snapshot_start — время следующего запуска запланированного снимка;
• snapshot_start — время начала текущего создаваемого снимка;
• snapshot_url — адрес текущего создаваемого снимка.