Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group +kubebuilder:object:generate=true +groupName=core.polyaxon.com
Index ¶
- Constants
- Variables
- type KFKind
- type KFReplicaType
- type KFSpec
- type PolyaxonBaseJobCondition
- type PolyaxonBaseJobConditionType
- type PolyaxonBaseJobSpec
- type PolyaxonBaseJobStatus
- type PolyaxonDeploymentCondition
- type PolyaxonDeploymentConditionType
- type PolyaxonDeploymentSpec
- type PolyaxonDeploymentStatus
- type PolyaxonJob
- func (instance *PolyaxonJob) AddFinalizer()
- func (in *PolyaxonJob) DeepCopy() *PolyaxonJob
- func (in *PolyaxonJob) DeepCopyInto(out *PolyaxonJob)
- func (in *PolyaxonJob) DeepCopyObject() runtime.Object
- func (instance *PolyaxonJob) HasFinalizer() bool
- func (instance *PolyaxonJob) HasWarning() bool
- func (instance *PolyaxonJob) IsBeingDeleted() bool
- func (instance *PolyaxonJob) IsDone() bool
- func (instance *PolyaxonJob) IsFailed() bool
- func (instance *PolyaxonJob) IsRunning() bool
- func (instance *PolyaxonJob) IsStarting() bool
- func (instance *PolyaxonJob) IsStopped() bool
- func (instance *PolyaxonJob) IsSucceeded() bool
- func (instance *PolyaxonJob) LogFailed(reason, message string) bool
- func (instance *PolyaxonJob) LogRunning() bool
- func (instance *PolyaxonJob) LogStarting() bool
- func (instance *PolyaxonJob) LogStopped(reason, message string) bool
- func (instance *PolyaxonJob) LogSucceeded() bool
- func (instance *PolyaxonJob) LogWarning(reason, message string) bool
- func (instance *PolyaxonJob) RemoveFinalizer()
- type PolyaxonJobList
- type PolyaxonKF
- func (instance *PolyaxonKF) AddFinalizer()
- func (in *PolyaxonKF) DeepCopy() *PolyaxonKF
- func (in *PolyaxonKF) DeepCopyInto(out *PolyaxonKF)
- func (in *PolyaxonKF) DeepCopyObject() runtime.Object
- func (instance *PolyaxonKF) HasFinalizer() bool
- func (instance *PolyaxonKF) HasWarning() bool
- func (instance *PolyaxonKF) IsBeingDeleted() bool
- func (instance *PolyaxonKF) IsDone() bool
- func (instance *PolyaxonKF) IsFailed() bool
- func (instance *PolyaxonKF) IsRunning() bool
- func (instance *PolyaxonKF) IsStarting() bool
- func (instance *PolyaxonKF) IsStopped() bool
- func (instance *PolyaxonKF) IsSucceeded() bool
- func (instance *PolyaxonKF) LogFailed(reason, message string)
- func (instance *PolyaxonKF) LogRunning()
- func (instance *PolyaxonKF) LogStarting()
- func (instance *PolyaxonKF) LogStopped(reason, message string)
- func (instance *PolyaxonKF) LogSucceeded()
- func (instance *PolyaxonKF) LogWarning(reason, message string)
- func (instance *PolyaxonKF) RemoveFinalizer()
- type PolyaxonKFList
- type PolyaxonNotebook
- func (instance *PolyaxonNotebook) AddFinalizer()
- func (in *PolyaxonNotebook) DeepCopy() *PolyaxonNotebook
- func (in *PolyaxonNotebook) DeepCopyInto(out *PolyaxonNotebook)
- func (in *PolyaxonNotebook) DeepCopyObject() runtime.Object
- func (instance *PolyaxonNotebook) HasFinalizer() bool
- func (instance *PolyaxonNotebook) HasWarning() bool
- func (instance *PolyaxonNotebook) IsBeingDeleted() bool
- func (instance *PolyaxonNotebook) IsDone() bool
- func (instance *PolyaxonNotebook) IsFailed() bool
- func (instance *PolyaxonNotebook) IsRunning() bool
- func (instance *PolyaxonNotebook) IsStarting() bool
- func (instance *PolyaxonNotebook) IsStopped() bool
- func (instance *PolyaxonNotebook) IsSucceeded() bool
- func (instance *PolyaxonNotebook) LogFailed(reason, message string)
- func (instance *PolyaxonNotebook) LogRunning()
- func (instance *PolyaxonNotebook) LogStarting()
- func (instance *PolyaxonNotebook) LogStopped(reason, message string)
- func (instance *PolyaxonNotebook) LogSucceeded()
- func (instance *PolyaxonNotebook) LogWarning(reason, message string)
- func (instance *PolyaxonNotebook) RemoveFinalizer()
- type PolyaxonNotebookList
- type PolyaxonTensorboard
- func (instance *PolyaxonTensorboard) AddFinalizer()
- func (in *PolyaxonTensorboard) DeepCopy() *PolyaxonTensorboard
- func (in *PolyaxonTensorboard) DeepCopyInto(out *PolyaxonTensorboard)
- func (in *PolyaxonTensorboard) DeepCopyObject() runtime.Object
- func (instance *PolyaxonTensorboard) HasFinalizer() bool
- func (instance *PolyaxonTensorboard) HasWarning() bool
- func (instance *PolyaxonTensorboard) IsBeingDeleted() bool
- func (instance *PolyaxonTensorboard) IsDone() bool
- func (instance *PolyaxonTensorboard) IsFailed() bool
- func (instance *PolyaxonTensorboard) IsRunning() bool
- func (instance *PolyaxonTensorboard) IsStarting() bool
- func (instance *PolyaxonTensorboard) IsStopped() bool
- func (instance *PolyaxonTensorboard) IsSucceeded() bool
- func (instance *PolyaxonTensorboard) LogFailed(reason, message string)
- func (instance *PolyaxonTensorboard) LogRunning()
- func (instance *PolyaxonTensorboard) LogStarting()
- func (instance *PolyaxonTensorboard) LogStopped(reason, message string)
- func (instance *PolyaxonTensorboard) LogSucceeded()
- func (instance *PolyaxonTensorboard) LogWarning(reason, message string)
- func (instance *PolyaxonTensorboard) RemoveFinalizer()
- type PolyaxonTensorboardList
Constants ¶
const PolyaxonJobFinalizerName = "job.finalizers.polyaxon.com"
PolyaxonJobFinalizerName registration
const PolyaxonKFFinalizerName = "kf.finalizers.polyaxon.com"
PolyaxonKFFinalizerName registration
const PolyaxonNotebookFinalizerName = "notebook.finalizers.polyaxon.com"
PolyaxonNotebookFinalizerName registration
const PolyaxonTensorboardFinalizerName = "tensorboard.finalizers.polyaxon.com"
PolyaxonTensorboardFinalizerName registration
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "core.polyaxon.com", 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 )
Functions ¶
This section is empty.
Types ¶
type KFKind ¶
type KFKind string
KFKind represents the valid Kubeflow kinds
const ( // TFJob represent the Tensorflow operator TFJob KFKind = "TFJob" // PyTorchJob represent the PyTorch operator PyTorchJob KFKind = "PyTorchJob" // MPIJob represent the MPI operator MPIJob KFKind = "MPIJob" // MXJob represent the MXNet operator MXJob KFKind = "MXJob" // XGBoostJob represent the XGBoost operator XGBoostJob KFKind = "XGBoostJob" )
type KFReplicaType ¶
type KFReplicaType kfcommonv1.ReplicaType
KFReplicaType is the type for KF Replica.
const ( // KFReplicaTypeLauncher is the type for launcher replica. KFReplicaTypeLauncher KFReplicaType = "Launcher" // KFReplicaTypeWorker is the type for worker replicas. KFReplicaTypeWorker KFReplicaType = "Worker" // KFReplicaTypePS is the type for parameter servers. KFReplicaTypePS KFReplicaType = "PS" // KFReplicaTypeChief is the type for chief worker. KFReplicaTypeChief KFReplicaType = "Chief" // TFReplicaTypeMaster is the type for master worker. TFReplicaTypeMaster KFReplicaType = "Master" // KFReplicaTypeEval is the type for evaluation replica (TF). KFReplicaTypeEval KFReplicaType = "Evaluator" // KFReplicaTypeScheduler is the type for scheduler replica (MXNet). KFReplicaTypeScheduler KFReplicaType = "Scheduler" // KFReplicaTypeServer is the type for parameter servers (MXNet). KFReplicaTypeServer KFReplicaType = "Server" )
type KFSpec ¶
type KFSpec struct { // Specifies the Kubeflow kind opertor to use KFKind KFKind `json:"kfKind"` // Specifies the number of retries before marking this job failed. // +optional BackoffLimit *int32 `json:"backoffLimit,omitempty" default:"1" protobuf:"varint,1,opt,name=replicas"` // Specifies the duration (in seconds) since startTime during which the job can remain active // before it is terminated. Must be a positive integer. // This setting applies only to pods where restartPolicy is OnFailure or Always. // +optional ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"` // Defines the policy for cleaning up pods after the Job completes. // Defaults to Running. CleanPodPolicy *kfcommonv1.CleanPodPolicy `json:"cleanPodPolicy,omitempty"` // Defines the TTL for cleaning up finished Jobs (temporary // before kubernetes adds the cleanup controller) TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"` // `ReplicaSpecs` contains maps from `KFReplicaType` to `ReplicaSpec` that // specify the corresponding replicas to run. ReplicaSpecs map[KFReplicaType]kfcommonv1.ReplicaSpec `json:"replicaSpecs"` }
KFSpec defines the desired state of PolyaxonKFJob
func (*KFSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KFSpec.
func (*KFSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonBaseJobCondition ¶
type PolyaxonBaseJobCondition struct { // Type is the type of the condition. Type PolyaxonBaseJobConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // The last time this condition was updated. // +optional LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"` // Last time the condition transitioned. // +optional LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // The reasonfor this container condition. // +optional Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. // +optional Message string `json:"message,omitempty"` }
PolyaxonBaseJobCondition defines the conditions of PolyaxonBaseJobStatus
func (*PolyaxonBaseJobCondition) DeepCopy ¶
func (in *PolyaxonBaseJobCondition) DeepCopy() *PolyaxonBaseJobCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonBaseJobCondition.
func (*PolyaxonBaseJobCondition) DeepCopyInto ¶
func (in *PolyaxonBaseJobCondition) DeepCopyInto(out *PolyaxonBaseJobCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonBaseJobConditionType ¶
type PolyaxonBaseJobConditionType string
PolyaxonBaseJobConditionType maps the conditions a polyaxon job once deployed
const ( // JobStarting means underlaying Job has started. JobStarting PolyaxonBaseJobConditionType = "Starting" // JobRunning means underlaying Job is running, JobRunning PolyaxonBaseJobConditionType = "Running" // JobWarning means underlaying Job has some issues. JobWarning PolyaxonBaseJobConditionType = "Warning" // JobSucceeded means underlaying Job has completed successfully. JobSucceeded PolyaxonBaseJobConditionType = "Succeeded" // JobFailed means underlaying Job has failed. JobFailed PolyaxonBaseJobConditionType = "Failed" // JobStopped means that the Job was stopped/killed. JobStopped PolyaxonBaseJobConditionType = "Stopped" )
type PolyaxonBaseJobSpec ¶
type PolyaxonBaseJobSpec struct { // Specifies the number of retries before marking this job failed. // Defaults to 1 // +optional BackoffLimit *int32 `json:"backoffLimit,omitempty" default:"1" protobuf:"varint,1,opt,name=backoffLimit"` // Specifies the duration (in seconds) since startTime during which the job can remain active // before it is terminated. Must be a positive integer. // This setting applies only to pods where restartPolicy is OnFailure or Always. // +optional ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=activeDeadlineSeconds"` // ttlSecondsAfterFinished limits the lifetime of a Job that has finished // execution (either Complete or Failed). If this field is set, // ttlSecondsAfterFinished after the Job finishes, it is eligible to be // automatically deleted. When the Job is being deleted, its lifecycle // guarantees (e.g. finalizers) will be honored. If this field is unset, // the Job won't be automatically deleted. If this field is set to zero, // the Job becomes eligible to be deleted immediately after it finishes. // This field is alpha-level and is only honored by servers that enable the // TTLAfterFinished feature. // TODO:(Mourad) (Cleanup logic once kubernetes adds the cleanup controller) // +optional TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty" protobuf:"varint,3,opt,name=ttlSecondsAfterFinished"` // Template describes the pods that will be created. Template corev1.PodTemplateSpec `json:"template" protobuf:"bytes,4,opt,name=template"` }
PolyaxonBaseJobSpec defines the desired state of PolyaxonPod
func (*PolyaxonBaseJobSpec) DeepCopy ¶
func (in *PolyaxonBaseJobSpec) DeepCopy() *PolyaxonBaseJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonBaseJobSpec.
func (*PolyaxonBaseJobSpec) DeepCopyInto ¶
func (in *PolyaxonBaseJobSpec) DeepCopyInto(out *PolyaxonBaseJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonBaseJobStatus ¶
type PolyaxonBaseJobStatus struct { // The latest available observations of an object's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions []PolyaxonBaseJobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // Represents the time when the job was acknowledged by the controller. // It is not guaranteed to be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. StartTime *metav1.Time `json:"startTime,omitempty"` // Represents the time when the job was completed. It is not guaranteed to // be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. CompletionTime *metav1.Time `json:"completionTime,omitempty"` // Represents the last time when the job was reconciled. // It is not guaranteed to be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. LastReconcileTime *metav1.Time `json:"lastReconcileTime,omitempty"` }
PolyaxonBaseJobStatus defines the observed state of PolyaxonBaseJob
func (*PolyaxonBaseJobStatus) DeepCopy ¶
func (in *PolyaxonBaseJobStatus) DeepCopy() *PolyaxonBaseJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonBaseJobStatus.
func (*PolyaxonBaseJobStatus) DeepCopyInto ¶
func (in *PolyaxonBaseJobStatus) DeepCopyInto(out *PolyaxonBaseJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonDeploymentCondition ¶
type PolyaxonDeploymentCondition struct { // Type is the type of the condition. Type PolyaxonDeploymentConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // The last time this condition was updated. // +optional LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"` // Last time the condition transitioned. // +optional LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // (brief) reason the container is in the current state // +optional Reason string `json:"reason,omitempty"` // Message regarding why the container is in the current state. // +optional Message string `json:"message,omitempty"` }
PolyaxonDeploymentCondition defines the conditions of PolyaxonDeploymentStatus
func (*PolyaxonDeploymentCondition) DeepCopy ¶
func (in *PolyaxonDeploymentCondition) DeepCopy() *PolyaxonDeploymentCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonDeploymentCondition.
func (*PolyaxonDeploymentCondition) DeepCopyInto ¶
func (in *PolyaxonDeploymentCondition) DeepCopyInto(out *PolyaxonDeploymentCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonDeploymentConditionType ¶
type PolyaxonDeploymentConditionType string
PolyaxonDeploymentConditionType maps the conditions a polyaxon deployment once deployed
const ( // DeploymentStarting means underlaying Deployment has started. DeploymentStarting PolyaxonDeploymentConditionType = "Starting" // DeploymentRunning means underlaying Deployment is running, DeploymentRunning PolyaxonDeploymentConditionType = "Running" // DeploymentWarning means underlaying Deployment has some issues. DeploymentWarning PolyaxonDeploymentConditionType = "Warning" // DeploymentSucceeded means underlaying JDeploymentob has completed successfully. DeploymentSucceeded PolyaxonDeploymentConditionType = "Succeeded" // DeploymentFailed means underlaying Deployment has failed. DeploymentFailed PolyaxonDeploymentConditionType = "Failed" // DeploymentStopped means that the Deployment was stopped/killed. DeploymentStopped PolyaxonDeploymentConditionType = "Stopped" )
type PolyaxonDeploymentSpec ¶
type PolyaxonDeploymentSpec struct { // Replicas is the number of desired replicas. // This is a pointer to distinguish between explicit zero and unspecified. // Defaults to 1. // +optional Replicas *int32 `json:"replicas,omitempty" default:"1" protobuf:"varint,1,opt,name=replicas"` // Template describes the pods that will be created. Template corev1.PodTemplateSpec `json:"template" protobuf:"bytes,3,opt,name=template"` }
PolyaxonDeploymentSpec defines the desired state of PolyaxonDeployment
func (*PolyaxonDeploymentSpec) DeepCopy ¶
func (in *PolyaxonDeploymentSpec) DeepCopy() *PolyaxonDeploymentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonDeploymentSpec.
func (*PolyaxonDeploymentSpec) DeepCopyInto ¶
func (in *PolyaxonDeploymentSpec) DeepCopyInto(out *PolyaxonDeploymentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonDeploymentStatus ¶
type PolyaxonDeploymentStatus struct { // Conditions is an array of current conditions Conditions []PolyaxonDeploymentCondition `json:"conditions,omitempty"` // ReadyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. ReadyReplicas int32 `json:"readyReplicas,omitempty"` }
PolyaxonDeploymentStatus defines the observed state of PolyaxonDeployment
func (*PolyaxonDeploymentStatus) DeepCopy ¶
func (in *PolyaxonDeploymentStatus) DeepCopy() *PolyaxonDeploymentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonDeploymentStatus.
func (*PolyaxonDeploymentStatus) DeepCopyInto ¶
func (in *PolyaxonDeploymentStatus) DeepCopyInto(out *PolyaxonDeploymentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolyaxonJob ¶
type PolyaxonJob struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Specification of the desired behavior of a job. // +optional Spec PolyaxonBaseJobSpec `json:"spec,omitempty"` // Current status of a job. // +optional Status PolyaxonBaseJobStatus `json:"status,omitempty"` }
PolyaxonJob is the Schema for the polyaxonjobs API +k8s:openapi-gen=true +kubebuilder:resource:shortName=plxjob +kubebuilder:subresource:status
func (*PolyaxonJob) AddFinalizer ¶
func (instance *PolyaxonJob) AddFinalizer()
AddFinalizer handler for PolyaxonJob
func (*PolyaxonJob) DeepCopy ¶
func (in *PolyaxonJob) DeepCopy() *PolyaxonJob
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonJob.
func (*PolyaxonJob) DeepCopyInto ¶
func (in *PolyaxonJob) DeepCopyInto(out *PolyaxonJob)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonJob) DeepCopyObject ¶
func (in *PolyaxonJob) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PolyaxonJob) HasFinalizer ¶
func (instance *PolyaxonJob) HasFinalizer() bool
HasFinalizer check for PolyaxonJob
func (*PolyaxonJob) HasWarning ¶
func (instance *PolyaxonJob) HasWarning() bool
HasWarning checks if the PolyaxonJob succeeded
func (*PolyaxonJob) IsBeingDeleted ¶
func (instance *PolyaxonJob) IsBeingDeleted() bool
IsBeingDeleted checks if the job is being deleted
func (*PolyaxonJob) IsDone ¶
func (instance *PolyaxonJob) IsDone() bool
IsDone checks if it the PolyaxonJob reached a final condition
func (*PolyaxonJob) IsFailed ¶
func (instance *PolyaxonJob) IsFailed() bool
IsFailed checks if the PolyaxonJob failed
func (*PolyaxonJob) IsRunning ¶
func (instance *PolyaxonJob) IsRunning() bool
IsRunning checks if the PolyaxonJob is running
func (*PolyaxonJob) IsStarting ¶
func (instance *PolyaxonJob) IsStarting() bool
IsStarting checks if the PolyaxonJob is statrting
func (*PolyaxonJob) IsStopped ¶
func (instance *PolyaxonJob) IsStopped() bool
IsStopped checks if the PolyaxonJob stopped
func (*PolyaxonJob) IsSucceeded ¶
func (instance *PolyaxonJob) IsSucceeded() bool
IsSucceeded checks if the PolyaxonJob succeeded
func (*PolyaxonJob) LogFailed ¶
func (instance *PolyaxonJob) LogFailed(reason, message string) bool
LogFailed sets PolyaxonJob to failed
func (*PolyaxonJob) LogRunning ¶
func (instance *PolyaxonJob) LogRunning() bool
LogRunning sets PolyaxonJob to running
func (*PolyaxonJob) LogStarting ¶
func (instance *PolyaxonJob) LogStarting() bool
LogStarting sets PolyaxonJob to statrting
func (*PolyaxonJob) LogStopped ¶
func (instance *PolyaxonJob) LogStopped(reason, message string) bool
LogStopped sets PolyaxonJob to stopped
func (*PolyaxonJob) LogSucceeded ¶
func (instance *PolyaxonJob) LogSucceeded() bool
LogSucceeded sets PolyaxonJob to succeeded
func (*PolyaxonJob) LogWarning ¶
func (instance *PolyaxonJob) LogWarning(reason, message string) bool
LogWarning sets PolyaxonJob to succeeded
func (*PolyaxonJob) RemoveFinalizer ¶
func (instance *PolyaxonJob) RemoveFinalizer()
RemoveFinalizer handler for PolyaxonJob
type PolyaxonJobList ¶
type PolyaxonJobList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PolyaxonJob `json:"items"` }
PolyaxonJobList contains a list of PolyaxonJob
func (*PolyaxonJobList) DeepCopy ¶
func (in *PolyaxonJobList) DeepCopy() *PolyaxonJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonJobList.
func (*PolyaxonJobList) DeepCopyInto ¶
func (in *PolyaxonJobList) DeepCopyInto(out *PolyaxonJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonJobList) DeepCopyObject ¶
func (in *PolyaxonJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolyaxonKF ¶
type PolyaxonKF struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // KFSpec represent the spec to pass to the underlaying KubeFlow operator // This vaidation of the spec is handled by the corresponding operator Spec KFSpec `json:"spec,omitempty"` Status PolyaxonBaseJobStatus `json:"status,omitempty"` }
PolyaxonKF is the Schema for the polyaxonkfs API to manage Kubeflow operators +k8s:openapi-gen=true +kubebuilder:resource:shortName=plxkf +kubebuilder:subresource:status
func (*PolyaxonKF) AddFinalizer ¶
func (instance *PolyaxonKF) AddFinalizer()
AddFinalizer handler for PolyaxonKF
func (*PolyaxonKF) DeepCopy ¶
func (in *PolyaxonKF) DeepCopy() *PolyaxonKF
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonKF.
func (*PolyaxonKF) DeepCopyInto ¶
func (in *PolyaxonKF) DeepCopyInto(out *PolyaxonKF)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonKF) DeepCopyObject ¶
func (in *PolyaxonKF) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PolyaxonKF) HasFinalizer ¶
func (instance *PolyaxonKF) HasFinalizer() bool
HasFinalizer check for PolyaxonKF
func (*PolyaxonKF) HasWarning ¶
func (instance *PolyaxonKF) HasWarning() bool
HasWarning checks if the PolyaxonKF succeeded
func (*PolyaxonKF) IsBeingDeleted ¶
func (instance *PolyaxonKF) IsBeingDeleted() bool
IsBeingDeleted checks if the kf is being deleted
func (*PolyaxonKF) IsDone ¶
func (instance *PolyaxonKF) IsDone() bool
IsDone checks if it the PolyaxonKF reached a final condition
func (*PolyaxonKF) IsFailed ¶
func (instance *PolyaxonKF) IsFailed() bool
IsFailed checks if the PolyaxonKF failed
func (*PolyaxonKF) IsRunning ¶
func (instance *PolyaxonKF) IsRunning() bool
IsRunning checks if the PolyaxonKF is running
func (*PolyaxonKF) IsStarting ¶
func (instance *PolyaxonKF) IsStarting() bool
IsStarting checks if the PolyaxonKF is statrting
func (*PolyaxonKF) IsStopped ¶
func (instance *PolyaxonKF) IsStopped() bool
IsStopped checks if the PolyaxonKF stopped
func (*PolyaxonKF) IsSucceeded ¶
func (instance *PolyaxonKF) IsSucceeded() bool
IsSucceeded checks if the PolyaxonKF succeeded
func (*PolyaxonKF) LogFailed ¶
func (instance *PolyaxonKF) LogFailed(reason, message string)
LogFailed sets PolyaxonKF to failed
func (*PolyaxonKF) LogRunning ¶
func (instance *PolyaxonKF) LogRunning()
LogRunning sets PolyaxonKF to running
func (*PolyaxonKF) LogStarting ¶
func (instance *PolyaxonKF) LogStarting()
LogStarting sets PolyaxonKF to statrting
func (*PolyaxonKF) LogStopped ¶
func (instance *PolyaxonKF) LogStopped(reason, message string)
LogStopped sets PolyaxonKF to stopped
func (*PolyaxonKF) LogSucceeded ¶
func (instance *PolyaxonKF) LogSucceeded()
LogSucceeded sets PolyaxonKF to succeeded
func (*PolyaxonKF) LogWarning ¶
func (instance *PolyaxonKF) LogWarning(reason, message string)
LogWarning sets PolyaxonKF to Warning
func (*PolyaxonKF) RemoveFinalizer ¶
func (instance *PolyaxonKF) RemoveFinalizer()
RemoveFinalizer handler for PolyaxonKF
type PolyaxonKFList ¶
type PolyaxonKFList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PolyaxonKF `json:"items"` }
PolyaxonKFList contains a list of PolyaxonKF
func (*PolyaxonKFList) DeepCopy ¶
func (in *PolyaxonKFList) DeepCopy() *PolyaxonKFList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonKFList.
func (*PolyaxonKFList) DeepCopyInto ¶
func (in *PolyaxonKFList) DeepCopyInto(out *PolyaxonKFList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonKFList) DeepCopyObject ¶
func (in *PolyaxonKFList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolyaxonNotebook ¶
type PolyaxonNotebook struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PolyaxonDeploymentSpec `json:"spec,omitempty"` Status PolyaxonDeploymentStatus `json:"status,omitempty"` }
PolyaxonNotebook is the Schema for the polyaxonnotebooks API +k8s:openapi-gen=true +kubebuilder:resource:shortName=plxnb +kubebuilder:subresource:status
func (*PolyaxonNotebook) AddFinalizer ¶
func (instance *PolyaxonNotebook) AddFinalizer()
AddFinalizer handler for PolyaxonNotebook
func (*PolyaxonNotebook) DeepCopy ¶
func (in *PolyaxonNotebook) DeepCopy() *PolyaxonNotebook
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonNotebook.
func (*PolyaxonNotebook) DeepCopyInto ¶
func (in *PolyaxonNotebook) DeepCopyInto(out *PolyaxonNotebook)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonNotebook) DeepCopyObject ¶
func (in *PolyaxonNotebook) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PolyaxonNotebook) HasFinalizer ¶
func (instance *PolyaxonNotebook) HasFinalizer() bool
HasFinalizer check for PolyaxonNotebook
func (*PolyaxonNotebook) HasWarning ¶
func (instance *PolyaxonNotebook) HasWarning() bool
HasWarning checks if the PolyaxonNotebook succeeded
func (*PolyaxonNotebook) IsBeingDeleted ¶
func (instance *PolyaxonNotebook) IsBeingDeleted() bool
IsBeingDeleted checks if the notebook is being deleted
func (*PolyaxonNotebook) IsDone ¶
func (instance *PolyaxonNotebook) IsDone() bool
IsDone checks if it the PolyaxonNotebook reached a final condition
func (*PolyaxonNotebook) IsFailed ¶
func (instance *PolyaxonNotebook) IsFailed() bool
IsFailed checks if the PolyaxonNotebook failed
func (*PolyaxonNotebook) IsRunning ¶
func (instance *PolyaxonNotebook) IsRunning() bool
IsRunning checks if the PolyaxonNotebook is running
func (*PolyaxonNotebook) IsStarting ¶
func (instance *PolyaxonNotebook) IsStarting() bool
IsStarting checks if the PolyaxonNotebook is statrting
func (*PolyaxonNotebook) IsStopped ¶
func (instance *PolyaxonNotebook) IsStopped() bool
IsStopped checks if the PolyaxonNotebook stopped
func (*PolyaxonNotebook) IsSucceeded ¶
func (instance *PolyaxonNotebook) IsSucceeded() bool
IsSucceeded checks if the PolyaxonNotebook succeeded
func (*PolyaxonNotebook) LogFailed ¶
func (instance *PolyaxonNotebook) LogFailed(reason, message string)
LogFailed sets PolyaxonNotebook to failed
func (*PolyaxonNotebook) LogRunning ¶
func (instance *PolyaxonNotebook) LogRunning()
LogRunning sets PolyaxonNotebook to running
func (*PolyaxonNotebook) LogStarting ¶
func (instance *PolyaxonNotebook) LogStarting()
LogStarting sets PolyaxonNotebook to statrting
func (*PolyaxonNotebook) LogStopped ¶
func (instance *PolyaxonNotebook) LogStopped(reason, message string)
LogStopped sets PolyaxonNotebook to stopped
func (*PolyaxonNotebook) LogSucceeded ¶
func (instance *PolyaxonNotebook) LogSucceeded()
LogSucceeded sets PolyaxonNotebook to succeeded
func (*PolyaxonNotebook) LogWarning ¶
func (instance *PolyaxonNotebook) LogWarning(reason, message string)
LogWarning sets PolyaxonNotebook to Warning
func (*PolyaxonNotebook) RemoveFinalizer ¶
func (instance *PolyaxonNotebook) RemoveFinalizer()
RemoveFinalizer handler for PolyaxonNotebook
type PolyaxonNotebookList ¶
type PolyaxonNotebookList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PolyaxonNotebook `json:"items"` }
PolyaxonNotebookList contains a list of PolyaxonNotebook
func (*PolyaxonNotebookList) DeepCopy ¶
func (in *PolyaxonNotebookList) DeepCopy() *PolyaxonNotebookList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonNotebookList.
func (*PolyaxonNotebookList) DeepCopyInto ¶
func (in *PolyaxonNotebookList) DeepCopyInto(out *PolyaxonNotebookList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonNotebookList) DeepCopyObject ¶
func (in *PolyaxonNotebookList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolyaxonTensorboard ¶
type PolyaxonTensorboard struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PolyaxonDeploymentSpec `json:"spec,omitempty"` Status PolyaxonDeploymentStatus `json:"status,omitempty"` }
PolyaxonTensorboard is the Schema for the polyaxontensorboards API +k8s:openapi-gen=true +kubebuilder:resource:shortName=plxtb +kubebuilder:subresource:status
func (*PolyaxonTensorboard) AddFinalizer ¶
func (instance *PolyaxonTensorboard) AddFinalizer()
AddFinalizer handler for PolyaxonTensorboard
func (*PolyaxonTensorboard) DeepCopy ¶
func (in *PolyaxonTensorboard) DeepCopy() *PolyaxonTensorboard
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonTensorboard.
func (*PolyaxonTensorboard) DeepCopyInto ¶
func (in *PolyaxonTensorboard) DeepCopyInto(out *PolyaxonTensorboard)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonTensorboard) DeepCopyObject ¶
func (in *PolyaxonTensorboard) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PolyaxonTensorboard) HasFinalizer ¶
func (instance *PolyaxonTensorboard) HasFinalizer() bool
HasFinalizer check for PolyaxonTensorboard
func (*PolyaxonTensorboard) HasWarning ¶
func (instance *PolyaxonTensorboard) HasWarning() bool
HasWarning checks if the PolyaxonTensorboard succeeded
func (*PolyaxonTensorboard) IsBeingDeleted ¶
func (instance *PolyaxonTensorboard) IsBeingDeleted() bool
IsBeingDeleted checks if the Tensorboard is being deleted
func (*PolyaxonTensorboard) IsDone ¶
func (instance *PolyaxonTensorboard) IsDone() bool
IsDone checks if it the PolyaxonTensorboard reached a final condition
func (*PolyaxonTensorboard) IsFailed ¶
func (instance *PolyaxonTensorboard) IsFailed() bool
IsFailed checks if the PolyaxonTensorboard failed
func (*PolyaxonTensorboard) IsRunning ¶
func (instance *PolyaxonTensorboard) IsRunning() bool
IsRunning checks if the PolyaxonTensorboard is running
func (*PolyaxonTensorboard) IsStarting ¶
func (instance *PolyaxonTensorboard) IsStarting() bool
IsStarting checks if the PolyaxonTensorboard is statrting
func (*PolyaxonTensorboard) IsStopped ¶
func (instance *PolyaxonTensorboard) IsStopped() bool
IsStopped checks if the PolyaxonTensorboard stopped
func (*PolyaxonTensorboard) IsSucceeded ¶
func (instance *PolyaxonTensorboard) IsSucceeded() bool
IsSucceeded checks if the PolyaxonTensorboard succeeded
func (*PolyaxonTensorboard) LogFailed ¶
func (instance *PolyaxonTensorboard) LogFailed(reason, message string)
LogFailed sets PolyaxonTensorboard to failed
func (*PolyaxonTensorboard) LogRunning ¶
func (instance *PolyaxonTensorboard) LogRunning()
LogRunning sets PolyaxonTensorboard to running
func (*PolyaxonTensorboard) LogStarting ¶
func (instance *PolyaxonTensorboard) LogStarting()
LogStarting sets PolyaxonTensorboard to statrting
func (*PolyaxonTensorboard) LogStopped ¶
func (instance *PolyaxonTensorboard) LogStopped(reason, message string)
LogStopped sets PolyaxonTensorboard to stopped
func (*PolyaxonTensorboard) LogSucceeded ¶
func (instance *PolyaxonTensorboard) LogSucceeded()
LogSucceeded sets PolyaxonTensorboard to succeeded
func (*PolyaxonTensorboard) LogWarning ¶
func (instance *PolyaxonTensorboard) LogWarning(reason, message string)
LogWarning sets PolyaxonTensorboard to Warning
func (*PolyaxonTensorboard) RemoveFinalizer ¶
func (instance *PolyaxonTensorboard) RemoveFinalizer()
RemoveFinalizer handler for PolyaxonTensorboard
type PolyaxonTensorboardList ¶
type PolyaxonTensorboardList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PolyaxonTensorboard `json:"items"` }
PolyaxonTensorboardList contains a list of PolyaxonTensorboard
func (*PolyaxonTensorboardList) DeepCopy ¶
func (in *PolyaxonTensorboardList) DeepCopy() *PolyaxonTensorboardList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolyaxonTensorboardList.
func (*PolyaxonTensorboardList) DeepCopyInto ¶
func (in *PolyaxonTensorboardList) DeepCopyInto(out *PolyaxonTensorboardList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolyaxonTensorboardList) DeepCopyObject ¶
func (in *PolyaxonTensorboardList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.