1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
kube-arangodb/docs/backuppolicy-resource.md
Nikita Vaniasin 66d6dca7b9
(Documentation) Update ArangoBackup and ArangoBackupPolicy CR auto-generated docs (#1452)
* (Documentation) Update ArangoBackup and ArangoBackupPolicy CR auto-generated docs

* Sort keys before printing sections, do not use maps package
2023-10-20 12:25:30 +02:00

1.9 KiB

ArangoBackupPolicy Custom Resource

Full CustomResourceDefinition reference ->

The ArangoBackupPolicy represents schedule definition for creating ArangoBackup Custom Resources by operator. This deployment specification is a CustomResource following a CustomResourceDefinition created by the operator.

Examples

Create schedule for all deployments

You can create an ArangoBackup Custom Resource for each ArangoBackup every 15 minutes.

apiVersion: "backup.arangodb.com/v1"
kind: "ArangoBackupPolicy"
metadata:
  name: "example-arangodb-backup-policy"
spec:
  schedule: "*/15 * * * *"

Create schedule for selected deployments

You can create an ArangoBackup Custom Resource for selected ArangoBackups every 15 minutes.

apiVersion: "backup.arangodb.com/v1"
kind: "ArangoBackupPolicy"
metadata:
  name: "example-arangodb-backup-policy"
spec:
  schedule: "*/15 * * * *"
  selector:
    matchLabels:
      labelName: "labelValue"

Create schedule for all deployments and upload

You can create an ArangoBackup Custom Resource for each ArangoBackup every 15 minutes and upload it to the specified repositoryURL.

apiVersion: "backup.arangodb.com/v1"
kind: "ArangoBackupPolicy"
metadata:
  name: "example-arangodb-backup-policy"
spec:
  schedule: "*/15 * * * * "
  template:
    upload:
      repositoryURL: "s3:/..."
      credentialsSecretName: "secret-name"

Create schedule for all deployments, don't allow parallel backup runs, keep limited number of backups

You can create an ArangoBackup Custom Resource for each ArangoBackup every 15 minutes. You can keep 10 backups per deployment at the same time, and delete the oldest ones. Don't allow to run backup if previous backup is not finished.

apiVersion: "backup.arangodb.com/v1"
kind: "ArangoBackupPolicy"
metadata:
  name: "example-arangodb-backup-policy"
spec:
  schedule: "*/15 * * * *"
  maxBackups: 10
  allowConcurrent: False