k8c.io/api/v3@v3.0.0-20230904060738-b0a93889c0b6/pkg/apis/kubermatic/v1/ee.etcd_backup_config.go

/*
Copyright 2023 The Kubermatic Kubernetes Platform contributors.

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 v1

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

// +kubebuilder:validation:Enum=Running;Completed;Failed

// EtcdBackupPhase is used to indicate the type of a EtcdBackupConfig condition.
// For all condition types, the `true` value must indicate success.
type EtcdBackupPhase string

const (
	// EtcdBackupPhaseRunning indicates that the corresponding job has started.
	EtcdBackupPhaseRunning EtcdBackupPhase = "Running"

	// EtcdBackupPhaseCompleted indicates that the corresponding job has completed successfully.
	EtcdBackupPhaseCompleted EtcdBackupPhase = "Completed"

	// EtcdBackupPhaseFailed indicates that the corresponding job has completed with an error.
	EtcdBackupPhaseFailed EtcdBackupPhase = "Failed"
)

// +kubebuilder:validation:Enum=SchedulingActive

// EtcdBackupConfigConditionType is used to indicate the type of a EtcdBackupConfig condition. For all condition
// types, the `true` value must indicate success. All condition types must be registered within
// the `AllClusterConditionTypes` variable.
type EtcdBackupConfigConditionType string

const (
	// EtcdBackupConfigConditionSchedulingActive indicates that the EtcdBackupConfig is active, i.e.
	// new backups are being scheduled according to the config's schedule.
	EtcdBackupConfigConditionSchedulingActive EtcdBackupConfigConditionType = "SchedulingActive"
)

// +genclient
// +kubebuilder:object:generate=true
// +kubebuilder:resource:categories=kkpee
// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:JSONPath=".spec.cluster.name",name="Cluster",type="string"
// +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name="Age",type="date"

// EtcdBackupConfig specifies the configuration for a usercluster etcd backup.
//
// Note that this resource is part of a KKP Enterprise feature and is not used in the Community Edition.
type EtcdBackupConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   EtcdBackupConfigSpec   `json:"spec,omitempty"`
	Status EtcdBackupConfigStatus `json:"status,omitempty"`
}

// EtcdBackupConfigSpec specifies details of an etcd backup.
type EtcdBackupConfigSpec struct {
	// Name defines the name of the backup
	// The name of the backup file in S3 will be <cluster>-<backup name>
	// If a schedule is set (see below), -<timestamp> will be appended.
	Name string `json:"name"`
	// Cluster is the reference to the cluster whose etcd will be backed up.
	Cluster ClusterReference `json:"cluster"`
	// Schedule is a cron expression defining when to perform
	// the backup. If not set, the backup is performed exactly
	// once, immediately.
	Schedule string `json:"schedule,omitempty"`
	// Keep is the number of backups to keep around before deleting the oldest one
	// If not set, defaults to DefaultKeptBackupsCount. Only used if Schedule is set.
	Keep *int `json:"keep,omitempty"`
	// Destination indicates where the backup will be stored. The destination name must correspond to a destination in
	// the cluster's Seed.Spec.EtcdBackupRestore.
	Destination string `json:"destination"`
}

// +kubebuilder:object:generate=true
// +kubebuilder:object:root=true

// EtcdBackupConfigList is a list of etcd backup configs.
type EtcdBackupConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

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

type EtcdBackupConfigStatus struct {
	// CurrentBackups tracks the creation and deletion progress of all backups managed by the EtcdBackupConfig
	CurrentBackups []BackupStatus `json:"currentBackups,omitempty"`
	// Conditions contains conditions of the EtcdBackupConfig
	Conditions map[EtcdBackupConfigConditionType]EtcdBackupConfigCondition `json:"conditions,omitempty"`
	// If the controller was configured with a cleanupContainer, CleanupRunning keeps track of the corresponding job
	CleanupRunning bool `json:"cleanupRunning,omitempty"`
}

type BackupStatus struct {
	// ScheduledTime will always be set when the BackupStatus is created, so it'll never be nil
	// +optional
	ScheduledTime metav1.Time `json:"scheduledTime,omitempty"`
	BackupName    string      `json:"backupName,omitempty"`
	JobName       string      `json:"jobName,omitempty"`
	// +optional
	BackupStartTime metav1.Time `json:"backupStartTime,omitempty"`
	// +optional
	BackupFinishedTime metav1.Time     `json:"backupFinishedTime,omitempty"`
	BackupPhase        EtcdBackupPhase `json:"backupPhase,omitempty"`
	BackupMessage      string          `json:"backupMessage,omitempty"`
	DeleteJobName      string          `json:"deleteJobName,omitempty"`
	// +optional
	DeleteStartTime metav1.Time `json:"deleteStartTime,omitempty"`
	// +optional
	DeleteFinishedTime metav1.Time     `json:"deleteFinishedTime,omitempty"`
	DeletePhase        EtcdBackupPhase `json:"deletePhase,omitempty"`
	DeleteMessage      string          `json:"deleteMessage,omitempty"`
}

type EtcdBackupConfigCondition struct {
	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`
	// Last time we got an update on a given condition.
	LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}