backup_types.go

/*
Copyright 2021 RadonDB.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta1

import (
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.

// BackupSpec defines the desired state of Backup
type BackupSpec struct {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	// ClusterName is the name of the cluster to be backed up.
	ClusterName string `json:"clusterName,omitempty"`
	// BackupMethod represents the type of backup
	BackupMethod string `json:"method,omitempty"`
	// Defines details for manual  backup Jobs
	// +optional
	Manual *ManualBackup `json:"manual,omitempty"`
	// Backup Schedule
	// +optional
	BackupSchedule *BackupSchedule `json:"schedule,omitempty"`
	// Backup Storage
	BackupOpts BackupOps `json:"backupops,omitempty"`
}

type BackupOps struct {
	// BackupHost
	// +optional
	BackupHost string    `json:"host,omitempty"`
	S3         *S3       `json:"s3,omitempty"`
	NFS        *NFS      `json:"nfs,omitempty"`
	S3Binlog   *S3Binlog `json:"s3binlog,omitempty"`
}

type S3Binlog struct {
	// +optional
	BackupSecretName string `json:"secretName,omitempty"`
}
type S3 struct {
	// S3 Bucket
	// +optional
	BackupSecretName string `json:"secretName,omitempty"`
}

type NFS struct {
	// Defines a Volume for backup MySQL data.
	// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
	Volume corev1.NFSVolumeSource `json:"volume,omitempty"`
}

type ManualBackup struct {
	BackupType string `json:"type,omitempty"`
	// Backup Retention
	// +optional
	// +kubebuilder:default:=7
	BackupRetention *int32 `json:"backupRetention,omitempty"`
}

type BackupSchedule struct {
	// Cron expression for backup schedule
	// +optional
	CronExpression string `json:"cronExpression,omitempty"`
	// Backup Retention
	// +optional
	BackupRetention *int32 `json:"backupRetention,omitempty"`
	BackupType      string `json:"type,omitempty"`
	// History Limit of job
	// +optional
	BackupJobHistoryLimit *int32 `json:"jobhistoryLimit,omitempty"`
}

type BackupStatus struct {
	Type           BackupInitiator     `json:"type,omitempty"`
	BackupName     string              `json:"backupName,omitempty"`
	BackupSize     string              `json:"backupSize,omitempty"`
	BackupType     string              `json:"backupType,omitempty"`
	StartTime      *metav1.Time        `json:"startTime,omitempty"`
	CompletionTime *metav1.Time        `json:"completionTime,omitempty"`
	State          BackupConditionType `json:"state,omitempty"`
	// Get the Gtid
	Gtid             string                  `json:"gtid,omitempty"`
	ManualBackup     *ManualBackupStatus     `json:"manual,omitempty"`
	ScheduledBackups []ScheduledBackupStatus `json:"scheduled,omitempty"`
}

type BackupConditionType string

const (
	// BackupComplete means the backup has finished his execution
	BackupSucceeded BackupConditionType = "Succeeded"
	// BackupFailed means backup has failed
	BackupFailed BackupConditionType = "Failed"
	BackupStart  BackupConditionType = "Started"
	BackupActive BackupConditionType = "Active"
)

type BackupInitiator string

const (
	CronJobBackupInitiator BackupInitiator = "CronJob"
	ManualBackupInitiator  BackupInitiator = "Manual"
)

type ManualBackupStatus struct {
	// Specifies whether or not the Job is finished executing (does not indicate success or
	// failure).
	// +kubebuilder:validation:Required
	Finished   bool   `json:"finished"`
	BackupName string `json:"backupName,omitempty"`
	// Get the backup Date
	StartTime *metav1.Time `json:"startTime,omitempty"`
	// Get the backup Type
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`
	// Conditions represents the backup resource conditions list.
	// +optional
	Succeeded int32 `json:"succeeded,omitempty"`
	// +optional
	// The number of actively running manual backup Pods.
	// +optional
	Active int32  `json:"active,omitempty"`
	Failed int32  `json:"failed,omitempty"`
	Reason string `json:"reason"`
	// Get the backup Type
	BackupType string `json:"backupType,omitempty"`
	// Get the backup Size
	BackupSize string `json:"backupSize,omitempty"`
	// Get the Gtid
	Gtid string `json:"gtid,omitempty"`
	// Get current backup status
	State BackupConditionType `json:"state,omitempty"`
}

type ScheduledBackupStatus struct {
	// The name of the associated  scheduled backup CronJob
	// +kubebuilder:validation:Required
	CronJobName string `json:"cronJobName,omitempty"`
	// Get the backup path.
	BackupName string `json:"backupName,omitempty"`
	// Specifies whether or not the Job is finished executing (does not indicate success or
	// failure).
	// +kubebuilder:validation:Required
	Finished bool `json:"finished"`
	// Get the backup Type
	BackupType string `json:"backupType,omitempty"`
	// Get the backup Date
	StartTime *metav1.Time `json:"startTime,omitempty"`
	// Get the backup Type
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`
	// Conditions represents the backup resource conditions list.
	// +optional
	Succeeded int32 `json:"succeeded,omitempty"`
	// +optional
	Failed int32  `json:"failed,omitempty"`
	Reason string `json:"reason"`
	// Get the backup Size
	BackupSize string `json:"backupSize,omitempty"`
	// Get the Gtid
	Gtid string `json:"gtid,omitempty"`
	// Get current backup status
	State BackupConditionType `json:"state,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:storageversion
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="BackupName",type="string",JSONPath=".status.backupName",description="The Backup name"
// +kubebuilder:printcolumn:name="StartTime",type="string",JSONPath=".status.startTime",description="The Backup Start time"
// +kubebuilder:printcolumn:name="completionTime",type="string",JSONPath=".status.completionTime",description="The Backup CompletionTime time"
// +kubebuilder:printcolumn:name="Type",type="string",JSONPath=".status.backupType",description="The Backup Type"
// +kubebuilder:printcolumn:name="Initiator",type="string",JSONPath=".status.type",description="The Backup Initiator"
// +kubebuilder:printcolumn:name="State",type="string",JSONPath=".status.state",description="The Backup State"
// +kubebuilder:printcolumn:name="Size",type="string",JSONPath=".status.backupSize",description="The Backup State"

// Backup is the Schema for the backups API
type Backup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BackupSpec   `json:"spec,omitempty"`
	Status BackupStatus `json:"status,omitempty"`
}

//+kubebuilder:object:root=true

// BackupList contains a list of Backup
type BackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Backup `json:"items"`
}

func init() {
	SchemeBuilder.Register(&Backup{}, &BackupList{})
}