v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=kubeflow.org

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type JobSpec
  • func (in *JobSpec) DeepCopy() *JobSpec
  • func (in *JobSpec) DeepCopyInto(out *JobSpec)
• type JobSpecs
  • func (in *JobSpecs) DeepCopy() *JobSpecs
  • func (in *JobSpecs) DeepCopyInto(out *JobSpecs)
• type Ksonnet
  • func (in *Ksonnet) DeepCopy() *Ksonnet
  • func (in *Ksonnet) DeepCopyInto(out *Ksonnet)
• type KubebenchJob
  • func (in *KubebenchJob) DeepCopy() *KubebenchJob
  • func (in *KubebenchJob) DeepCopyInto(out *KubebenchJob)
  • func (in *KubebenchJob) DeepCopyObject() runtime.Object
• type KubebenchJobList
  • func (in *KubebenchJobList) DeepCopy() *KubebenchJobList
  • func (in *KubebenchJobList) DeepCopyInto(out *KubebenchJobList)
  • func (in *KubebenchJobList) DeepCopyObject() runtime.Object
• type KubebenchJobSpec
  • func (in *KubebenchJobSpec) DeepCopy() *KubebenchJobSpec
  • func (in *KubebenchJobSpec) DeepCopyInto(out *KubebenchJobSpec)
• type KubebenchJobStatus
  • func (in *KubebenchJobStatus) DeepCopy() *KubebenchJobStatus
  • func (in *KubebenchJobStatus) DeepCopyInto(out *KubebenchJobStatus)
• type MainJobSpec
  • func (in *MainJobSpec) DeepCopy() *MainJobSpec
  • func (in *MainJobSpec) DeepCopyInto(out *MainJobSpec)
• type ParametersSpec
  • func (in *ParametersSpec) DeepCopy() *ParametersSpec
  • func (in *ParametersSpec) DeepCopyInto(out *ParametersSpec)
• type PathSpec
  • func (in *PathSpec) DeepCopy() *PathSpec
  • func (in *PathSpec) DeepCopyInto(out *PathSpec)
• type ReportSpecs
  • func (in *ReportSpecs) DeepCopy() *ReportSpecs
  • func (in *ReportSpecs) DeepCopyInto(out *ReportSpecs)
• type ResourceSpec
  • func (in *ResourceSpec) DeepCopy() *ResourceSpec
  • func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)
• type SecretSpecs
  • func (in *SecretSpecs) DeepCopy() *SecretSpecs
  • func (in *SecretSpecs) DeepCopyInto(out *SecretSpecs)
• type TemplateSpec
  • func (in *TemplateSpec) DeepCopy() *TemplateSpec
  • func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)
• type VolumeSpecs
  • func (in *VolumeSpecs) DeepCopy() *VolumeSpecs
  • func (in *VolumeSpecs) DeepCopyInto(out *VolumeSpecs)

Constants

const (
	// GroupName is the group name use in this package.
	GroupName = "kubeflow.org"
	// GroupVersion is the version.
	GroupVersion = "v1alpha1"
)

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 JobSpec

type JobSpec struct {
	Container apiv1.Container `json:"container,omitempty"`
}

func (*JobSpec) DeepCopy

func (in *JobSpec) DeepCopy() *JobSpec

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

func (*JobSpec) DeepCopyInto

func (in *JobSpec) DeepCopyInto(out *JobSpec)

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

type JobSpecs

type JobSpecs struct {
	PreJob  JobSpec     `json:"preJob,omitempty"`
	MainJob MainJobSpec `json:"mainJob"`
	PostJob JobSpec     `json:"postJob,omitempty"`
}

func (*JobSpecs) DeepCopy

func (in *JobSpecs) DeepCopy() *JobSpecs

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

func (*JobSpecs) DeepCopyInto

func (in *JobSpecs) DeepCopyInto(out *JobSpecs)

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

type Ksonnet

type Ksonnet struct {
	KsonnetSpec map[string]string `json:"ksonnet"`
}

