v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the slurm v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=slurm.sylabs.io

Package v1alpha1 contains API Schema definitions for the slurm v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=slurm.sylabs.io

Index

• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• func RegisterDefaults(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type SlurmJob
  • func (in *SlurmJob) DeepCopy() *SlurmJob
  • func (in *SlurmJob) DeepCopyInto(out *SlurmJob)
  • func (in *SlurmJob) DeepCopyObject() runtime.Object
• type SlurmJobList
  • func (in *SlurmJobList) DeepCopy() *SlurmJobList
  • func (in *SlurmJobList) DeepCopyInto(out *SlurmJobList)
  • func (in *SlurmJobList) DeepCopyObject() runtime.Object
• type SlurmJobResults
  • func (in *SlurmJobResults) DeepCopy() *SlurmJobResults
  • func (in *SlurmJobResults) DeepCopyInto(out *SlurmJobResults)
• type SlurmJobSpec
  • func (in *SlurmJobSpec) DeepCopy() *SlurmJobSpec
  • func (in *SlurmJobSpec) DeepCopyInto(out *SlurmJobSpec)
• type SlurmJobStatus
  • func (in *SlurmJobStatus) DeepCopy() *SlurmJobStatus
  • func (in *SlurmJobStatus) DeepCopyInto(out *SlurmJobStatus)

Variables

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

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

	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

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 takes an unqualified resource and returns a Group qualified GroupResource.

Types

type SlurmJob

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

	Spec   SlurmJobSpec   `json:"spec,omitempty"`
	Status SlurmJobStatus `json:"status,omitempty"`
}

SlurmJob is the Schema for the slurmjobs API. +genclient +k8s:openapi-gen=true +kubebuilder:resource:shortName=sj +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.status",description="status of the kind"

func (*SlurmJob) DeepCopy

func (in *SlurmJob) DeepCopy() *SlurmJob

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

func (*SlurmJob) DeepCopyInto

func (in *SlurmJob) DeepCopyInto(out *SlurmJob)

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

func (*SlurmJob) DeepCopyObject

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

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

type SlurmJobList

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

SlurmJobList contains a list of SlurmJob.

func (*SlurmJobList) DeepCopy

func (in *SlurmJobList) DeepCopy() *SlurmJobList

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

func (*SlurmJobList) DeepCopyInto

func (in *SlurmJobList) DeepCopyInto(out *SlurmJobList)

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

func (*SlurmJobList) DeepCopyObject

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

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

type SlurmJobResults

type SlurmJobResults struct {
	// Mount is a directory where job results will be stored.
	// After results collection all job generated files can be found in Mount/<SlurmJob.Name> directory.
	Mount v1.Volume `json:"mount"`

	// From is a path to the results to be collected from a Slurm cluster.
	From string `json:"from"`
}

SlurmJobResults is a schema for results collection. +k8s:openapi-gen=true

func (*SlurmJobResults) DeepCopy

func (in *SlurmJobResults) DeepCopy() *SlurmJobResults

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

func (*SlurmJobResults) DeepCopyInto

func (in *SlurmJobResults) DeepCopyInto(out *SlurmJobResults)

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

type SlurmJobSpec

type SlurmJobSpec struct {

	// Batch is a script that will be submitted to a Slurm cluster as a batch job.
	// +kubebuilder:validation:MinLength=1
	Batch string `json:"batch"`

	// NodeSelector is a selector which must be true for the SlurmJob to fit on a node.
	// Selector which must match a node's labels for the SlurmJob to be scheduled on that node.
	// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/.
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// Results may be specified for an optional results collection step.
	// When specified, after job is completed all results will be downloaded from Slurm
	// cluster with respect to this configuration.
	Results *SlurmJobResults `json:"results,omitempty"`
}

SlurmJobSpec defines the desired state of SlurmJob +k8s:openapi-gen=true

func (*SlurmJobSpec) DeepCopy

func (in *SlurmJobSpec) DeepCopy() *SlurmJobSpec

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

func (*SlurmJobSpec) DeepCopyInto

func (in *SlurmJobSpec) DeepCopyInto(out *SlurmJobSpec)

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

type SlurmJobStatus

type SlurmJobStatus struct {

	// Status reflects job status, e.g running, succeeded.
	Status string `json:"status"`
}

SlurmJobStatus defines the observed state of a SlurmJob. +k8s:openapi-gen=true

func (*SlurmJobStatus) DeepCopy

func (in *SlurmJobStatus) DeepCopy() *SlurmJobStatus

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

func (*SlurmJobStatus) DeepCopyInto

func (in *SlurmJobStatus) DeepCopyInto(out *SlurmJobStatus)

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