Documentation
¶
Overview ¶
Package v1alpha2 is the v1alpha2 version of the API. +groupName=kubeflow.org
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type AutoWatchSpec
- type KubebenchConfig
- type KubebenchJob
- type KubebenchJobList
- type KubebenchJobSpec
- type KubebenchJobStatus
- type ManagedVolumes
- type ManifestSource
- type ResourceOptions
- type ResourceSpec
- type Task
- type WorkflowAgentSpec
Constants ¶
const ( // GroupName is the group name use in this package. GroupName = "kubeflow.org" // GroupVersion is the version. GroupVersion = "v1alpha2" // Kind is the kind name. Kind = "KubebenchJob" // Plural is the Plural for KubebenchJob. Plural = "kubebenchjobs" // Singular is the singular for KubebenchJob. Singular = "kubebenchjob" )
Variables ¶
var ( // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: GroupVersion}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AutoWatchSpec ¶
type AutoWatchSpec struct {
Timeout string `json:"timeout,omitempty"`
}
AutoWatchSpec is the specification of auto-watch functionality
func (*AutoWatchSpec) DeepCopy ¶
func (in *AutoWatchSpec) DeepCopy() *AutoWatchSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AutoWatchSpec.
func (*AutoWatchSpec) DeepCopyInto ¶
func (in *AutoWatchSpec) DeepCopyInto(out *AutoWatchSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubebenchConfig ¶
type KubebenchConfig struct { DefaultWorkflowAgent WorkflowAgentSpec `json:"defaultWorkflowAgent,omitempty"` DefaultManagedVolumes ManagedVolumes `json:"defaultManagedVolumes,omitempty"` }
KubebenchConfig is the Kubebench configuration
func (*KubebenchConfig) DeepCopy ¶
func (in *KubebenchConfig) DeepCopy() *KubebenchConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubebenchConfig.
func (*KubebenchConfig) DeepCopyInto ¶
func (in *KubebenchConfig) DeepCopyInto(out *KubebenchConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubebenchJob ¶
type KubebenchJob struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec KubebenchJobSpec `json:"spec,omitempty"` Status KubebenchJobStatus `json:"status,omitempty"` }
KubebenchJob is the definition of a KubebenchJob resource
func (*KubebenchJob) DeepCopy ¶
func (in *KubebenchJob) DeepCopy() *KubebenchJob
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubebenchJob.
func (*KubebenchJob) DeepCopyInto ¶
func (in *KubebenchJob) DeepCopyInto(out *KubebenchJob)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubebenchJob) DeepCopyObject ¶
func (in *KubebenchJob) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubebenchJobList ¶
type KubebenchJobList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []KubebenchJob `json:"items"` }
KubebenchJobList contains a list of KubebenchJob
func (*KubebenchJobList) DeepCopy ¶
func (in *KubebenchJobList) DeepCopy() *KubebenchJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubebenchJobList.
func (*KubebenchJobList) DeepCopyInto ¶
func (in *KubebenchJobList) DeepCopyInto(out *KubebenchJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubebenchJobList) DeepCopyObject ¶
func (in *KubebenchJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubebenchJobSpec ¶
type KubebenchJobSpec struct { ServiceAccountName string `json:"serviceAccountName,omitempty"` Arguments argov1alpha1.Arguments `json:"arguments,omitempty"` Volumes []corev1.Volume `json:"volumes,omitempty"` ManagedVolumes ManagedVolumes `json:"managedVolumes,omitempty"` WorkflowAgent WorkflowAgentSpec `json:"workflowAgent,omitempty"` Tasks []Task `json:"tasks"` }
KubebenchJobSpec is the specification of a KubebenchJob
func (*KubebenchJobSpec) DeepCopy ¶
func (in *KubebenchJobSpec) DeepCopy() *KubebenchJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubebenchJobSpec.
func (*KubebenchJobSpec) DeepCopyInto ¶
func (in *KubebenchJobSpec) DeepCopyInto(out *KubebenchJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubebenchJobStatus ¶
type KubebenchJobStatus struct {
argov1alpha1.WorkflowStatus `json:",inline"`
}
KubebenchJobStatus is the observed status of a KubebenchJob
func (*KubebenchJobStatus) DeepCopy ¶
func (in *KubebenchJobStatus) DeepCopy() *KubebenchJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubebenchJobStatus.
func (*KubebenchJobStatus) DeepCopyInto ¶
func (in *KubebenchJobStatus) DeepCopyInto(out *KubebenchJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManagedVolumes ¶
type ManagedVolumes struct { ExperimentVolume *corev1.Volume `json:"experimentVolume,omitempty"` WorkflowVolume *corev1.Volume `json:"workflowVolume,omitempty"` }
ManagedVolumes is the volumes managed by the Kubebench workflow
func (*ManagedVolumes) DeepCopy ¶
func (in *ManagedVolumes) DeepCopy() *ManagedVolumes
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedVolumes.
func (*ManagedVolumes) DeepCopyInto ¶
func (in *ManagedVolumes) DeepCopyInto(out *ManagedVolumes)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManifestSource ¶
type ManifestSource struct {
Path *string `json:"path,omitempty"`
}
ManifestSource is the source of a k8s manifest
func (*ManifestSource) DeepCopy ¶
func (in *ManifestSource) DeepCopy() *ManifestSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManifestSource.
func (*ManifestSource) DeepCopyInto ¶
func (in *ManifestSource) DeepCopyInto(out *ManifestSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceOptions ¶
type ResourceOptions struct { MountManagedVolumes bool `json:"mountManagedVolumes,omitempty"` AutoDelete bool `json:"autoDelete,omitempty"` AutoWatch *AutoWatchSpec `json:"autoWatch,omitempty"` NumCopies int `json:"numCopies,omitempty"` }
ResourceOptions is the options of a resource-type task
func (*ResourceOptions) DeepCopy ¶
func (in *ResourceOptions) DeepCopy() *ResourceOptions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceOptions.
func (*ResourceOptions) DeepCopyInto ¶
func (in *ResourceOptions) DeepCopyInto(out *ResourceOptions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceSpec ¶
type ResourceSpec struct { Manifest *string `json:"manifest,omitempty"` ManifestFrom *ManifestSource `json:"manifestFrom,omitempty"` VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"` Options *ResourceOptions `json:"options,omitempty"` }
ResourceSpec is the specification of a resouce-type task in a benchmark workflow
func (*ResourceSpec) DeepCopy ¶
func (in *ResourceSpec) DeepCopy() *ResourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSpec.
func (*ResourceSpec) DeepCopyInto ¶
func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Task ¶
type Task struct { Name string `json:"name"` Container *corev1.Container `json:"container,omitempty"` Resource *ResourceSpec `json:"resource,omitempty"` Inputs argov1alpha1.Inputs `json:"inputs,omitempty"` Outputs argov1alpha1.Outputs `json:"outputs,omitempty"` Dependencies []string `json:"dependencies,omitempty"` }
Task is a task in a Kubebench workflow
func (*Task) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Task.
func (*Task) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkflowAgentSpec ¶
WorkflowAgentSpec is the specification of Kubebench workflow agent
func (*WorkflowAgentSpec) DeepCopy ¶
func (in *WorkflowAgentSpec) DeepCopy() *WorkflowAgentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkflowAgentSpec.
func (*WorkflowAgentSpec) DeepCopyInto ¶
func (in *WorkflowAgentSpec) DeepCopyInto(out *WorkflowAgentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.