v1alpha1

Documentation

Overview

+kubebuilder:object:generate=true +groupName=elasticdl.org

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type ElasticDLJob
  • func (in *ElasticDLJob) DeepCopy() *ElasticDLJob
  • func (in *ElasticDLJob) DeepCopyInto(out *ElasticDLJob)
  • func (in *ElasticDLJob) DeepCopyObject() runtime.Object
• type ElasticDLJobList
  • func (in *ElasticDLJobList) DeepCopy() *ElasticDLJobList
  • func (in *ElasticDLJobList) DeepCopyInto(out *ElasticDLJobList)
  • func (in *ElasticDLJobList) DeepCopyObject() runtime.Object
• type ElasticDLJobSpec
  • func (in *ElasticDLJobSpec) DeepCopy() *ElasticDLJobSpec
  • func (in *ElasticDLJobSpec) DeepCopyInto(out *ElasticDLJobSpec)

Constants

const (
	DefaultContainerName = "elasticdl"
	DefaultPortName      = "elasticdl-port"
	DefaultPort          = 11111
)

const (
	Kind         = "ElasticDLJob"
	GroupName    = "elasticdl.org"
	GroupVersion = "v1alpha1"
)

const (
	// ElasticDLReplicaTypeMaster is the type of Master of distributed ElasticDL
	ElasticDLReplicaTypeMaster common.ReplicaType = "Master"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: GroupVersion}

	GroupVersionKind = SchemeGroupVersion.WithKind(Kind)

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group-qualified GroupResource.

Types

type ElasticDLJob

type ElasticDLJob struct {
	// Standard Kubernetes type metadata.
	metav1.TypeMeta `json:",inline"`

	// Standard Kubernetes object's metadata.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired state of the ElasticDLJob.
	Spec ElasticDLJobSpec `json:"spec,omitempty"`

	// Most recently observed status of the ElasticDLJob.
	// Read-only (modified by the system).
	Status common.JobStatus `json:"status,omitempty"`
}

ElasticDLJob Represents an elasticdl Job instance

func (*ElasticDLJob) DeepCopy

func (in *ElasticDLJob) DeepCopy() *ElasticDLJob

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

func (*ElasticDLJob) DeepCopyInto

func (in *ElasticDLJob) DeepCopyInto(out *ElasticDLJob)

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

func (*ElasticDLJob) DeepCopyObject

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

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

type ElasticDLJobList

type ElasticDLJobList struct {
	// Standard type metadata.
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata.
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of ElasticDLJobs.
	Items []ElasticDLJob `json:"items"`
}

ElasticDLJobList is a list of ElasticDLJobs.

func (*ElasticDLJobList) DeepCopy

func (in *ElasticDLJobList) DeepCopy() *ElasticDLJobList

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

func (*ElasticDLJobList) DeepCopyInto

func (in *ElasticDLJobList) DeepCopyInto(out *ElasticDLJobList)

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

func (*ElasticDLJobList) DeepCopyObject

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

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

type ElasticDLJobSpec

type ElasticDLJobSpec 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.
	common.RunPolicy `json:",inline"`

	// A map of ElasticDLReplicaType (type) to ReplicaSpec (value). Specifies the ElasticDL cluster configuration.
	// For example,
	//   {
	//     "Master": ElasticDLReplicaSpec,
	//   }
	ElasticDLReplicaSpecs map[common.ReplicaType]*common.ReplicaSpec `json:"elasticdlReplicaSpecs"`
}

ElasticDLJobSpec is a desired state description of the ElasticDLJob.

func (*ElasticDLJobSpec) DeepCopy

func (in *ElasticDLJobSpec) DeepCopy() *ElasticDLJobSpec

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

func (*ElasticDLJobSpec) DeepCopyInto

func (in *ElasticDLJobSpec) DeepCopyInto(out *ElasticDLJobSpec)

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