Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Хранилище данных с резервным копированием на каждой цели: одно присоединение core/backup

База данных PostgreSQL, резервное копирование которой выполняется в Kubernetes через Velero и через CloudNativePG, в AWS — через собственные автоматические резервные копии Amazon RDS, в Terraform и в CloudFormation, а также через AWS Backup, из одного присоединения core/backup, которое оператор записывает в каждой сущности Release, и с отказом на цели, у которой нет продукта для резервного копирования.

core/backup означает, что для хранилища данных по расписанию создаются резервные копии и что каждая копия хранится определённое число дней. Оно ничего не говорит о том, как именно: сущность Manifest каждой цели привязывает сущность FeatureRecipe, которая реализует его там, и каждая из них записывает резервное копирование в терминах собственного продукта — расписание Velero, запланированное резервное копирование CloudNativePG, настройки экземпляра RDS, план AWS Backup. Цель без продукта, который мог бы это реализовать, отклоняет присоединение, называя его, так что сборка останавливается, а не развёртывает хранилище данных без записанного для него резервного копирования.

Это рабочее пространство собирает одну сущность Aggregate через шесть сущностей Releases, каждая из которых присоединяет одно и то же резервное копирование: ежедневно в 02:30, каждая копия хранится 14 дней. Страница показывает, что каждая цель рендерит для него в пяти, которые завершаются, и приводит то, что выводит шестая, которая, как и ожидается, останавливается.

Что собирается

экземплярсущность Component из каталогагде выполняется
dbcore/datastore/postgresкаждая сущность Release
backupscore/storage/s3-object-storeдве сущности Releases для Kubernetes: бакет, в который попадают резервные копии
velerocore/storage/veleroсущность Release для Velero
barman-cloudcore/storage/barman-cloud-pluginсущность Release для CloudNativePG

Сущность Aggregate объявляет базу данных и то, что требуется для её резервного копирования в Kubernetes: бакет и два контроллера резервного копирования. Контроллер резервного копирования устанавливается один раз на кластер, а не вместе с базой данных, поэтому это отдельный компонент; в AWS резервные копии остаются в собственном хранилище управляемого сервиса, и ни один из этих трёх там не нужен. Один параметр, backup_controller, переключает их через переключатель active: каждого компонента:

