v1beta3.md

API Reference

Packages

• backups.anynines.com/v1beta3

backups.anynines.com/v1beta3

Package v1beta3 contains API Schema definitions for the backups v1beta3 API group

Resource Types

• Backup
• BackupList
• BackupPolicy
• BackupPolicyList
• Restore
• RestoreList

Backup

Backup is the Schema for the backups API

Appears in:

• BackupList

Field	Description
apiVersion string	backups.anynines.com/v1beta3
kind string	Backup
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec BackupSpec
status BackupStatus

BackupList

BackupList contains a list of Backup.

Field	Description
apiVersion string	backups.anynines.com/v1beta3
kind string	BackupList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Backup array

BackupOptions

BackupOptions

Appears in:

• BackupPolicySpec

Field	Description
maxRetries string	How many times the backup will be retried before aborting. Allowed values: any positive integer, or "Infinite"

BackupPolicy

BackupPolicy is the Schema for the backuppolicies API

Appears in:

• BackupPolicyList

Field	Description
apiVersion string	backups.anynines.com/v1beta3
kind string	BackupPolicy
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec BackupPolicySpec
status BackupPolicyStatus

BackupPolicyList

BackupPolicyList contains a list of BackupPolicy.

Field	Description
apiVersion string	backups.anynines.com/v1beta3
kind string	BackupPolicyList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items BackupPolicy array

BackupPolicySpec

BackupPolicySpec defines the desired state of BackupPolicy.

Appears in:

• BackupPolicy

Field	Description
enabled boolean	Enabled is whether the policy enabled or not, set to false instead of delete
scheduleConfig ScheduleConfiguration	ScheduleConfig the scheduling configuration for backups
retentionConfig RetentionConfiguration	RetentionConfig the retention policy for backups
serviceInstance ServiceInstanceRef	ServiceInstances identifies a list of Data Service Instances to backup.
backupOptions BackupOptions	BackupOptions is the configuration options for backups

BackupPolicyStatus

BackupPolicyStatus defines the observed state of BackupPolicy.

Appears in:

• BackupPolicy

Field	Description
enabled boolean	Enabled is whether the policy enabled or not, set to false instead of delete
lastBackupDate Time	LastBackupDate is the last date when the backup process was run
nextScheduledBackup Time	NextScheduledBackup is the next date sheduled to run the backup
backupsCount integer	BackupsCount is the number of retained backups
latestBackup LatestBackup	LatestBackup is the last backup created by the policy
error string	Error message incase error occurred

BackupSpec

BackupSpec defines the desired state of Backup.

Appears in:

• Backup

Field	Description
serviceInstance ServiceInstanceRef	ServiceInstance identifies the Data Service Instance to backup.
maxRetries string	How many times the backup will be retried before aborting. Allowed values: any positive integer, or "Infinite"

BackupStatus

BackupStatus defines the observed state of Backup.

Appears in:

• Backup

Field	Description
conditions Condition array	Conditions include a set of not mutually exclusive states the Backup can be in, as well as the last observed time stamp for these conditions. They include "Ready", "InProgress", "UploadedToS3", "Terminating".
lastObservationTime Time	LastObservationTime is the timestamp of the last time the Condition was observed to be true.
retries integer	Number of times the backup has been retried
podUsedNamespacedName string	PodUsedNamespacedName is the namespaced name of the DSI Pod to which the backup request was sent. TODO: Represent this jointly with PodUsedID (below) via a PodRef.
podUsedUID UID	PodUsedUID is the UID of the DSI Pod to which the backup request was sent. TODO: Represent this jointly with PodUsedNamespacedName (above) via a PodRef.
backupID string	BackupID is the ID of the Backup; clients can use this to poll the status of the Backup at the Pod identified by PodUsedID.

Cron

Appears in:

• ScheduleConfiguration

Field	Description
expression string	Expression is the cron expression for scheduling backups

LatestBackup

Latest Backup details

Appears in:

• BackupPolicyStatus

Field	Description
name string	Name of the backup created
status string	Status status of the backup

PodRef

PodRef describes a reference to a Pod.

Appears in:

• RestoreStatus

Field	Description
namespacedName string	NamespacedName is the namespaced name of the Pod.
uid UID	UID is the UID of the Pod.
ip string	IP is the IP of the Pod.

Restore

Restore is the Schema for the restore API

Appears in:

• RestoreList

Field	Description
apiVersion string	backups.anynines.com/v1beta3
kind string	Restore
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RestoreSpec
status RestoreStatus

RestoreList

RestoreList contains a list of Restore.

Field	Description
apiVersion string	backups.anynines.com/v1beta3
kind string	RestoreList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Restore array

RestoreSpec

RestoreSpec defines the desired state of Restore.

Appears in:

• Restore

Field	Description
serviceInstance ServiceInstanceRef	ServiceInstance identifies the Data Service Instance to restore.
backupName string	BackupName is the name of the Backup API object to use for the Restore; the namespace is assumed to be the same as the one for the Restore object, we might reconsider this assumption in the future.

RestoreStatus

RestoreStatus defines the observed state of Restore.

Appears in:

• Restore

Field	Description
lastObservationTime Time	LastObservationTime is the timestamp of the last time the Condition was observed to be true.
conditions Condition array	Conditions include a set of not mutually exclusive states the Restore can be in, as well as the last observed time stamp for these conditions. They include "Ready", "InProgress", "Terminating".
podToPoll PodRef	The Pod to poll to learn the status of the Restore, if the restore is in Progress.
restoreID string	RestoreID is the ID of the Restore; clients can use this to poll the status of the Restore at the Pod identified by PodToHit.

RetentionConfiguration

RetentionConfiguration defines the retention policy for backups.

Appears in:

• BackupPolicySpec

Field	Description
count integer	Count specifies the maximum number of backups to retain
retentionPeriod RetentionPeriod	Period specifies the retention as duration

RetentionPeriod

Appears in:

• RetentionConfiguration

Field	Description
count integer	Count is the number of time unit for the retention period e.g. 7 (days)
type string	Type is the type of time unit for the retention period (hour, day, month, year)

ScheduleConfiguration

ScheduleConfiguration defines the scheduling configuration for backups.

Appears in:

• BackupPolicySpec

Field	Description
type ScheduleType	ScheduleType specifies the type of schedule to define date/time of next backup to run Currently we support Cron; more types to be implemented later
timeZone string	Timezone to calculate next schedule date
cron Cron

ServiceInstanceRef

ServiceInstanceRef references a Data Service Instance to backup or restore. The referenced Data Service Instance is always assumed to be in the same Kubernetes API namespace as the parent Backup/Restore API object, so there's no namespace field; we might reconsider this assumption in the future.

Appears in:

• BackupPolicySpec
• BackupSpec
• RestoreSpec

Field	Description
name string	Name is the name of the Kubernetes API resource that represents the Data Service Instance to backup or restore.
kind string	Kind is the kind of the Kubernetes API resource that represents the Data Service Instance to backup or restore (e.g. Postgresql, Redis, etc...).
apiGroup string	APIGroup is the API group of the Kubernetes API resource that represents the Data Service Instance to backup or restore (e.g. postgresql.anynines.com, redis.anynines.com, etc...).