Skip to content

Latest commit

 

History

History
322 lines (181 loc) · 9.49 KB

ArangoBackup.V1.md

File metadata and controls

322 lines (181 loc) · 9.49 KB
layout parent title
page
CRD reference
ArangoBackup V1

API Reference for ArangoBackup V1

Spec

.spec.backoff.iterations

Type: integer [ref]

Iterations defines number of iterations before reaching MaxDelay. Default to 5

.spec.backoff.max_delay

Type: integer [ref]

MaxDelay defines maximum delay in seconds. Default to 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

.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

Status

.status.available

Type: boolean [ref]

Available Determines if we can restore from ArangoBackup

.status.backoff.iterations

Type: integer [ref]

.status.backup.downloaded

Type: boolean [ref]

Downloaded Determines if ArangoBackup has been downloaded.

.status.backup.id

Type: string [ref]

.status.backup.imported

Type: boolean [ref]

.status.backup.keys

Type: array [ref]

.status.backup.numberOfDBServers

Type: integer [ref]

NumberOfDBServers Cluster size of the Backup in ArangoDB

.status.backup.potentiallyInconsistent

Type: boolean [ref]

.status.backup.sizeInBytes

Type: integer [ref]

SizeInBytes Size of the Backup in ArangoDB.

.status.backup.uploaded

Type: boolean [ref]

Uploaded Determines if ArangoBackup has been uploaded

.status.backup.version

Type: string [ref]

.status.message

Type: string [ref]

Message for the state this object is in.

.status.progress.jobID

Type: string [ref]

JobID ArangoDB job ID for uploading or downloading

.status.progress.progress

Type: string [ref]

Progress ArangoDB job progress in percents

Example:

90%

.status.state

Type: string [ref]

State holds the current high level state of the backup

Possible Values:

  • "" (default) - state for un-initialized Custom Resource
  • "Pending" - state in which Custom Resource is queued. If Backup is possible changed to "Scheduled"
  • "Scheduled" - state which will start create/download process
  • "Download" - state in which download request will be created on ArangoDB
  • "DownloadError" - state when download failed
  • "Downloading" - state for downloading progress
  • "Create" - state for backup when it is scheduled for creation, field available set to true
  • "Creating" - state for backup when it is creating
  • "CreateError" - state for backup when it is creation failed
  • "Upload" - state in which upload request will be created on ArangoDB
  • "Uploading" - state for uploading progress
  • "UploadError" - state when uploading failed
  • "Ready" - state when Backup is finished
  • "Deleted" - state when Backup was once in ready, but has been deleted
  • "Failed" - state for failure
  • "Unavailable" - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc.