Documentation ¶
Overview ¶
Go imports
Go imports ¶
Package v1 contains API Schema definitions for the analytics v1 API group +kubebuilder:object:generate=true +groupName=analytics.piersharding.com
Index ¶
- Variables
- type Dask
- func (in *Dask) DeepCopy() *Dask
- func (in *Dask) DeepCopyInto(out *Dask)
- func (in *Dask) DeepCopyObject() runtime.Object
- func (r *Dask) Default()
- func (r *Dask) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *Dask) ValidateCreate() error
- func (r *Dask) ValidateDelete() error
- func (r *Dask) ValidateUpdate(old runtime.Object) error
- type DaskDeploymentSpec
- type DaskJob
- func (in *DaskJob) DeepCopy() *DaskJob
- func (in *DaskJob) DeepCopyInto(out *DaskJob)
- func (in *DaskJob) DeepCopyObject() runtime.Object
- func (r *DaskJob) Default()
- func (r *DaskJob) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *DaskJob) ValidateCreate() error
- func (r *DaskJob) ValidateDelete() error
- func (r *DaskJob) ValidateUpdate(old runtime.Object) error
- type DaskJobList
- type DaskJobSpec
- type DaskJobStatus
- type DaskList
- type DaskSpec
- type DaskStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "analytics.piersharding.com", Version: "v1"} // 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 Dask ¶
type Dask struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DaskSpec `json:"spec,omitempty"` Status DaskStatus `json:"status,omitempty"` }
Dask is the Schema for the dasks API +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Components",type="integer",JSONPath=".status.replicas",description="The number of Components Requested in the Dask",priority=0 +kubebuilder:printcolumn:name="Succeeded",type="integer",JSONPath=".status.succeeded",description="The number of Components Launched in the Dask",priority=0 +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="The number of Components Requested in the Dask",priority=0 +kubebuilder:printcolumn:name="State",type="string",JSONPath=".status.state",description="Status of the Dask",priority=0 +kubebuilder:printcolumn:name="Resources",type="string",JSONPath=".status.resources",description=" Resource details of the Dask",priority=1
func (*Dask) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dask.
func (*Dask) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Dask) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Dask) Default ¶
func (r *Dask) Default()
Default implements webhook.Defaulter so a webhook will be registered for the type
func (*Dask) SetupWebhookWithManager ¶
func (*Dask) ValidateCreate ¶
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*Dask) ValidateDelete ¶
ValidateDelete implements webhook.Validator so a webhook will be registered for the type
type DaskDeploymentSpec ¶
type DaskDeploymentSpec struct { // Specifies the Volumes. // +optional Volumes []corev1.Volume `json:"volumes,omitempty"` // Specifies the VolumeMounts. // +optional VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"` // Specifies the Environment variables. // +optional Env []corev1.EnvVar `json:"env,omitempty"` // Specifies the Pull Secrets. // +optional PullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"` // Specifies the NodeSelector configuration. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Specifies the Affinity configuration. // +optional Affinity *corev1.Affinity `json:"affinity,omitempty"` // Specifies the Toleration configuration. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // Specifies the Environment variables. // +optional Resources *corev1.ResourceRequirements `json:"resources,omitempty"` }
DaskDeploymentSpec - shared structure of configurable attributes
func (*DaskDeploymentSpec) DeepCopy ¶
func (in *DaskDeploymentSpec) DeepCopy() *DaskDeploymentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskDeploymentSpec.
func (*DaskDeploymentSpec) DeepCopyInto ¶
func (in *DaskDeploymentSpec) DeepCopyInto(out *DaskDeploymentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DaskJob ¶
type DaskJob struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DaskJobSpec `json:"spec,omitempty"` Status DaskJobStatus `json:"status,omitempty"` }
DaskJob is the Schema for the daskjobs API +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Succeeded",type="integer",JSONPath=".status.succeeded",description="The number of Components Launched in the Dask",priority=0 +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="The number of Components Requested in the Dask",priority=0 +kubebuilder:printcolumn:name="State",type="string",JSONPath=".status.state",description="Status of the Dask",priority=0 +kubebuilder:printcolumn:name="Resources",type="string",JSONPath=".status.resources",description=" Resource details of the Dask",priority=1
func (*DaskJob) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskJob.
func (*DaskJob) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DaskJob) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*DaskJob) Default ¶
func (r *DaskJob) Default()
Default implements webhook.Defaulter so a webhook will be registered for the type
func (*DaskJob) SetupWebhookWithManager ¶
SetupWebhookWithManager - bootstrap manager
func (*DaskJob) ValidateCreate ¶
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*DaskJob) ValidateDelete ¶
ValidateDelete implements webhook.Validator so a webhook will be registered for the type
type DaskJobList ¶
type DaskJobList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []DaskJob `json:"items"` }
DaskJobList contains a list of DaskJob
func (*DaskJobList) DeepCopy ¶
func (in *DaskJobList) DeepCopy() *DaskJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskJobList.
func (*DaskJobList) DeepCopyInto ¶
func (in *DaskJobList) DeepCopyInto(out *DaskJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DaskJobList) DeepCopyObject ¶
func (in *DaskJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DaskJobSpec ¶
type DaskJobSpec struct { // Dask scheduler resource name that is the cluster the job will run against: mandatory Cluster string `json:"cluster"` // Dask script for this job - FQ file name, HTTP URL, or full script body either .py or .ipynb: mandatory Script string `json:"script"` // Source image to deploy cluster from - default: daskdev/dask:latest Image string `json:"image,omitempty"` // Pull Policy for image - default: IfNotPresent // +optional ImagePullPolicy string `json:"imagePullPolicy,omitempty"` // Save the report output in /reports to a persistent volume: true/false // +optional Report bool `json:"report,omitempty"` //Report StorageClass - default: standard // +optional ReportStorageClass string `json:"reportStorageClass,omitempty"` // Specifies the Volumes. // +optional Volumes []corev1.Volume `json:"volumes,omitempty"` // Specifies the VolumeMounts. // +optional VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"` // Specifies the Environment variables. // +optional Env []corev1.EnvVar `json:"env,omitempty"` // Specifies the Pull Secrets. // +optional PullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"` // Specifies the NodeSelector configuration. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Specifies the Affinity configuration. // +optional Affinity *corev1.Affinity `json:"affinity,omitempty"` // Specifies the Toleration configuration. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // Specifies the Environment variables. // +optional Resources *corev1.ResourceRequirements `json:"resources,omitempty"` }
DaskJobSpec defines the desired state of DaskJob
func (*DaskJobSpec) DeepCopy ¶
func (in *DaskJobSpec) DeepCopy() *DaskJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskJobSpec.
func (*DaskJobSpec) DeepCopyInto ¶
func (in *DaskJobSpec) DeepCopyInto(out *DaskJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DaskJobStatus ¶
type DaskJobStatus struct { // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster // Important: Run "make" to regenerate code after modifying this file Succeeded int32 `json:"succeeded"` State string `json:"state"` Resources string `json:"resources"` }
DaskJobStatus defines the observed state of DaskJob
func (*DaskJobStatus) DeepCopy ¶
func (in *DaskJobStatus) DeepCopy() *DaskJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskJobStatus.
func (*DaskJobStatus) DeepCopyInto ¶
func (in *DaskJobStatus) DeepCopyInto(out *DaskJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DaskList ¶
type DaskList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Dask `json:"items"` }
DaskList contains a list of Dask
func (*DaskList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskList.
func (*DaskList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DaskList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DaskSpec ¶
type DaskSpec struct { // Include Jupyter Notebook in deployment: true/false // +optional Jupyter bool `json:"jupyter,omitempty"` // Deploy workers like a DaemonSet - scattered one per node // +optional Daemon bool `json:"daemon,omitempty"` // Disable Network Policies // +optional DisablePolicies bool `json:"disablepolicies,omitempty"` // Number of workers to spawn - default will be 5 // +optional Replicas int32 `json:"replicas,omitempty"` // Source image to deploy cluster from - default: daskdev/dask:latest Image string `json:"image,omitempty"` // Pull Policy for image - default: IfNotPresent // +optional ImagePullPolicy string `json:"imagePullPolicy,omitempty"` // Jupyter Ingress hostname - eg: dask.local.net // +optional JupyterIngress string `json:"jupyterIngress,omitempty"` // Jupyter Password hostname - eg: password // +optional JupyterPassword string `json:"jupyterPassword,omitempty"` // Scheduler Ingress hostname - eg: scheduler.local.net // +optional SchedulerIngress string `json:"schedulerIngress,omitempty"` // Scheduler Monitor (bokeh) Ingress hostname - eg: monitor.local.net // +optional MonitorIngress string `json:"monitorIngress,omitempty"` // Specifies the Volumes. // +optional Volumes []corev1.Volume `json:"volumes,omitempty"` // Specifies the VolumeMounts. // +optional VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"` // Specifies the Environment variables. // +optional Env []corev1.EnvVar `json:"env,omitempty"` // Specifies the Pull Secrets. // +optional PullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"` // Specifies the NodeSelector configuration. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Specifies the Affinity configuration. // +optional Affinity *corev1.Affinity `json:"affinity,omitempty"` // Specifies the Toleration configuration. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // Specifies the Environment variables. // +optional Resources *corev1.ResourceRequirements `json:"resources,omitempty"` // Specifies the Scheduler specfic variables. // +optional Scheduler *DaskDeploymentSpec `json:"scheduler,omitempty"` // Specifies the Worker specfic variables. // +optional Worker *DaskDeploymentSpec `json:"worker,omitempty"` // Specifies the Jupyter notebook specfic variables. // +optional Notebook *DaskDeploymentSpec `json:"notebook,omitempty"` }
DaskSpec defines the desired state of Dask
func (*DaskSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskSpec.
func (*DaskSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DaskStatus ¶
type DaskStatus struct { Replicas int32 `json:"replicas"` Succeeded int32 `json:"succeeded"` State string `json:"state"` Resources string `json:"resources"` }
DaskStatus defines the observed state of Dask
func (*DaskStatus) DeepCopy ¶
func (in *DaskStatus) DeepCopy() *DaskStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DaskStatus.
func (*DaskStatus) DeepCopyInto ¶
func (in *DaskStatus) DeepCopyInto(out *DaskStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.