v1

type ArangoBackup struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`

	Spec   ArangoBackupSpec   `json:"spec"`
	Status ArangoBackupStatus `json:"status"`
}

type ArangoBackupDetails struct {
	ID                      string `json:"id"`
	Version                 string `json:"version"`
	PotentiallyInconsistent *bool  `json:"potentiallyInconsistent,omitempty"`
	// SizeInBytes Size of the Backup in ArangoDB.
	SizeInBytes uint64 `json:"sizeInBytes,omitempty"`
	// NumberOfDBServers Cluster size of the Backup in ArangoDB
	NumberOfDBServers uint `json:"numberOfDBServers,omitempty"`
	// Uploaded Determines if ArangoBackup has been uploaded
	Uploaded *bool `json:"uploaded,omitempty"`
	// Downloaded Determines if ArangoBackup has been downloaded.
	Downloaded *bool `json:"downloaded,omitempty"`
	Imported   *bool `json:"imported,omitempty"`
	// CreationTimestamp ArangoBackup Custom Resource creation time in UTC
	CreationTimestamp meta.Time          `json:"createdAt"`
	Keys              sharedApi.HashList `json:"keys,omitempty"`
}

type ArangoBackupList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []ArangoBackup `json:"items"`
}

type ArangoBackupPolicy struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`

	Spec   ArangoBackupPolicySpec   `json:"spec"`
	Status ArangoBackupPolicyStatus `json:"status"`
}

type ArangoBackupPolicyList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []ArangoBackupPolicy `json:"items"`
}

type ArangoBackupPolicySpec struct {
	// Schedule is cron-compatible specification of backup schedule
	// Parsed by https://godoc.org/github.com/robfig/cron
	Schedule string `json:"schedule"`
	// AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
	// +doc/default: true
	AllowConcurrent *bool `json:"allowConcurrent,omitempty"`
	// DeploymentSelector Selector definition for selecting matching ArangoDeployment Custom Resources.
	// +doc/type: meta.LabelSelector
	// +doc/link: Kubernetes Documentation|https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#LabelSelector
	DeploymentSelector *meta.LabelSelector `json:"selector,omitempty"`
	// 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
	// +doc/default: 0
	MaxBackups int `json:"maxBackups,omitempty"`
	// ArangoBackupTemplate specifies additional options for newly created ArangoBackup
	BackupTemplate ArangoBackupTemplate `json:"template"`
}

type ArangoBackupPolicyStatus struct {
	// Scheduled Next scheduled time in UTC
	// +doc/type: meta.Time
	Scheduled meta.Time `json:"scheduled,omitempty"`
	// Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid
	Message string `json:"message,omitempty"`
}

type ArangoBackupProgress struct {
	// JobID ArangoDB job ID for uploading or downloading
	JobID string `json:"jobID"`
	// Progress ArangoDB job progress in percents
	// +doc/example: 90%
	Progress string `json:"progress"`
}

type ArangoBackupSpec struct {
	// Deployment describes the deployment which should have a backup
	Deployment ArangoBackupSpecDeployment `json:"deployment,omitempty"`

	// Options specifies backup options
	Options *ArangoBackupSpecOptions `json:"options,omitempty"`

	// Download Backup download settings
	Download *ArangoBackupSpecDownload `json:"download,omitempty"`

	// Upload Backup upload settings.
	// This field can be removed and created again with different values. This operation will trigger upload again.
	Upload *ArangoBackupSpecOperation `json:"upload,omitempty"`

	// PolicyName name of the ArangoBackupPolicy which created this Custom Resource
	// +doc/immutable: can't be changed after backup creation
	PolicyName *string `json:"policyName,omitempty"`

	// Backoff define the operation backoff policy
	Backoff *ArangoBackupSpecBackOff `json:"backoff,omitempty"`

	// Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
	Lifetime *meta.Duration `json:"lifetime,omitempty"`
}

type ArangoBackupSpecBackOff struct {
	// MinDelay defines minimum delay in seconds. Default to 30
	// +doc/default: 30
	MinDelay *int `json:"min_delay,omitempty"`
	// MaxDelay defines maximum delay in seconds. Default to 600
	// +doc/default: 600
	MaxDelay *int `json:"max_delay,omitempty"`
	// Iterations defines number of iterations before reaching MaxDelay. Default to 5
	// +doc/default: 5
	Iterations *int `json:"iterations,omitempty"`
	// MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
	MaxIterations *int `json:"max_iterations,omitempty"`
	// Until defines the deadline of the retry mechanism in UTC
	Until *meta.Time `json:"until,omitempty"`
}

type ArangoBackupSpecDeployment struct {
	// Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
	// +doc/immutable: can't be changed after backup creation
	Name string `json:"name,omitempty"`
}

type ArangoBackupSpecDownload struct {
	ArangoBackupSpecOperation `json:",inline"`

	// ID of the ArangoBackup to be downloaded
	// +doc/immutable: can't be changed after backup creation
	ID string `json:"id"`
}

type ArangoBackupSpecOperation struct {
	// 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>`
	// +doc/example: s3://my-bucket/test
	// +doc/example: azure://test
	// +doc/immutable: can't be changed after backup creation
	// +doc/link: rclone.org|https://rclone.org/docs/#syntax-of-remote-paths
	RepositoryURL string `json:"repositoryURL"`
	// CredentialsSecretName is the name of the secret used while accessing repository
	// +doc/immutable: can't be changed after backup creation
	// +doc/link: Defining a secret for backup upload or download|../backup-resource.md#defining-a-secret-for-backup-upload-or-download
	CredentialsSecretName string `json:"credentialsSecretName,omitempty"`
	// AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
	// +doc/default: false
	AutoDelete *bool `json:"autoDelete,omitempty"`
}

type ArangoBackupSpecOptions struct {
	// Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
	// +doc/immutable: can't be changed after backup creation
	// +doc/default: 30
	Timeout *float32 `json:"timeout,omitempty"`
	// 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.
	// +doc/immutable: can't be changed after backup creation
	// +doc/default: false
	AllowInconsistent *bool `json:"allowInconsistent,omitempty"`
}

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

	// Time is the time in UTC when state of the ArangoBackup Custom Resource changed.
	Time meta.Time `json:"time"`

	// Message for the state this object is in.
	Message string `json:"message,omitempty"`

	// Progress info of the uploading and downloading process
	Progress *ArangoBackupProgress `json:"progress,omitempty"`
}

type ArangoBackupStatus struct {
	ArangoBackupState `json:",inline"`
	// Backup ArangoBackup details
	Backup *ArangoBackupDetails `json:"backup,omitempty"`
	// Available Determines if we can restore from ArangoBackup
	Available bool `json:"available"`
	// Backoff shows current backoff status
	Backoff *ArangoBackupStatusBackOff `json:"backoff,omitempty"`
}

type ArangoBackupStatusBackOff struct {
	Iterations int       `json:"iterations,omitempty"`
	Next       meta.Time `json:"next,omitempty"`
}

type ArangoBackupTemplate struct {
	Options *ArangoBackupSpecOptions `json:"options,omitempty"`

	Upload *ArangoBackupSpecOperation `json:"upload,omitempty"`

	Backoff *ArangoBackupSpecBackOff `json:"backoff,omitempty"`

	// Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
	Lifetime *meta.Duration `json:"lifetime,omitempty"`
}