aggregate.yaml
spec:
parameters:
[… omitted: the comment above the parameter]
backup_controller:
type: string
default: none
[… omitted: the parameter's description]
components:
[… omitted: the comment above each component]
db:
type: core/datastore/postgres
backups:
type: core/storage/s3-object-store
active: '{{ ne .parameters.backup_controller "none" }}'
values:
bucket: db-backups
velero:
type: core/storage/velero
active: '{{ eq .parameters.backup_controller "velero" }}'
barman-cloud:
type: core/storage/barman-cloud-plugin
active: '{{ eq .parameters.backup_controller "cloudnative-pg" }}'

Компонент, переключатель которого имеет значение false, удаляется до того, как что-либо будет собрано, поэтому сущности Releases для AWS и Docker Compose, оставляющие параметр со значением none, собирают только базу данных.

Присоединение

Разработчик ничего не пишет для резервного копирования: db не несёт в сущности Aggregate никакого присоединения. Оператор присоединяет к нему core/backup в каждой сущности Release, в разделе features компонента, и указывает там, когда выполняется резервное копирование и сколько хранится каждая копия. В Kubernetes присоединение также указывает, куда попадают резервные копии, через своё соединение store с бакетом:

release-helm-velero.yaml
components:
db:
annotations:
aggrega.ai/namespace: orders
[… omitted: the comment above the attachment]
features:
backup:
type: core/backup
infra:
schedule: "30 2 * * *"
retention_days: 14
uses:
store:
bucket:
target: backups

Сущности Releases для AWS записывают то же присоединение без соединения store, потому что RDS и AWS Backup хранят резервные копии в собственном хранилище, а реализации там отклоняют соединение с бакетом, в который ничего не записывалось бы. Сущность Release для AWS Backup добавляет infra.role_arn — роль IAM, от имени которой AWS Backup выполняет каждое резервное копирование.

Шесть сущностей Releases

ReleaseManifestcore/backup реализуетсборка
release-helm-velero.yamlmanifest-helm-velero.yamlhelm/backup-veleroзавершается
release-helm-cloudnative-pg.yamlmanifest-helm-cloudnative-pg.yamlhelm/backup-cloudnative-pgзавершается
release-terraform.yamlmanifest-terraform.yamlterraform/backup-nativeзавершается
release-cloudformation.yamlmanifest-cloudformation.yamlcloudformation/backup-nativeзавершается
release-terraform-aws-backup.yamlmanifest-terraform-aws-backup.yamlterraform/backup-aws-backupзавершается
release-compose.yamlmanifest-compose.yamlничегоостанавливается

Каким продуктом создаются резервные копии базы данных, решает сущность Manifest. Две сущности Manifests для Kubernetes запускают базу данных двумя способами — helm/postgres, StatefulSet, для Velero и helm/postgres-cloudnative-pg, CloudNativePG Cluster, для плагина — и привязывают соответствующую реализацию резервного копирования для каждого. manifest-terraform.yaml и manifest-terraform-aws-backup.yaml сопоставляют базу данных с одной и той же сущностью Recipe и различаются сущностью FeatureRecipe, которую привязывают к core/backup, а собранные из них сущности Releases различаются, помимо сущности Manifest, которую называет каждая, только ролью.

Сущности Releases для Kubernetes также присоединяют собственную пару ключей бакета и файл учётных данных, которым Velero подписывает свои запросы, как присоединения core/referenced-secret, называющие объекты Secret, которые уже есть в кластере, поэтому ни один ключ не записывается ни в один отрендеренный файл. Каждое значение, специфичное для учётной записи, в сущностях Releases для AWS является заполнителем.

Создание примера

Этот пример можно собрать командами ниже или поручить сборку вашему ИИ-ассистенту.

Запишите пример в новую папку, названную по его имени:

Terminal window
aggrega scaffold --example datastore-backup

Затем она выводит команды, которые нужно выполнить дальше. Первая переходит в новую папку:

Terminal window
cd datastore-backup

Сборка

Рабочее пространство читает каталог стандартной библиотеки из реестра hub, который указывает .aggrega-config.yaml. Velero и плагин Barman Cloud устанавливаются через собственные чарты их проектов, поэтому двум сущностям Releases для Kubernetes нужно, чтобы репозитории чартов этих проектов были доступны из сборки; каждая другая сущность Release рендерится только из каталога.

Terminal window
aggrega build --release release-helm-velero.yaml --auto-pull # one Release

В рабочей копии репозитория документации, которая содержит общий вспомогательный скрипт сборки, отсутствующий в копии, записанной aggrega scaffold --example, ./check.sh собирает все шесть сущностей Releases и проверяет каждый результат. Он выводит по одной строке на каждую сущность Release и завершается с кодом 0, только если каждая завершилась так, как описывает эта страница:

RELEASE EXIT EXPECTED VERDICT
----------------------------------------------------------------------------------------------------
release-helm-velero.yaml 0 complete OK: completed, the backup the README shows
release-helm-cloudnative-pg.yaml 0 complete OK: completed, the backup the README shows
release-terraform.yaml 0 complete OK: completed, the backup the README shows
release-cloudformation.yaml 0 complete OK: completed, the backup the README shows
release-terraform-aws-backup.yaml 0 complete OK: completed, the backup the README shows
release-compose.yaml 1 halt OK: halted with the expected refusal
check: every build ended as expected.

С ИИ-ассистентом

ИИ-ассистент, настроенный с инструментами Aggrega, может сделать то же самое: вставьте в него этот промпт.

Используйте только инструменты Aggrega и не создавайте папки самостоятельно. Если в папке рабочей области ещё нет папки `datastore-backup`, вызовите инструмент `scaffold` один раз, задав `example` равным `datastore-backup` и не указывая `dir`: он запишет пример в новую папку `datastore-backup`. Затем вызовите инструмент `build`, задав `workspace_root` равным `datastore-backup`, `release` равным `release-helm-velero.yaml`, `auto_pull` равным true и `write` равным true. Сообщите мне, какие файлы записала сборка; они находятся в `datastore-backup/dist/`.

Kubernetes с Velero

release-helm-velero.yaml записывает StatefulSet и объекты Service базы данных, соответствующие объекты бакета, объекты, которые рендерит собственный чарт Velero, и один файл для присоединения, содержащий расположение хранилища Velero и расписание:

dist/helm/db--backup--backup.yaml
apiVersion: velero.io/v1
kind: BackupStorageLocation
metadata:
[… omitted: the labels and annotations the build writes on every resource]
name: "orders-db-backup"
namespace: velero
spec:
provider: velero.io/aws
objectStorage:
bucket: "db-backups"
prefix: "orders-db-backup"
config:
region: "us-east-1"
s3Url: "http://backups-default.orders:8333"
s3ForcePathStyle: "true"
---
apiVersion: velero.io/v1
kind: Schedule
metadata:
[… omitted: the labels and annotations, as on the storage location]
name: "orders-db-backup"
namespace: velero
spec:
schedule: "30 2 * * *"
template:
includedNamespaces:
- "orders"
orLabelSelectors:
- matchLabels:
"app": "db"
storageLocation: "orders-db-backup"
ttl: "336h0m0s"
snapshotVolumes: false
defaultVolumesToFsBackup: true

Оба размещаются в пространстве имён velero, единственном, из которого Velero читает свои расписания, и названы по пространству имён базы данных, её имени и имени присоединения, поскольку каждая сущность Release в кластере записывает в это одно пространство имён. Расписание выбирает поды базы данных по меткам StatefulSet, который рендерит база данных, в пространстве имён, где она размещена, а агент узла Velero копирует файлы их томов в бакет. Адрес бакета — тот, который публикует компонент backups, с именем Service, уточнённым пространством имён, в котором он работает, поскольку Velero работает в другом; регион тоже принадлежит бакету: SeaweedFS, который его здесь обслуживает, никакого не читает и публикует us-east-1. 14 дней — это время жизни (TTL) в Velero, выраженное в часах.

Kubernetes с CloudNativePG

release-helm-cloudnative-pg.yaml записывает базу данных как CloudNativePG Cluster, а также бакет, объекты, которые рендерит чарт плагина, и файл присоединения, содержащий хранилище объектов плагина и запланированное резервное копирование, рядом с Cluster в его собственном пространстве имён:

dist/helm/db--backup--backup.yaml
apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
metadata:
[… omitted: the labels and annotations the build writes on every resource]
name: "db-backup"
namespace: "orders"
spec:
configuration:
destinationPath: "s3://db-backups/orders/db-backup"
endpointURL: "http://backups-default.orders:8333"
s3Credentials:
accessKeyId:
name: "db-backup"
key: "ACCESS_KEY_ID"
secretAccessKey:
name: "db-backup"
key: "ACCESS_SECRET_KEY"
retentionPolicy: "14d"
instanceSidecarConfiguration:
env:
- name: "AWS_DEFAULT_REGION"
value: "us-east-1"
---
apiVersion: postgresql.cnpg.io/v1
kind: ScheduledBackup
metadata:
[… omitted: the labels and annotations, as on the object store]
name: "db-backup"
namespace: "orders"
spec:
schedule: "0 30 2 * * *"
cluster:
name: "db"
method: "plugin"
pluginConfiguration:
name: "barman-cloud.cloudnative-pg.io"

Расписание CloudNativePG имеет шесть полей, первое из которых — секунды, поэтому 30 2 * * * из присоединения записывается с 0 впереди. Плагин подписывает свои запросы парой ключей из объекта Secret, который называет хранилище объектов, здесь db-backup, по имени самого хранилища объектов, поскольку присоединение не задаёт infra.credentials_secret.

Собственная сущность Recipe базы данных также читает присоединение и назначает плагин архиватором журнала упреждающей записи (WAL) для Cluster:

dist/helm/db/cluster.yaml
[… omitted: apiVersion, kind and metadata]
spec:
[… omitted: the instance count, the image, the storage and the resources]
plugins:
- name: "barman-cloud.cloudnative-pg.io"
isWALArchiver: true
parameters:
barmanObjectName: "db-backup"
[… omitted: the bootstrap settings]

Таким образом, журнал непрерывно архивируется в бакет между ежедневными базовыми резервными копиями, и восстановление может достичь любого момента в пределах 14 дней: это восстановление на момент времени CloudNativePG, которое эта реализация оставляет включённым.

Terraform

release-terraform.yaml записывает только модуль базы данных. Реализация присоединения, terraform/backup-native, не рендерит ни одного файла: резервное копирование является настройкой экземпляра RDS, поэтому сущность Recipe базы данных читает присоединение и записывает его там, где записывается экземпляр:

dist/terraform/modules/db/main.tf
[… omitted: the provenance comment, the provider requirement, and the instance's engine, compute, storage, database and HA arguments]
## ── Backup ───────────────────────────────────────────────
backup_retention_period = 14
backup_window = "02:30-03:00"
[… omitted: the subnet group and security groups, and the address output]

RDS принимает одно ежедневное время начала вместо выражения cron, поэтому 30 2 * * * становится окном резервного копирования, которое открывается в 02:30 UTC и длится 30 минут — самое короткое, что принимает RDS.

CloudFormation

release-cloudformation.yaml записывает один шаблон стека, содержащий экземпляр, с теми же двумя настройками под их именами свойств CloudFormation:

dist/cloudformation/cloudformation-stack.json
[… omitted: the template's format version, the outputs carrying what the database publishes, and the opening of its resources]
"Db": {
[… omitted: the deletion policy and the provenance metadata]
"Properties": {
"AllocatedStorage": 10,
"BackupRetentionPeriod": 14,
"DBInstanceClass": "db.t3.small",
[… omitted: the database name, the subnet group, the engine and the credentials settings]
"MultiAZ": false,
"Port": 5432,
"PreferredBackupWindow": "02:30-03:00",
[… omitted: the storage type and the security groups]
},
"Type": "AWS::RDS::DBInstance"
}
[… omitted: the closing of the resources and of the template]

AWS Backup

release-terraform-aws-backup.yaml вместо этого собирается из сущности Manifest, привязывающей terraform/backup-aws-backup. Эта реализация записывает собственный модуль присоединения рядом с модулем базы данных, содержащий хранилище резервных копий (vault), план и выборку, называющую экземпляр:

dist/terraform/modules/db--backup/backup.tf
[… omitted: the provenance comment, the provider requirement, and the partition, Region and account lookups]
resource "aws_backup_vault" "backup" {
name = "db-backup"
}
resource "aws_backup_plan" "backup" {
name = "db-backup"
rule {
rule_name = "db-backup"
target_vault_name = aws_backup_vault.backup.name
schedule = "cron(30 2 * * ? *)"
start_window = 60
lifecycle {
delete_after = 14
}
}
}
resource "aws_backup_selection" "backup" {
name = "db-backup"
plan_id = aws_backup_plan.backup.id
iam_role_arn = "arn:aws:iam::123456789012:role/example-backup"
resources = [
"arn:${data.aws_partition.current.partition}:rds:${data.aws_region.current.region}:${data.aws_caller_identity.current.account_id}:db:db",
]
}

Расписание записывается в собственной форме cron AWS и читается в UTC, а резервное копирование, которое не началось в течение часа от своего времени, не запускается. ARN экземпляра — это выражение Terraform, составленное из того, на что настроен провайдер AWS во время планирования, и имени экземпляра; роль — та, которую называет сущность Release, передаваемая так, как она записана.

Экземпляр сохраняет собственные автоматические резервные копии наряду с копиями AWS Backup, как и без присоединения: в течение 7 дней, в окне, которое выбирает RDS, поскольку расписание присоединения принадлежит AWS Backup, а не экземпляру:

dist/terraform/modules/db/main.tf
[… omitted: the provenance comment, the provider requirement, and the instance's engine, compute, storage, database and HA arguments]
## ── Backup ───────────────────────────────────────────────
backup_retention_period = 7
[… omitted: the subnet group and security groups, and the address output]

infra.keep_automated_backups: false в присоединении отключает их и оставляет копии AWS Backup единственными резервными копиями экземпляра.

Чего сборка не делает

Сборка записывает файлы и останавливается. Она не выполняет никакого резервного копирования и не обращается ни к какому кластеру, бакету или API AWS. Она не разрешает никакой ARN, учётную запись или регион: в AWS каждое из них — это выражение или значение, которое записала сущность Release и которое Terraform, CloudFormation или AWS читает при применении файлов. Она также ничего не проверяет в кластере:

  • Расписание Velero выполняется только там, где развёрнут Velero, а резервные копии плагина — только там, где работают плагин, оператор CloudNativePG (1.26 или новее) и cert-manager. Это рабочее пространство развёртывает Velero и плагин; предполагается, что оператор и cert-manager уже там есть.
  • Объекты Secret, которые называют сущности Releases для Kubernetes, должен хранить кластер, в пространстве имён, из которого читается каждый: backup-store-access-key-id и backup-store-secret-access-key рядом с бакетом, velero-cloud-credentials в velero, содержащий общий файл учётных данных AWS, и db-backup рядом с базой данных, содержащий пару ключей под ACCESS_KEY_ID и ACCESS_SECRET_KEY. Сборка не рендерит ни один из них.

Сущность Release, которая останавливается

release-compose.yaml присоединяет то же резервное копирование к базе данных в Docker Compose. Ни одна сущность FeatureRecipe не реализует там core/backup, поэтому manifest-compose.yaml ничего не привязывает, а aggrega build --release release-compose.yaml --auto-pull останавливается, называя присоединение, вместо того чтобы развернуть базу данных без резервного копирования:

[… omitted: what resolving the lockfile prints, the same halt among it]
[OPS_ERROR E0099]
recipe resolution
caused by (1):
no recipe resolved for component/feature instance: add an explicit Manifest mapping for its type: feature "backup" (type "core/backup"); no feature recipe the lockfile pins implements core/backup:1.0.0 for capability "compose", the capability its component's Recipe binds to; with no catalog directory, the feature recipes searched are only those the lockfile pins, not a registry's; pin one a registry publishes in the Manifest, where one for another capability renders as its own output beside the component's, or write one for "compose", then map the type to it

Рабочее пространство не указывает ни одной папки каталога, поэтому у сборки для поиска есть только сущности FeatureRecipes, закреплённые в её lock-файле, а сущность Manifest, не привязывающая ни одной для core/backup, ни одной и не закрепляет; сообщение говорит именно это, а не утверждает, что в хабе нет ни одной. Если в качестве папки каталога указана рабочая копия каталога стандартной библиотеки, та же остановка сообщает, что ни одна сущность FeatureRecipe в каталоге не реализует core/backup:1.0.0 для compose, и перечисляет десять, которые реализуют его для других целей: cloudformation/backup-aws-backup, cloudformation/backup-native, helm/backup-cloudnative-pg, helm/backup-k8up, helm/backup-kasten, helm/backup-kubestash, helm/backup-mariadb-operator, helm/backup-velero, terraform/backup-aws-backup и terraform/backup-native.

Каталог стандартной библиотеки не содержит сущности FeatureRecipe для core/backup на этой цели. Каждая из них привязывается к другой цели, поэтому, будучи закреплённой здесь, она рендерится как отдельный вывод рядом с файлом Compose — для цели, на которую эта сущность Release не развёртывает. Дальнейшие пути — удалить присоединение из сущности Release, развернув там базу данных без резервного копирования, или развернуть её через сущность Manifest для цели, у которой есть продукт для резервного копирования, как это делают остальные пять сущностей Releases.