control

type AsyncTaskExecutorFunc ¶

type AsyncTaskExecutorFunc func(httphelper.NodeMgmtClient, *corev1.Pod, *TaskConfiguration) (string, error)

AsyncTaskExecutorFunc is called for all methods that support async processing

type CassandraTaskReconciler ¶

type CassandraTaskReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

CassandraTaskReconciler reconciles a CassandraJob object

func (r *CassandraTaskReconciler) HasCondition(task *api.CassandraTask, condition api.JobConditionType, status metav1.ConditionStatus) bool

func (r *CassandraTaskReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (r *CassandraTaskReconciler) SetupWithManager(mgr ctrl.Manager) error

type Clock ¶ added in v1.24.0

type Clock interface {
	Now() time.Time
}

type JobStatus ¶

type JobStatus struct {
	Id      string `json:"id,omitempty"`
	Status  string `json:"status,omitempty"`
	Handler string `json:"handler,omitempty"`
	Retries int    `json:"retries,omitempty"`
}

type PodFilterFunc ¶

type PodFilterFunc func(*corev1.Pod, *TaskConfiguration) bool

PodFilterFunc approves or rejects the target pod for processing purposes.

type ProcessFunc ¶

type ProcessFunc func(*TaskConfiguration) error

ProcessFunc is a function that's run before the pods are being processed individually, or after the pods have been processed.

type RealClock ¶ added in v1.24.0

type RealClock struct{}

func (r *RealClock) Now() time.Time

type ScheduledTaskReconciler ¶ added in v1.24.0

type ScheduledTaskReconciler struct {
	client.Client
	Scheme *runtime.Scheme
	Clock  Clock
	Log    logr.Logger
}

ScheduledTaskReconciler reconciles a ScheduledTask object

func (r *ScheduledTaskReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (r *ScheduledTaskReconciler) SetupWithManager(mgr ctrl.Manager) error

type SyncTaskExecutorFunc ¶

type SyncTaskExecutorFunc func(httphelper.NodeMgmtClient, *corev1.Pod, *TaskConfiguration) error

SyncTaskExecutorFunc is called as a backup if async one isn't supported

type TaskConfiguration ¶

type TaskConfiguration struct {
	// Meta / status
	Id            string
	TaskStartTime *metav1.Time
	Datacenter    *cassapi.CassandraDatacenter
	Context       context.Context
	Job           api.CassandraCommand

	// Input parameters
	RestartPolicy     corev1.RestartPolicy
	Arguments         api.JobArguments
	MaxConcurrentPods *int
	Retries           *int

	// Execution functionality per pod
	AsyncFeature httphelper.Feature
	AsyncFunc    AsyncTaskExecutorFunc
	SyncFeature  httphelper.Feature
	SyncFunc     SyncTaskExecutorFunc
	PodFilter    PodFilterFunc

	// Functions not targeting the pod
	ValidateFunc   ValidatorFunc
	PreProcessFunc ProcessFunc

	// Status tracking
	Completed int
}

TaskConfiguration sets the command's functions to execute

func (t *TaskConfiguration) Filter(pod *corev1.Pod) bool

func (t *TaskConfiguration) PreProcess() error

func (t *TaskConfiguration) Validate() (bool, error)

type ValidatorFunc ¶

type ValidatorFunc func(*TaskConfiguration) (bool, error)

ValidatorFunc validates that necessary parameters are set for the task. If false is returned, the task has failed the validation and the error has the details. If true is returned, the error is transient and should be retried.