v1alpha1

package
v0.6.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 29, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the backup v1alpha1 API group +kubebuilder:object:generate=true +groupName=backup.finleap.cloud

Index

Constants

View Source 
const BackupPlanKind = "BackupPlan"
View Source 
const ConsulBackupPlanKind = "ConsulBackupPlan"
View Source 
const ConsulBackupPlanWorkerCommand = "consul"
View Source 
const MongoDBBackupPlanKind = "MongoDBBackupPlan"
View Source 
const MongoDBBackupPlanWorkerCommand = "mongodb"

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "backup.finleap.cloud", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type BackupPlan 

type BackupPlan interface {
	runtime.Object
	metav1.Object
	GetTypeMeta() *metav1.TypeMeta
	GetObjectMeta() *metav1.ObjectMeta
	GetSpec() *BackupPlanSpec
	GetStatus() *BackupPlanStatus
	GetKind() string
	GetCmd() string
	GetSecretData() ([]byte, error)
	New() BackupPlan
}

BackupPlan defines the interface of all BackupPlans

type BackupPlanSpec 

type BackupPlanSpec struct {
	// Schedule in cron format
	Schedule string `json:"schedule"`

	// +kubebuilder:validation:Minimum=1
	//
	ActiveDeadlineSeconds int64 `json:"activeDeadlineSeconds"`

	// +kubebuilder:validation:Minimum=1
	// Number of backups to keep
	Retention int64 `json:"retention"`

	// +optional
	// Environments for the CronJob
	Env []corev1.EnvVar `json:"env,omitempty"`

	// +optional
	// Setup for metrics
	Pushgateway *Pushgateway `json:"pushgateway,omitempty"`

	// +optional
	// Destination for the backup. If none is provided the default destination
	// will be tried.
	Destination *Destination `json:"destination,omitempty"`

	// +optional
	// Volumes to  bind to the pod
	Volumes []corev1.Volume `json:"volumes,omitempty"`

	// +optional
	// VolumeMounts for the pod's container
	VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"`
}

BackupPlanSpec defines the desired state of BackupPlan

func (*BackupPlanSpec) DeepCopy 

func (in *BackupPlanSpec) DeepCopy() *BackupPlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupPlanSpec.

func (*BackupPlanSpec) DeepCopyInto 

func (in *BackupPlanSpec) DeepCopyInto(out *BackupPlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupPlanStatus 

type BackupPlanStatus struct {
	CronJob *corev1.ObjectReference `json:"cronJob,omitempty"`
	Secret  *corev1.ObjectReference `json:"secret,omitempty"`
}

BackupPlanStatus defines the observed state of BackupPlan

func (*BackupPlanStatus) DeepCopy 

func (in *BackupPlanStatus) DeepCopy() *BackupPlanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupPlanStatus.

func (*BackupPlanStatus) DeepCopyInto 

func (in *BackupPlanStatus) DeepCopyInto(out *BackupPlanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConsulBackupPlan 

type ConsulBackupPlan struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ConsulBackupPlanSpec `json:"spec,omitempty"`
	Status BackupPlanStatus     `json:"status,omitempty"`
}

ConsulBackupPlan is the Schema for the consulbackupplans API

func (*ConsulBackupPlan) DeepCopy 

func (in *ConsulBackupPlan) DeepCopy() *ConsulBackupPlan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsulBackupPlan.

func (*ConsulBackupPlan) DeepCopyInto 

func (in *ConsulBackupPlan) DeepCopyInto(out *ConsulBackupPlan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsulBackupPlan) DeepCopyObject 

func (in *ConsulBackupPlan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ConsulBackupPlan) GetCmd 

func (p *ConsulBackupPlan) GetCmd() string

func (*ConsulBackupPlan) GetKind 

func (p *ConsulBackupPlan) GetKind() string

func (*ConsulBackupPlan) GetObjectMeta 

func (p *ConsulBackupPlan) GetObjectMeta() *metav1.ObjectMeta

func (*ConsulBackupPlan) GetSecretData 

func (p *ConsulBackupPlan) GetSecretData() ([]byte, error)

func (*ConsulBackupPlan) GetSpec 

func (p *ConsulBackupPlan) GetSpec() *BackupPlanSpec

func (*ConsulBackupPlan) GetStatus 

func (p *ConsulBackupPlan) GetStatus() *BackupPlanStatus

func (*ConsulBackupPlan) GetTypeMeta 

func (p *ConsulBackupPlan) GetTypeMeta() *metav1.TypeMeta

func (*ConsulBackupPlan) New 

func (p *ConsulBackupPlan) New() BackupPlan

type ConsulBackupPlanList 

type ConsulBackupPlanList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ConsulBackupPlan `json:"items"`
}

ConsulBackupPlanList contains a list of ConsulBackupPlan

func (*ConsulBackupPlanList) DeepCopy 

func (in *ConsulBackupPlanList) DeepCopy() *ConsulBackupPlanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsulBackupPlanList.

func (*ConsulBackupPlanList) DeepCopyInto 

func (in *ConsulBackupPlanList) DeepCopyInto(out *ConsulBackupPlanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ConsulBackupPlanList) DeepCopyObject 

