v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the control v1alpha1 API group +kubebuilder:object:generate=true +groupName=control.k8ssandra.io

Index

• Constants
• Variables
• type K8ssandraTask
  • func (in *K8ssandraTask) DeepCopy() *K8ssandraTask
  • func (in *K8ssandraTask) DeepCopyInto(out *K8ssandraTask)
  • func (in *K8ssandraTask) DeepCopyObject() runtime.Object
  • func (t *K8ssandraTask) GetClusterKey() client.ObjectKey
  • func (t *K8ssandraTask) GetConditionStatus(conditionType cassapi.JobConditionType) metav1.ConditionStatus
  • func (t *K8ssandraTask) RefreshGlobalStatus(expectedDcCount int)
  • func (t *K8ssandraTask) SetCondition(condition cassapi.JobConditionType, status metav1.ConditionStatus) bool
  • func (t *K8ssandraTask) SetDcStatus(dcName string, dcStatus cassapi.CassandraTaskStatus)
• type K8ssandraTaskList
  • func (in *K8ssandraTaskList) DeepCopy() *K8ssandraTaskList
  • func (in *K8ssandraTaskList) DeepCopyInto(out *K8ssandraTaskList)
  • func (in *K8ssandraTaskList) DeepCopyObject() runtime.Object
• type K8ssandraTaskSpec
  • func (in *K8ssandraTaskSpec) DeepCopy() *K8ssandraTaskSpec
  • func (in *K8ssandraTaskSpec) DeepCopyInto(out *K8ssandraTaskSpec)
• type K8ssandraTaskStatus
  • func (in *K8ssandraTaskStatus) DeepCopy() *K8ssandraTaskStatus
  • func (in *K8ssandraTaskStatus) DeepCopyInto(out *K8ssandraTaskStatus)

Constants

const (
	K8ssandraTaskNameLabel      = "k8ssandra.io/task-name"
	K8ssandraTaskNamespaceLabel = "k8ssandra.io/task-namespace"
)

const (
	JobInvalid cassapi.JobConditionType = "Invalid"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "control.k8ssandra.io", 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
)

Types

type K8ssandraTask

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

	Spec   K8ssandraTaskSpec   `json:"spec,omitempty"`
	Status K8ssandraTaskStatus `json:"status,omitempty"`
}

+kubebuilder:printcolumn:name="Job",type=string,JSONPath=".spec.template.jobs[0].command",description="The job that is executed" +kubebuilder:printcolumn:name="Scheduled",type="date",JSONPath=".spec.template.scheduledTime",description="When the execution of the task is allowed at earliest" +kubebuilder:printcolumn:name="Started",type="date",JSONPath=".status.startTime",description="When the execution of the task started" +kubebuilder:printcolumn:name="Completed",type="date",JSONPath=".status.completionTime",description="When the execution of the task finished" K8ssandraTask is the Schema for the k8ssandratasks API

func (*K8ssandraTask) DeepCopy

func (in *K8ssandraTask) DeepCopy() *K8ssandraTask

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

func (*K8ssandraTask) DeepCopyInto

func (in *K8ssandraTask) DeepCopyInto(out *K8ssandraTask)

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

func (*K8ssandraTask) DeepCopyObject

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

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

func (*K8ssandraTask) GetClusterKey

func (t *K8ssandraTask) GetClusterKey() client.ObjectKey

func (*K8ssandraTask) GetConditionStatus

func (t *K8ssandraTask) GetConditionStatus(conditionType cassapi.JobConditionType) metav1.ConditionStatus

func (*K8ssandraTask) RefreshGlobalStatus

func (t *K8ssandraTask) RefreshGlobalStatus(expectedDcCount int)

func (*K8ssandraTask) SetCondition

func (t *K8ssandraTask) SetCondition(condition cassapi.JobConditionType, status metav1.ConditionStatus) bool

func (*K8ssandraTask) SetDcStatus

func (t *K8ssandraTask) SetDcStatus(dcName string, dcStatus cassapi.CassandraTaskStatus)

type K8ssandraTaskList

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

K8ssandraTaskList contains a list of K8ssandraTask

func (*K8ssandraTaskList) DeepCopy

func (in *K8ssandraTaskList) DeepCopy() *K8ssandraTaskList

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

func (*K8ssandraTaskList) DeepCopyInto

func (in *K8ssandraTaskList) DeepCopyInto(out *K8ssandraTaskList)

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

func (*K8ssandraTaskList) DeepCopyObject

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

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

type K8ssandraTaskSpec

type K8ssandraTaskSpec struct {

	// Which K8ssandraCluster this task is operating on.
	Cluster corev1.ObjectReference `json:"cluster,omitempty"`

	// The names of the targeted datacenters. If omitted, will default to all DCs in spec order.
	Datacenters []string `json:"datacenters,omitempty"`

	// How to handle concurrency across DCs. Valid values are:
	// - "Forbid" (default): sequential processing. The K8ssandraTask only spawns one CassandraTask at a time, which
	//   must run to completion before the CassandraTask for the next DC is created. If any CassandraTask fails, the
	//   K8ssandraTask is marked as failed, and the remaining CassandraTasks are cancelled (i.e. never created).
	// - "Allow": parallel processing. The K8ssandraTask spawns all CassandraTasks at once. If any CassandraTask fails,
	//   the K8ssandraTask is marked as failed, but the remaining CassandraTasks finish running.
	// +optional
	DcConcurrencyPolicy batchv1.ConcurrencyPolicy `json:"dcConcurrencyPolicy,omitempty"`

	// The characteristics of the CassandraTask that will get created for each DC.
	Template cassapi.CassandraTaskTemplate `json:"template,omitempty"`
}

K8ssandraTaskSpec defines the desired state of K8ssandraTask

func (*K8ssandraTaskSpec) DeepCopy

func (in *K8ssandraTaskSpec) DeepCopy() *K8ssandraTaskSpec

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

func (*K8ssandraTaskSpec) DeepCopyInto

func (in *K8ssandraTaskSpec) DeepCopyInto(out *K8ssandraTaskSpec)

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

type K8ssandraTaskStatus

type K8ssandraTaskStatus struct {
	cassapi.CassandraTaskStatus `json:",inline"`

	// The individual progress of the CassandraTask in each datacenter.
	Datacenters map[string]cassapi.CassandraTaskStatus `json:"datacenters,omitempty"`
}

K8ssandraTaskStatus defines the observed state of K8ssandraTask

func (*K8ssandraTaskStatus) DeepCopy

func (in *K8ssandraTaskStatus) DeepCopy() *K8ssandraTaskStatus

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

func (*K8ssandraTaskStatus) DeepCopyInto

func (in *K8ssandraTaskStatus) DeepCopyInto(out *K8ssandraTaskStatus)

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