v1

Documentation

Overview

Package v1 contains API Schema definitions for the v1 API group +kubebuilder:object:generate=true +groupName=kube-shuffle-sharder.io

Index

• Variables
• type ShuffleShard
  • func (in *ShuffleShard) DeepCopy() *ShuffleShard
  • func (in *ShuffleShard) DeepCopyInto(out *ShuffleShard)
  • func (in *ShuffleShard) DeepCopyObject() runtime.Object
  • func (r *ShuffleShard) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *ShuffleShard) ValidateCreate() (admission.Warnings, error)
  • func (r *ShuffleShard) ValidateDelete() (admission.Warnings, error)
  • func (r *ShuffleShard) ValidateUpdate(old runtime.Object) (admission.Warnings, error)
• type ShuffleShardList
  • func (in *ShuffleShardList) DeepCopy() *ShuffleShardList
  • func (in *ShuffleShardList) DeepCopyInto(out *ShuffleShardList)
  • func (in *ShuffleShardList) DeepCopyObject() runtime.Object
• type ShuffleShardSpec
  • func (in *ShuffleShardSpec) DeepCopy() *ShuffleShardSpec
  • func (in *ShuffleShardSpec) DeepCopyInto(out *ShuffleShardSpec)
• type ShuffleShardStatus
  • func (in *ShuffleShardStatus) DeepCopy() *ShuffleShardStatus
  • func (in *ShuffleShardStatus) DeepCopyInto(out *ShuffleShardStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "kube-shuffle-sharder.io", Version: "v1"}

	// 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
)

var ErrCannotCastToShard = errors.New("cannot cast object to ShuffleShard")

var ErrDuplicateNodeGroups = errors.New("spec.nodeGroups must contain unique elements")

var ErrEmptyNodeGroup = errors.New("spec.nodeGroups must not contain an empty string")

var ErrMissingTenant = errors.New("spec.tenant must not be empty")

var ErrNotEnoughNodeGroups = errors.New("spec.nodeGroups must contain at least 2 elements")

var ErrShuffleShardIsImmutable = errors.New("ShuffleShard is immutable")

Types

type ShuffleShard

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

	Spec   ShuffleShardSpec   `json:"spec,omitempty"`
	Status ShuffleShardStatus `json:"status,omitempty"`
}

ShuffleShard is the Schema for the shuffleshards API

func (*ShuffleShard) DeepCopy

func (in *ShuffleShard) DeepCopy() *ShuffleShard

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

func (*ShuffleShard) DeepCopyInto

func (in *ShuffleShard) DeepCopyInto(out *ShuffleShard)

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

func (*ShuffleShard) DeepCopyObject

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

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

func (*ShuffleShard) SetupWebhookWithManager

func (r *ShuffleShard) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*ShuffleShard) ValidateCreate

func (r *ShuffleShard) ValidateCreate() (admission.Warnings, error)

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*ShuffleShard) ValidateDelete

func (r *ShuffleShard) ValidateDelete() (admission.Warnings, error)

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*ShuffleShard) ValidateUpdate

func (r *ShuffleShard) ValidateUpdate(old runtime.Object) (admission.Warnings, error)

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type ShuffleShardList

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

ShuffleShardList contains a list of ShuffleShard

func (*ShuffleShardList) DeepCopy

func (in *ShuffleShardList) DeepCopy() *ShuffleShardList

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

func (*ShuffleShardList) DeepCopyInto

func (in *ShuffleShardList) DeepCopyInto(out *ShuffleShardList)

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

func (*ShuffleShardList) DeepCopyObject

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

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

type ShuffleShardSpec

type ShuffleShardSpec struct {

	// Tenant is a unique identifier representing the tenant to which a ShuffleShard is assigned
	Tenant string `json:"tenant"`
	// NodeGroups is a unique combination of nodes representing an individual ShuffleShard
	NodeGroups []string `json:"nodeGroups"`
}

ShuffleShardSpec defines the desired state of ShuffleShard

func (*ShuffleShardSpec) DeepCopy

func (in *ShuffleShardSpec) DeepCopy() *ShuffleShardSpec

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

func (*ShuffleShardSpec) DeepCopyInto

func (in *ShuffleShardSpec) DeepCopyInto(out *ShuffleShardSpec)

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

type ShuffleShardStatus

type ShuffleShardStatus struct {

	// ShardHash is a hash value representing the unique value of the ShuffleShard
	ShardHash string `json:"shardHash"`
}

ShuffleShardStatus defines the observed state of ShuffleShard

func (*ShuffleShardStatus) DeepCopy

func (in *ShuffleShardStatus) DeepCopy() *ShuffleShardStatus

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

func (*ShuffleShardStatus) DeepCopyInto

func (in *ShuffleShardStatus) DeepCopyInto(out *ShuffleShardStatus)

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