func (*Ksonnet) DeepCopy

func (in *Ksonnet) DeepCopy() *Ksonnet

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

func (*Ksonnet) DeepCopyInto

func (in *Ksonnet) DeepCopyInto(out *Ksonnet)

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 configuration of a Kubebench job

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 {
	ServiceAccount string      `json:"serviceAccount,omitempty"`
	Volumes        VolumeSpecs `json:"volumeSpecs"`
	Secrets        SecretSpecs `json:"secretSpecs,omitempty"`
	Jobs           JobSpecs    `json:"jobSpecs"`
	Report         ReportSpecs `json:"reportSpecs,omitempty"`
}

KubebenchJobSpec defines the desired state of 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 {
}

KubebenchJobStatus defines the observed state of 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 MainJobSpec

type MainJobSpec struct {
	Resource ResourceSpec `json:"resource"`
}

func (*MainJobSpec) DeepCopy

func (in *MainJobSpec) DeepCopy() *MainJobSpec

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

func (*MainJobSpec) DeepCopyInto

func (in *MainJobSpec) DeepCopyInto(out *MainJobSpec)

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

type ParametersSpec

type ParametersSpec struct {
	ValueFrom PathSpec `json:"valueFrom"`
}

func (*ParametersSpec) DeepCopy

func (in *ParametersSpec) DeepCopy() *ParametersSpec

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

func (*ParametersSpec) DeepCopyInto

func (in *ParametersSpec) DeepCopyInto(out *ParametersSpec)

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

type PathSpec

type PathSpec struct {
	Path string `json:"path"`
}

func (*PathSpec) DeepCopy

func (in *PathSpec) DeepCopy() *PathSpec

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

func (*PathSpec) DeepCopyInto

func (in *PathSpec) DeepCopyInto(out *PathSpec)

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

type ReportSpecs

type ReportSpecs struct {
	CSV []map[string]string `json:"csv"`
}

func (*ReportSpecs) DeepCopy

func (in *ReportSpecs) DeepCopy() *ReportSpecs

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

func (*ReportSpecs) DeepCopyInto

func (in *ReportSpecs) DeepCopyInto(out *ReportSpecs)

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

type ResourceSpec

type ResourceSpec struct {
	ManifestTemplate   TemplateSpec   `json:"manifestTemplate"`
	MainfestParameters ParametersSpec `json:"manifestParameters"`
	CreateSuccess      string         `json:"createSuccessCondition"`
	CreateFailure      string         `json:"createFailureCondition"`
	RunSuccess         string         `json:"runSuccessCondition"`
	RunFailure         string         `json:"runFailureCondition"`
}

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 SecretSpecs

type SecretSpecs struct {
	GithubToken    map[string]string `json:"githubTokenSecret,omitempty"`
	GCPCredentials map[string]string `json:"gcpCredentialsSecret,omitempty"`
}

func (*SecretSpecs) DeepCopy

func (in *SecretSpecs) DeepCopy() *SecretSpecs

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

func (*SecretSpecs) DeepCopyInto

func (in *SecretSpecs) DeepCopyInto(out *SecretSpecs)

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

type TemplateSpec

type TemplateSpec struct {
	ValueFrom Ksonnet `json:"valueFrom"`
}

func (*TemplateSpec) DeepCopy

func (in *TemplateSpec) DeepCopy() *TemplateSpec

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

func (*TemplateSpec) DeepCopyInto

func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)

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

type VolumeSpecs

type VolumeSpecs struct {
	ConfigVolume     apiv1.Volume `json:"configVolume"`
	ExperimentVolume apiv1.Volume `json:"experimentVolume"`
}

func (*VolumeSpecs) DeepCopy

func (in *VolumeSpecs) DeepCopy() *VolumeSpecs

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

func (*VolumeSpecs) DeepCopyInto

func (in *VolumeSpecs) DeepCopyInto(out *VolumeSpecs)

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