API Reference for ArangoBackup V1
Spec
.spec.backoff.iterations
Type: integer [ref]
Iterations defines number of iterations before reaching MaxDelay. Default to 5
Default Value: 5
.spec.backoff.max_delay
Type: integer [ref]
MaxDelay defines maximum delay in seconds. Default to 600
Default Value: 600
.spec.backoff.max_iterations
Type: integer [ref]
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
.spec.backoff.min_delay
Type: integer [ref]
MinDelay defines minimum delay in seconds. Default to 30
Default Value: 30
.spec.deployment.name
Type: string [ref]
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
This field is immutable: can’t be changed after backup creation
.spec.download.autoDelete
Type: boolean [ref]
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
Default Value: false
.spec.download.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.download.id
Type: string [ref]
ID of the ArangoBackup to be downloaded
This field is immutable: can’t be changed after backup creation
.spec.download.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
.spec.lifetime
Type: integer [ref]
Lifetime is the time after which the backup will be deleted. Format: “1.5h” or “2h45m”.
.spec.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.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.policyName
Type: string [ref]
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
This field is immutable: can’t be changed after backup creation
.spec.upload.autoDelete
Type: boolean [ref]
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
Default Value: false
.spec.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.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