v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the xgboostjob v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/xgboost-operator/pkg/apis/xgboostjob +k8s:defaulter-gen=TypeMeta +groupName=xgboostjob.kubeflow.org

Package v1alpha1 contains API Schema definitions for the xgboostjob v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/xgboost-operator/pkg/apis/xgboostjob +k8s:defaulter-gen=TypeMeta +groupName=xgboostjob.kubeflow.org

Index

• Constants
• Variables
• func Int32(v int32) *int32
• func RegisterDefaults(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• func SetDefaults_XGBJob(xgbJob *XGBoostJob)
• func SetObjectDefaults_XGBoostJob(in *XGBoostJob)
• func SetObjectDefaults_XGBoostJobList(in *XGBoostJobList)
• type XGBoostJob
  • func (in *XGBoostJob) DeepCopy() *XGBoostJob
  • func (in *XGBoostJob) DeepCopyInto(out *XGBoostJob)
  • func (in *XGBoostJob) DeepCopyObject() runtime.Object
• type XGBoostJobList
  • func (in *XGBoostJobList) DeepCopy() *XGBoostJobList
  • func (in *XGBoostJobList) DeepCopyInto(out *XGBoostJobList)
  • func (in *XGBoostJobList) DeepCopyObject() runtime.Object
• type XGBoostJobSpec
  • func (in *XGBoostJobSpec) DeepCopy() *XGBoostJobSpec
  • func (in *XGBoostJobSpec) DeepCopyInto(out *XGBoostJobSpec)
• type XGBoostJobStatus
  • func (in *XGBoostJobStatus) DeepCopy() *XGBoostJobStatus
  • func (in *XGBoostJobStatus) DeepCopyInto(out *XGBoostJobStatus)

Constants

const (
	// GroupName is the group name use in this package.
	GroupName = "kubeflow.org"
	// Kind is the kind name.
	Kind = "XGBoostJob"
	// GroupVersion is the version.
	GroupVersion = "v1alpha1"
	// Plural is the Plural for XGBoostJob.
	Plural = "xgboostjobs"
	// Singular is the singular for XGBoostJob.
	Singular = "xgboostjob"
	// XGBOOSTCRD is the CRD name for XGBoostJob.
	XGBoostCRD = "xgboostjobs.kubeflow.org"

	DefaultContainerName     = "xgboostjob"
	DefaultContainerPortName = "xgboostjob-port"
	DefaultPort              = 9999
	DefaultTTLseconds        = int32(100)
	DefaultCleanPodPolicy    = v1.CleanPodPolicyNone
)

const (
	// XGBoostReplicaTypeMaster is the type of Master of distributed PyTorch
	XGBoostReplicaTypeMaster commonv1.ReplicaType = "Master"

	// XGBoostReplicaTypeWorker is the type for workers of distributed PyTorch.
	XGBoostReplicaTypeWorker commonv1.ReplicaType = "Worker"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "xgboostjob.kubeflow.org", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// SchemeGroupVersionKind is the GroupVersionKind of the resource.
	SchemeGroupVersionKind = SchemeGroupVersion.WithKind(Kind)

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Int32

func Int32(v int32) *int32

Int32 is a helper routine that allocates a new int32 value to store v and returns a pointer to it.

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

func SetDefaults_XGBJob

func SetDefaults_XGBJob(xgbJob *XGBoostJob)

SetDefaults_XGBJob sets any unspecified values to defaults.

func SetObjectDefaults_XGBoostJob

func SetObjectDefaults_XGBoostJob(in *XGBoostJob)

func SetObjectDefaults_XGBoostJobList

func SetObjectDefaults_XGBoostJobList(in *XGBoostJobList)

Types

type XGBoostJob

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

	Spec   XGBoostJobSpec   `json:"spec,omitempty"`
	Status XGBoostJobStatus `json:"status,omitempty"`
}

XGBoostJob is the Schema for the xgboostjobs API +k8s:openapi-gen=true

func (*XGBoostJob) DeepCopy

func (in *XGBoostJob) DeepCopy() *XGBoostJob

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

func (*XGBoostJob) DeepCopyInto

func (in *XGBoostJob) DeepCopyInto(out *XGBoostJob)

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

func (*XGBoostJob) DeepCopyObject

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

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

type XGBoostJobList

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

XGBoostJobList contains a list of XGBoostJob

func (*XGBoostJobList) DeepCopy

func (in *XGBoostJobList) DeepCopy() *XGBoostJobList

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

func (*XGBoostJobList) DeepCopyInto

func (in *XGBoostJobList) DeepCopyInto(out *XGBoostJobList)

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

func (*XGBoostJobList) DeepCopyObject

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

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

type XGBoostJobSpec

type XGBoostJobSpec struct {
	// RunPolicy encapsulates various runtime policies of the distributed training
	// job, for example how to clean up resources and how long the job can stay
	// active.
	RunPolicy commonv1.RunPolicy `json:",inline"`

	// XGBoostReplicaSpecs is map of ReplicaType and ReplicaSpec
	// specifies the XGBoost replicas to run.
	// For example,
	//   {
	//     "PS": ReplicaSpec,
	//     "Worker": ReplicaSpec,
	//   }
	XGBReplicaSpecs map[commonv1.ReplicaType]*commonv1.ReplicaSpec `json:"xgbReplicaSpecs"`
}

XGBoostJobSpec defines the desired state of XGBoostJob

func (*XGBoostJobSpec) DeepCopy

func (in *XGBoostJobSpec) DeepCopy() *XGBoostJobSpec

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

func (*XGBoostJobSpec) DeepCopyInto

func (in *XGBoostJobSpec) DeepCopyInto(out *XGBoostJobSpec)

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

type XGBoostJobStatus

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

XGBoostJobStatus defines the observed state of XGBoostJob

func (*XGBoostJobStatus) DeepCopy

func (in *XGBoostJobStatus) DeepCopy() *XGBoostJobStatus

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

func (*XGBoostJobStatus) DeepCopyInto

func (in *XGBoostJobStatus) DeepCopyInto(out *XGBoostJobStatus)

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