func (in *ConsulBackupPlanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ConsulBackupPlanSpec 

type ConsulBackupPlanSpec struct {
	BackupPlanSpec `json:",inline"`

	// Address of Consul. Environment variables
	// will be evaluated before usage.
	Address string `json:"address"`

	// +optional
	// Username to authenticate with consul
	Username string `json:"username,omitempty"`

	// +optional
	// Password to authenticate with consul
	Password string `json:"password,omitempty"`
}

ConsulBackupPlanSpec defines the desired state of ConsulBackupPlan

func (*ConsulBackupPlanSpec) DeepCopy 

func (in *ConsulBackupPlanSpec) DeepCopy() *ConsulBackupPlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsulBackupPlanSpec.

func (*ConsulBackupPlanSpec) DeepCopyInto 

func (in *ConsulBackupPlanSpec) DeepCopyInto(out *ConsulBackupPlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Destination 

type Destination struct {
	// +optional
	// Configuration for S3 as backup target
	S3 *S3 `json:"s3,omitempty"`
}

func (*Destination) DeepCopy 

func (in *Destination) DeepCopy() *Destination

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Destination.

func (*Destination) DeepCopyInto 

func (in *Destination) DeepCopyInto(out *Destination)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MongoDBBackupPlan 

type MongoDBBackupPlan struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   MongoDBBackupPlanSpec `json:"spec,omitempty"`
	Status BackupPlanStatus      `json:"status,omitempty"`
}

MongoDBBackupPlan is the Schema for the mongodbbackupplans API

func (*MongoDBBackupPlan) DeepCopy 

func (in *MongoDBBackupPlan) DeepCopy() *MongoDBBackupPlan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDBBackupPlan.

func (*MongoDBBackupPlan) DeepCopyInto 

func (in *MongoDBBackupPlan) DeepCopyInto(out *MongoDBBackupPlan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MongoDBBackupPlan) DeepCopyObject 

func (in *MongoDBBackupPlan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*MongoDBBackupPlan) GetCmd 

func (p *MongoDBBackupPlan) GetCmd() string

func (*MongoDBBackupPlan) GetKind 

func (p *MongoDBBackupPlan) GetKind() string

func (*MongoDBBackupPlan) GetObjectMeta 

func (p *MongoDBBackupPlan) GetObjectMeta() *metav1.ObjectMeta

func (*MongoDBBackupPlan) GetSecretData 

func (p *MongoDBBackupPlan) GetSecretData() ([]byte, error)

func (*MongoDBBackupPlan) GetSpec 

func (p *MongoDBBackupPlan) GetSpec() *BackupPlanSpec

func (*MongoDBBackupPlan) GetStatus 

func (p *MongoDBBackupPlan) GetStatus() *BackupPlanStatus

func (*MongoDBBackupPlan) GetTypeMeta 

func (p *MongoDBBackupPlan) GetTypeMeta() *metav1.TypeMeta

func (*MongoDBBackupPlan) New 

func (p *MongoDBBackupPlan) New() BackupPlan

type MongoDBBackupPlanList 

type MongoDBBackupPlanList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []MongoDBBackupPlan `json:"items"`
}

MongoDBBackupPlanList contains a list of MongoDBBackupPlan

func (*MongoDBBackupPlanList) DeepCopy 

func (in *MongoDBBackupPlanList) DeepCopy() *MongoDBBackupPlanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDBBackupPlanList.

func (*MongoDBBackupPlanList) DeepCopyInto 

func (in *MongoDBBackupPlanList) DeepCopyInto(out *MongoDBBackupPlanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MongoDBBackupPlanList) DeepCopyObject 

func (in *MongoDBBackupPlanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MongoDBBackupPlanSpec 

type MongoDBBackupPlanSpec struct {
	BackupPlanSpec `json:",inline"`

	// Fully qualifying MongoDB URI connection string. Environment variables
	// will be evaluated before usage.
	URI string `json:"uri"`
}

MongoDBBackupPlanSpec defines the desired state of MongoDBBackupPlan

func (*MongoDBBackupPlanSpec) DeepCopy 

func (in *MongoDBBackupPlanSpec) DeepCopy() *MongoDBBackupPlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDBBackupPlanSpec.

func (*MongoDBBackupPlanSpec) DeepCopyInto 

func (in *MongoDBBackupPlanSpec) DeepCopyInto(out *MongoDBBackupPlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Pushgateway 

type Pushgateway struct {
	// +optional
	URL string `json:"url,omitempty"`
	// +optional
	Username string `json:"username,omitempty"`
	// +optional
	Password string `json:"password,omitempty"`
}

func (*Pushgateway) DeepCopy 

func (in *Pushgateway) DeepCopy() *Pushgateway

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pushgateway.

func (*Pushgateway) DeepCopyInto 

func (in *Pushgateway) DeepCopyInto(out *Pushgateway)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type S3 

type S3 struct {
	// +optional
	Endpoint string `json:"endpoint,omitempty"`
	// +optional
	Bucket string `json:"bucket,omitempty"`
	// +optional
	UseSSL bool `json:"useSSL,omitempty"`
	// +optional
	AccessKeyID string `json:"accessKeyID,omitempty"`
	// +optional
	SecretAccessKey string `json:"secretAccessKey,omitempty"`
	// +optional
	EncryptionKey string `json:"encryptionKey,omitempty"`
	// +optional
	EncryptionAlgorithm string `json:"encryptionAlgorithm,omitempty"`
	// +optional
	PartSize int64 `json:"partSize,omitempty"`
}

func (*S3) DeepCopy 

func (in *S3) DeepCopy() *S3

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3.

func (*S3) DeepCopyInto 

func (in *S3) DeepCopyInto(out *S3)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.