Documentation
¶
Overview ¶
SPDX-License-Identifier: Apache-2.0 Package v1alpha1 defines backups.cozystack.io API types.
Group: backups.cozystack.io Version: v1alpha1
SPDX-License-Identifier: Apache-2.0 Package v1alpha1 defines backups.cozystack.io API types.
Group: backups.cozystack.io Version: v1alpha1
SPDX-License-Identifier: Apache-2.0 Package v1alpha1 defines backups.cozystack.io API types.
Group: backups.cozystack.io Version: v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group. +kubebuilder:object:generate=true +groupName=backups.cozystack.io
SPDX-License-Identifier: Apache-2.0 Package v1alpha1 defines backups.cozystack.io API types.
Group: backups.cozystack.io Version: v1alpha1
SPDX-License-Identifier: Apache-2.0 Package v1alpha1 defines backups.cozystack.io API types.
Group: backups.cozystack.io Version: v1alpha1
Index ¶
- Constants
- Variables
- func NormalizeApplicationRef(ref corev1.TypedLocalObjectReference) corev1.TypedLocalObjectReference
- type ApplicationSelector
- type Backup
- type BackupArtifact
- type BackupClass
- type BackupClassList
- type BackupClassSpec
- type BackupClassStatus
- type BackupClassStrategy
- type BackupJob
- type BackupJobList
- type BackupJobPhase
- type BackupJobSpec
- type BackupJobStatus
- type BackupList
- type BackupPhase
- type BackupSpec
- type BackupStatus
- type Plan
- type PlanList
- type PlanSchedule
- type PlanScheduleType
- type PlanSpec
- type PlanStatus
- type RestoreJob
- type RestoreJobList
- type RestoreJobPhase
- type RestoreJobSpec
- type RestoreJobStatus
Constants ¶
const ( OwningJobNameLabel = thisGroup + "/owned-by.BackupJobName" OwningJobNamespaceLabel = thisGroup + "/owned-by.BackupJobNamespace" // DefaultApplicationAPIGroup is the default API group for applications // when not specified in ApplicationRef or ApplicationSelector. DefaultApplicationAPIGroup = "apps.cozystack.io" )
const (
PlanConditionError = "Error"
)
Condtions
Variables ¶
var ( GroupVersion = schema.GroupVersion{Group: thisGroup, Version: thisVersion} SchemeBuilder = runtime.NewSchemeBuilder(addGroupVersion) AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func NormalizeApplicationRef ¶
func NormalizeApplicationRef(ref corev1.TypedLocalObjectReference) corev1.TypedLocalObjectReference
NormalizeApplicationRef sets the default apiGroup to DefaultApplicationAPIGroup if it's not specified. This function is exported so it can be used by other packages (e.g., controllers, factories).
Types ¶
type ApplicationSelector ¶
type ApplicationSelector struct {
// APIGroup is the API group of the application.
// If not specified, defaults to "apps.cozystack.io".
// +optional
APIGroup *string `json:"apiGroup,omitempty"`
// Kind is the kind of the application (e.g., VirtualMachine, MariaDB).
Kind string `json:"kind"`
}
ApplicationSelector specifies which application types a strategy applies to.
func (*ApplicationSelector) DeepCopy ¶
func (in *ApplicationSelector) DeepCopy() *ApplicationSelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationSelector.
func (*ApplicationSelector) DeepCopyInto ¶
func (in *ApplicationSelector) DeepCopyInto(out *ApplicationSelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Backup ¶
type Backup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec BackupSpec `json:"spec,omitempty"`
Status BackupStatus `json:"status,omitempty"`
}
Backup represents a single backup artifact for a given application.
func (*Backup) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Backup.
func (*Backup) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Backup) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupArtifact ¶
type BackupArtifact struct {
// URI is a driver-/storage-specific URI pointing to the backup artifact.
// For example: s3://bucket/prefix/file.tar.gz
URI string `json:"uri"`
// SizeBytes is the size of the artifact in bytes, if known.
// +optional
SizeBytes int64 `json:"sizeBytes,omitempty"`
// Checksum is the checksum of the artifact, if computed.
// For example: "sha256:<hex>".
// +optional
Checksum string `json:"checksum,omitempty"`
}
BackupArtifact describes the stored backup object (tarball, snapshot, etc.).
func (*BackupArtifact) DeepCopy ¶
func (in *BackupArtifact) DeepCopy() *BackupArtifact
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupArtifact.
func (*BackupArtifact) DeepCopyInto ¶
func (in *BackupArtifact) DeepCopyInto(out *BackupArtifact)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupClass ¶
type BackupClass struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec BackupClassSpec `json:"spec,omitempty"`
Status BackupClassStatus `json:"status,omitempty"`
}
BackupClass defines a class of backup configurations that can be referenced by BackupJob and Plan resources. It encapsulates strategy and storage configuration per application type.
func (*BackupClass) DeepCopy ¶
func (in *BackupClass) DeepCopy() *BackupClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupClass.
func (*BackupClass) DeepCopyInto ¶
func (in *BackupClass) DeepCopyInto(out *BackupClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupClass) DeepCopyObject ¶
func (in *BackupClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupClassList ¶
type BackupClassList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []BackupClass `json:"items"`
}
BackupClassList contains a list of BackupClasses.
func (*BackupClassList) DeepCopy ¶
func (in *BackupClassList) DeepCopy() *BackupClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupClassList.
func (*BackupClassList) DeepCopyInto ¶
func (in *BackupClassList) DeepCopyInto(out *BackupClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupClassList) DeepCopyObject ¶
func (in *BackupClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupClassSpec ¶
type BackupClassSpec struct {
// Strategies is a list of backup strategies, each matching a specific application type.
Strategies []BackupClassStrategy `json:"strategies"`
}
BackupClassSpec defines the desired state of a BackupClass.
func (*BackupClassSpec) DeepCopy ¶
func (in *BackupClassSpec) DeepCopy() *BackupClassSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupClassSpec.
func (*BackupClassSpec) DeepCopyInto ¶
func (in *BackupClassSpec) DeepCopyInto(out *BackupClassSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupClassStatus ¶
type BackupClassStatus struct {
// Conditions represents the latest available observations of a BackupClass's state.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
BackupClassStatus defines the observed state of a BackupClass.
func (*BackupClassStatus) DeepCopy ¶
func (in *BackupClassStatus) DeepCopy() *BackupClassStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupClassStatus.
func (*BackupClassStatus) DeepCopyInto ¶
func (in *BackupClassStatus) DeepCopyInto(out *BackupClassStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupClassStrategy ¶
type BackupClassStrategy struct {
// StrategyRef references the driver-specific BackupStrategy (e.g., Velero).
StrategyRef corev1.TypedLocalObjectReference `json:"strategyRef"`
// Application specifies which application types this strategy applies to.
Application ApplicationSelector `json:"application"`
// Parameters holds strategy-specific and storage-specific parameters.
// Common parameters include:
// - backupStorageLocationName: Name of Velero BackupStorageLocation
// +optional
Parameters map[string]string `json:"parameters,omitempty"`
}
BackupClassStrategy defines a backup strategy for a specific application type.
func (*BackupClassStrategy) DeepCopy ¶
func (in *BackupClassStrategy) DeepCopy() *BackupClassStrategy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupClassStrategy.
func (*BackupClassStrategy) DeepCopyInto ¶
func (in *BackupClassStrategy) DeepCopyInto(out *BackupClassStrategy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupJob ¶
type BackupJob struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec BackupJobSpec `json:"spec,omitempty"`
Status BackupJobStatus `json:"status,omitempty"`
}
BackupJob represents a single execution of a backup. It is typically created by a Plan controller when a schedule fires.
func (*BackupJob) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupJob.
func (*BackupJob) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupJob) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupJobList ¶
type BackupJobList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []BackupJob `json:"items"`
}
BackupJobList contains a list of BackupJobs.
func (*BackupJobList) DeepCopy ¶
func (in *BackupJobList) DeepCopy() *BackupJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupJobList.
func (*BackupJobList) DeepCopyInto ¶
func (in *BackupJobList) DeepCopyInto(out *BackupJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupJobList) DeepCopyObject ¶
func (in *BackupJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupJobPhase ¶
type BackupJobPhase string
BackupJobPhase represents the lifecycle phase of a BackupJob.
const ( BackupJobPhaseEmpty BackupJobPhase = "" BackupJobPhasePending BackupJobPhase = "Pending" BackupJobPhaseRunning BackupJobPhase = "Running" BackupJobPhaseSucceeded BackupJobPhase = "Succeeded" BackupJobPhaseFailed BackupJobPhase = "Failed" )
type BackupJobSpec ¶
type BackupJobSpec struct {
// PlanRef refers to the Plan that requested this backup run.
// For ad-hoc/manual backups, this can be omitted.
// +optional
PlanRef *corev1.LocalObjectReference `json:"planRef,omitempty"`
// ApplicationRef holds a reference to the managed application whose state
// is being backed up.
// If apiGroup is not specified, it defaults to "apps.cozystack.io".
ApplicationRef corev1.TypedLocalObjectReference `json:"applicationRef"`
// BackupClassName references a BackupClass that contains strategy and storage configuration.
// The BackupClass will be resolved to determine the appropriate strategy and storage
// based on the ApplicationRef.
// This field is immutable once the BackupJob is created.
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="backupClassName is immutable"
BackupClassName string `json:"backupClassName"`
}
BackupJobSpec describes the execution of a single backup operation.
func (*BackupJobSpec) DeepCopy ¶
func (in *BackupJobSpec) DeepCopy() *BackupJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupJobSpec.
func (*BackupJobSpec) DeepCopyInto ¶
func (in *BackupJobSpec) DeepCopyInto(out *BackupJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupJobStatus ¶
type BackupJobStatus struct {
// Phase is a high-level summary of the run's state.
// Typical values: Pending, Running, Succeeded, Failed.
// +optional
Phase BackupJobPhase `json:"phase,omitempty"`
// BackupRef refers to the Backup object created by this run, if any.
// +optional
BackupRef *corev1.LocalObjectReference `json:"backupRef,omitempty"`
// StartedAt is the time at which the backup run started.
// +optional
StartedAt *metav1.Time `json:"startedAt,omitempty"`
// CompletedAt is the time at which the backup run completed (successfully
// or otherwise).
// +optional
CompletedAt *metav1.Time `json:"completedAt,omitempty"`
// Message is a human-readable message indicating details about why the
// backup run is in its current phase, if any.
// +optional
Message string `json:"message,omitempty"`
// Conditions represents the latest available observations of a BackupJob's state.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
BackupJobStatus represents the observed state of a BackupJob.
func (*BackupJobStatus) DeepCopy ¶
func (in *BackupJobStatus) DeepCopy() *BackupJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupJobStatus.
func (*BackupJobStatus) DeepCopyInto ¶
func (in *BackupJobStatus) DeepCopyInto(out *BackupJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupList ¶
type BackupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Backup `json:"items"`
}
BackupList contains a list of Backups.
func (*BackupList) DeepCopy ¶
func (in *BackupList) DeepCopy() *BackupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupList.
func (*BackupList) DeepCopyInto ¶
func (in *BackupList) DeepCopyInto(out *BackupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupList) DeepCopyObject ¶
func (in *BackupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupPhase ¶
type BackupPhase string
BackupPhase represents the lifecycle phase of a Backup.
const ( BackupPhaseEmpty BackupPhase = "" BackupPhasePending BackupPhase = "Pending" BackupPhaseReady BackupPhase = "Ready" BackupPhaseFailed BackupPhase = "Failed" )
type BackupSpec ¶
type BackupSpec struct {
// ApplicationRef refers to the application that was backed up.
ApplicationRef corev1.TypedLocalObjectReference `json:"applicationRef"`
// PlanRef refers to the Plan that produced this backup, if any.
// For manually triggered backups, this can be omitted.
// +optional
PlanRef *corev1.LocalObjectReference `json:"planRef,omitempty"`
// StrategyRef refers to the driver-specific BackupStrategy that was used
// to create this backup. This allows the driver to later perform restores.
StrategyRef corev1.TypedLocalObjectReference `json:"strategyRef"`
// TakenAt is the time at which the backup was taken (as reported by the
// driver). It may differ slightly from metadata.creationTimestamp.
TakenAt metav1.Time `json:"takenAt"`
// DriverMetadata holds driver-specific, opaque metadata associated with
// this backup (for example snapshot IDs, schema versions, etc.).
// This data is not interpreted by the core backup controllers.
// +optional
DriverMetadata map[string]string `json:"driverMetadata,omitempty"`
}
BackupSpec describes an immutable backup artifact produced by a BackupJob.
func (*BackupSpec) DeepCopy ¶
func (in *BackupSpec) DeepCopy() *BackupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSpec.
func (*BackupSpec) DeepCopyInto ¶
func (in *BackupSpec) DeepCopyInto(out *BackupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupStatus ¶
type BackupStatus struct {
// Phase is a simple, high-level summary of the backup's state.
// Typical values are: Pending, Ready, Failed.
// +optional
Phase BackupPhase `json:"phase,omitempty"`
// Artifact describes the stored backup object, if available.
// +optional
Artifact *BackupArtifact `json:"artifact,omitempty"`
// Conditions represents the latest available observations of a Backup's state.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
BackupStatus represents the observed state of a Backup.
func (*BackupStatus) DeepCopy ¶
func (in *BackupStatus) DeepCopy() *BackupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStatus.
func (*BackupStatus) DeepCopyInto ¶
func (in *BackupStatus) DeepCopyInto(out *BackupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Plan ¶
type Plan struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PlanSpec `json:"spec,omitempty"`
Status PlanStatus `json:"status,omitempty"`
}
Plan describes the schedule, method and storage location for the backup of a given target application.
func (*Plan) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plan.
func (*Plan) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Plan) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlanList ¶
type PlanList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Plan `json:"items"`
}
PlanList contains a list of backup Plans.
func (*PlanList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlanList.
func (*PlanList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlanList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlanSchedule ¶
type PlanSchedule struct {
// Type is the type of schedule specification. Supported values are
// [`cron`]. If omitted, defaults to `cron`.
// +optional
Type PlanScheduleType `json:"type,omitempty"`
// Cron contains the cron spec for scheduling backups. Must be
// specified if the schedule type is `cron`. Since only `cron` is
// supported, omitting this field is not allowed.
// +optional
Cron string `json:"cron,omitempty"`
}
PlanSchedule specifies when backup copies are created.
func (*PlanSchedule) DeepCopy ¶
func (in *PlanSchedule) DeepCopy() *PlanSchedule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlanSchedule.
func (*PlanSchedule) DeepCopyInto ¶
func (in *PlanSchedule) DeepCopyInto(out *PlanSchedule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlanScheduleType ¶
type PlanScheduleType string
const ( PlanScheduleTypeEmpty PlanScheduleType = "" PlanScheduleTypeCron PlanScheduleType = "cron" )
type PlanSpec ¶
type PlanSpec struct {
// ApplicationRef holds a reference to the managed application,
// whose state and configuration must be backed up.
// If apiGroup is not specified, it defaults to "apps.cozystack.io".
ApplicationRef corev1.TypedLocalObjectReference `json:"applicationRef"`
// BackupClassName references a BackupClass that contains strategy and storage configuration.
// The BackupClass will be resolved to determine the appropriate strategy and storage
// based on the ApplicationRef.
BackupClassName string `json:"backupClassName"`
// Schedule specifies when backup copies are created.
Schedule PlanSchedule `json:"schedule"`
}
PlanSpec references the storage, the strategy, the application to be backed up and specifies the timetable on which the backups will run.
func (*PlanSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlanSpec.
func (*PlanSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlanStatus ¶
func (*PlanStatus) DeepCopy ¶
func (in *PlanStatus) DeepCopy() *PlanStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlanStatus.
func (*PlanStatus) DeepCopyInto ¶
func (in *PlanStatus) DeepCopyInto(out *PlanStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RestoreJob ¶
type RestoreJob struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RestoreJobSpec `json:"spec,omitempty"`
Status RestoreJobStatus `json:"status,omitempty"`
}
RestoreJob represents a single execution of a restore from a Backup.
func (*RestoreJob) DeepCopy ¶
func (in *RestoreJob) DeepCopy() *RestoreJob
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreJob.
func (*RestoreJob) DeepCopyInto ¶
func (in *RestoreJob) DeepCopyInto(out *RestoreJob)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RestoreJob) DeepCopyObject ¶
func (in *RestoreJob) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RestoreJobList ¶
type RestoreJobList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []RestoreJob `json:"items"`
}
RestoreJobList contains a list of RestoreJobs.
func (*RestoreJobList) DeepCopy ¶
func (in *RestoreJobList) DeepCopy() *RestoreJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreJobList.
func (*RestoreJobList) DeepCopyInto ¶
func (in *RestoreJobList) DeepCopyInto(out *RestoreJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RestoreJobList) DeepCopyObject ¶
func (in *RestoreJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RestoreJobPhase ¶
type RestoreJobPhase string
RestoreJobPhase represents the lifecycle phase of a RestoreJob.
const ( RestoreJobPhaseEmpty RestoreJobPhase = "" RestoreJobPhasePending RestoreJobPhase = "Pending" RestoreJobPhaseRunning RestoreJobPhase = "Running" RestoreJobPhaseSucceeded RestoreJobPhase = "Succeeded" RestoreJobPhaseFailed RestoreJobPhase = "Failed" )
type RestoreJobSpec ¶
type RestoreJobSpec struct {
// BackupRef refers to the Backup that should be restored.
BackupRef corev1.LocalObjectReference `json:"backupRef"`
// TargetApplicationRef refers to the application into which the backup
// should be restored. If omitted, the driver SHOULD restore into the same
// application as referenced by backup.spec.applicationRef.
// +optional
TargetApplicationRef *corev1.TypedLocalObjectReference `json:"targetApplicationRef,omitempty"`
}
RestoreJobSpec describes the execution of a single restore operation.
func (*RestoreJobSpec) DeepCopy ¶
func (in *RestoreJobSpec) DeepCopy() *RestoreJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreJobSpec.
func (*RestoreJobSpec) DeepCopyInto ¶
func (in *RestoreJobSpec) DeepCopyInto(out *RestoreJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RestoreJobStatus ¶
type RestoreJobStatus struct {
// Phase is a high-level summary of the run's state.
// Typical values: Pending, Running, Succeeded, Failed.
// +optional
Phase RestoreJobPhase `json:"phase,omitempty"`
// StartedAt is the time at which the restore run started.
// +optional
StartedAt *metav1.Time `json:"startedAt,omitempty"`
// CompletedAt is the time at which the restore run completed (successfully
// or otherwise).
// +optional
CompletedAt *metav1.Time `json:"completedAt,omitempty"`
// Message is a human-readable message indicating details about why the
// restore run is in its current phase, if any.
// +optional
Message string `json:"message,omitempty"`
// Conditions represents the latest available observations of a RestoreJob's state.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
RestoreJobStatus represents the observed state of a RestoreJob.
func (*RestoreJobStatus) DeepCopy ¶
func (in *RestoreJobStatus) DeepCopy() *RestoreJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreJobStatus.
func (*RestoreJobStatus) DeepCopyInto ¶
func (in *RestoreJobStatus) DeepCopyInto(out *RestoreJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.