v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the elastic v1alpha1 API group +kubebuilder:object:generate=true +groupName=elastic.pytorch.org

Index

• Constants
• Variables
• type ElasticJob
  • func (in *ElasticJob) DeepCopy() *ElasticJob
  • func (in *ElasticJob) DeepCopyInto(out *ElasticJob)
  • func (in *ElasticJob) DeepCopyObject() runtime.Object
• type ElasticJobList
  • func (in *ElasticJobList) DeepCopy() *ElasticJobList
  • func (in *ElasticJobList) DeepCopyInto(out *ElasticJobList)
  • func (in *ElasticJobList) DeepCopyObject() runtime.Object
• type ElasticJobReplicaType
• type ElasticJobSpec
  • func (in *ElasticJobSpec) DeepCopy() *ElasticJobSpec
  • func (in *ElasticJobSpec) DeepCopyInto(out *ElasticJobSpec)
• type ElasticJobStatus
  • func (in *ElasticJobStatus) DeepCopy() *ElasticJobStatus
  • func (in *ElasticJobStatus) DeepCopyInto(out *ElasticJobStatus)

Constants

const (
	// Kind is the kind name.
	Kind = "ElasticJob"

	DefaultContainerName     = "elasticjob-worker"
	DefaultContainerPortName = "elasticjob-port"
	DefaultPort              = 10291
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "elastic.pytorch.org", 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 ElasticJob

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

	Spec   ElasticJobSpec   `json:"spec,omitempty"`
	Status ElasticJobStatus `json:"status,omitempty"`
}

ElasticJob is the Schema for the elasticjobs API

func (*ElasticJob) DeepCopy

func (in *ElasticJob) DeepCopy() *ElasticJob

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

func (*ElasticJob) DeepCopyInto

func (in *ElasticJob) DeepCopyInto(out *ElasticJob)

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

func (*ElasticJob) DeepCopyObject

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

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

type ElasticJobList

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

ElasticJobList contains a list of ElasticJob

func (*ElasticJobList) DeepCopy

func (in *ElasticJobList) DeepCopy() *ElasticJobList

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

func (*ElasticJobList) DeepCopyInto

func (in *ElasticJobList) DeepCopyInto(out *ElasticJobList)

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

func (*ElasticJobList) DeepCopyObject

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

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

type ElasticJobReplicaType

type ElasticJobReplicaType common.ReplicaType

const (
	// ElasticReplicaTypeEtcd is the type for etcd of Elastic Job.
	ElasticReplicaTypeEtcd ElasticJobReplicaType = "Etcd"

	// ElasticReplicaTypeWorker is the type for workers of Elastic Job.
	ElasticReplicaTypeWorker ElasticJobReplicaType = "Worker"
)

type ElasticJobSpec

type ElasticJobSpec struct {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	RunPolicy common.RunPolicy `json:",inline"`

	// +kubebuilder:validation:MinItems=1
	ReplicaSpecs map[common.ReplicaType]*common.ReplicaSpec `json:"replicaSpecs"`
	RdzvEndpoint string                                     `json:"rdzvEndpoint"`

	// +kubebuilder:validation:Minimum=1
	MinReplicas *int32 `json:"minReplicas,omitempty"`
	MaxReplicas *int32 `json:"maxReplicas,omitempty"`
}

+kubebuilder:printcolumn:name="Min",type=integer,JSONPath=`.spec.minReplicas` +kubebuilder:printcolumn:name="Max",type=integer,JSONPath=`.spec.maxReplicas` +kubebuilder:printcolumn:name="Desired",type=integer,JSONPath=`.spec.replicaSpecs[Worker].replicas` +kubebuilder:printcolumn:name="rdzvEndpoint",type=string,JSONPath=`.spec.rdzvEndpoint` ElasticJobSpec defines the desired state of ElasticJob

func (*ElasticJobSpec) DeepCopy

func (in *ElasticJobSpec) DeepCopy() *ElasticJobSpec

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

func (*ElasticJobSpec) DeepCopyInto

func (in *ElasticJobSpec) DeepCopyInto(out *ElasticJobSpec)

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

type ElasticJobStatus

type ElasticJobStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	common.JobStatus `json:",inline"`
}

ElasticJobStatus defines the observed state of ElasticJob

func (*ElasticJobStatus) DeepCopy

func (in *ElasticJobStatus) DeepCopy() *ElasticJobStatus

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

func (*ElasticJobStatus) DeepCopyInto

func (in *ElasticJobStatus) DeepCopyInto(out *ElasticJobStatus)

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