5.2 KiB
| layout | parent | title |
|---|---|---|
| page | CRD reference | ArangoBackupPolicy V1 |
API Reference for ArangoBackupPolicy V1
Spec
.spec.allowConcurrent
Type: boolean [ref]
AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
Default Value: true
.spec.maxBackups
Type: integer [ref]
MaxBackups defines how many backups should be kept in history (per deployment). Oldest healthy Backups will be deleted. If not specified or 0 then no limit is applied
Default Value: 0
.spec.schedule
Type: string [ref]
Schedule is cron-compatible specification of backup schedule Parsed by https://godoc.org/github.com/robfig/cron
.spec.selector
Type: meta.LabelSelector [ref]
DeploymentSelector Selector definition for selecting matching ArangoBackup Custom Resources.
Links:
.spec.template.backoff.iterations
Type: integer [ref]
Iterations defines number of iterations before reaching MaxDelay. Default to 5
.spec.template.backoff.max_delay
Type: integer [ref]
MaxDelay defines maximum delay in seconds. Default to 600
.spec.template.backoff.max_iterations
Type: integer [ref]
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
.spec.template.backoff.min_delay
Type: integer [ref]
MinDelay defines minimum delay in seconds. Default to 30
.spec.template.lifetime
Type: integer [ref]
Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
.spec.template.options.allowInconsistent
Type: boolean [ref]
AllowInconsistent flag for Backup creation request. If this value is set to true, backup is taken even if we are not able to acquire lock.
Default Value: false
This field is immutable: can't be changed after backup creation
.spec.template.options.timeout
Type: number [ref]
Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
Default Value: 30
This field is immutable: can't be changed after backup creation
.spec.template.upload.autoDelete
Type: boolean [ref]
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
Default Value: false
.spec.template.upload.credentialsSecretName
Type: string [ref]
CredentialsSecretName is the name of the secret used while accessing repository
Links:
This field is immutable: can't be changed after backup creation
.spec.template.upload.repositoryURL
Type: string [ref]
RepositoryURL is the URL path for file storage
Same repositoryURL needs to be defined in credentialsSecretName if protocol is other than local.
Format: <protocol>:/<path>
Links:
Example:
s3://my-bucket/test
azure://test
This field is immutable: can't be changed after backup creation
Status
.status.message
Type: string [ref]
Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid
.status.scheduled
Type: meta.Time [ref]
Scheduled Next scheduled time in UTC