vshn/k8up

package v1

import (
    "strings"

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

// ScheduleSpec defines the schedules for the various job types.
type ScheduleSpec struct {
    Restore *RestoreSchedule `json:"restore,omitempty"`
    Backup  *BackupSchedule  `json:"backup,omitempty"`
    Archive *ArchiveSchedule `json:"archive,omitempty"`
    Check   *CheckSchedule   `json:"check,omitempty"`
    Prune   *PruneSchedule   `json:"prune,omitempty"`
    Backend *Backend         `json:"backend,omitempty"`

    // KeepJobs amount of jobs to keep for later analysis.
    //
    // Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.
    // +optional
    KeepJobs *int `json:"keepJobs,omitempty"`
    // FailedJobsHistoryLimit amount of failed jobs to keep for later analysis.
    // KeepJobs is used property is not specified.
    // +optional
    FailedJobsHistoryLimit *int `json:"failedJobsHistoryLimit,omitempty"`
    // SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis.
    // KeepJobs is used property is not specified.
    // +optional
    SuccessfulJobsHistoryLimit *int `json:"successfulJobsHistoryLimit,omitempty"`

    // ResourceRequirementsTemplate describes the compute resource requirements (cpu, memory, etc.)
    ResourceRequirementsTemplate corev1.ResourceRequirements `json:"resourceRequirementsTemplate,omitempty"`

    // PodSecurityContext describes the security context with which actions (such as backups) shall be executed.
    PodSecurityContext *corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`
}

// ScheduleDefinition is the actual cron-type expression that defines the interval of the actions.
type ScheduleDefinition string

// ScheduleCommon contains fields every schedule needs
type ScheduleCommon struct {
    Schedule              ScheduleDefinition `json:"schedule,omitempty"`
    ConcurrentRunsAllowed bool               `json:"concurrentRunsAllowed,omitempty"`
}

// RestoreSchedule manages schedules for the restore service
type RestoreSchedule struct {
    RestoreSpec     `json:",inline"`
    *ScheduleCommon `json:",inline"`
}

// BackupSchedule manages schedules for the backup service
type BackupSchedule struct {
    BackupSpec      `json:",inline"`
    *ScheduleCommon `json:",inline"`
}

// ArchiveSchedule manages schedules for the archival service
type ArchiveSchedule struct {
    ArchiveSpec     `json:",inline"`
    *ScheduleCommon `json:",inline"`
}

// CheckSchedule manages the schedules for the checks
type CheckSchedule struct {
    CheckSpec       `json:",inline"`
    *ScheduleCommon `json:",inline"`
}

// PruneSchedule manages the schedules for the prunes
type PruneSchedule struct {
    PruneSpec       `json:",inline"`
    *ScheduleCommon `json:",inline"`
}

// ScheduleStatus defines the observed state of Schedule
type ScheduleStatus struct {
    // Conditions provide a standard mechanism for higher-level status reporting from a controller.
    // They are an extension mechanism which allows tools and other controllers to collect summary information about
    // resources without needing to understand resource-specific status details.
    Conditions []metav1.Condition `json:"conditions,omitempty"`
    // EffectiveSchedules contains a list of schedules generated from randomizing schedules.
    EffectiveSchedules []EffectiveSchedule `json:"effectiveSchedules,omitempty"`
}

type EffectiveSchedule struct {
    JobType           JobType            `json:"jobType,omitempty"`
    GeneratedSchedule ScheduleDefinition `json:"generatedSchedule,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status

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

    Spec   ScheduleSpec   `json:"spec,omitempty"`
    Status ScheduleStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

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

const (
    // ScheduleFinalizerName is a Finalizer added to resources that need cleanup cron schedules before deleting them.
    ScheduleFinalizerName = "k8up.io/schedule"

    // Deprecated: Migrate to ScheduleFinalizerName
    LegacyScheduleFinalizerName = "k8up.syn.tools/schedule"
)

func init() {
    SchemeBuilder.Register(&Schedule{}, &ScheduleList{})
}

func (s *Schedule) GetRuntimeObject() runtime.Object {
    return s
}

func (s *Schedule) GetMetaObject() metav1.Object {
    return s
}

// GetJobName implements the JobObject interface.
func (s *Schedule) GetJobName() string {
    return s.GetType().String() + "-" + s.Name
}

func (*Schedule) GetType() JobType {
    return ScheduleType
}

// GetStatus retrieves the Status property
func (s *Schedule) GetStatus() Status {
    return Status{Conditions: s.Status.Conditions}
}

// SetStatus sets the Status.Conditions property
func (s *Schedule) SetStatus(status Status) {
    s.Status.Conditions = status.Conditions
}

// GetResources returns the resource requirements
func (s *Schedule) GetResources() corev1.ResourceRequirements {
    return s.Spec.ResourceRequirementsTemplate
}

// GetPodSecurityContext returns the pod security context
func (s *Schedule) GetPodSecurityContext() *corev1.PodSecurityContext {
    return s.Spec.PodSecurityContext
}

// GetActiveDeadlineSeconds implements JobObject
func (s *Schedule) GetActiveDeadlineSeconds() *int64 {
    return nil
}

// GetFailedJobsHistoryLimit returns failed jobs history limit.
// Returns KeepJobs if unspecified.
func (s *Schedule) GetFailedJobsHistoryLimit() *int {
    if s.Spec.FailedJobsHistoryLimit != nil {
        return s.Spec.FailedJobsHistoryLimit
    }
    return s.Spec.KeepJobs
}

// GetSuccessfulJobsHistoryLimit returns successful jobs history limit.
// Returns KeepJobs if unspecified.
func (s *Schedule) GetSuccessfulJobsHistoryLimit() *int {
    if s.Spec.SuccessfulJobsHistoryLimit != nil {
        return s.Spec.SuccessfulJobsHistoryLimit
    }
    return s.Spec.KeepJobs
}

// String casts the value to string.
// "aScheduleDefinition.String()" and "string(aScheduleDefinition)" are equivalent.
func (s ScheduleDefinition) String() string {
    return string(s)
}

// IsNonStandard returns true if the value begins with "@",
// indicating a special definition.
// Two examples are '@daily' and '@daily-random'.
func (s ScheduleDefinition) IsNonStandard() bool {
    return strings.HasPrefix(string(s), "@")
}

// IsRandom is true if the value is a special definition (as indicated by IsNonStandard)
// and if it ends with '-random'.
// Two examples are '@daily-random' and '@weekly-random'.
func (s ScheduleDefinition) IsRandom() bool {
    return s.IsNonStandard() && strings.HasSuffix(string(s), "-random")
}