v1alpha1

Documentation

Overview

Package v1 contains API Schema definitions for the batch v1 API group +kubebuilder:object:generate=true +groupName=eraser.sh

Index

• Variables
• type Image
  • func (in *Image) DeepCopy() *Image
  • func (in *Image) DeepCopyInto(out *Image)
• type ImageJob
  • func (in *ImageJob) DeepCopy() *ImageJob
  • func (in *ImageJob) DeepCopyInto(out *ImageJob)
  • func (in *ImageJob) DeepCopyObject() runtime.Object
• type ImageJobList
  • func (in *ImageJobList) DeepCopy() *ImageJobList
  • func (in *ImageJobList) DeepCopyInto(out *ImageJobList)
  • func (in *ImageJobList) DeepCopyObject() runtime.Object
• type ImageJobSpec
  • func (in *ImageJobSpec) DeepCopy() *ImageJobSpec
  • func (in *ImageJobSpec) DeepCopyInto(out *ImageJobSpec)
• type ImageJobStatus
  • func (in *ImageJobStatus) DeepCopy() *ImageJobStatus
  • func (in *ImageJobStatus) DeepCopyInto(out *ImageJobStatus)
• type ImageList
  • func (in *ImageList) DeepCopy() *ImageList
  • func (in *ImageList) DeepCopyInto(out *ImageList)
  • func (in *ImageList) DeepCopyObject() runtime.Object
• type ImageListList
  • func (in *ImageListList) DeepCopy() *ImageListList
  • func (in *ImageListList) DeepCopyInto(out *ImageListList)
  • func (in *ImageListList) DeepCopyObject() runtime.Object
• type ImageListSpec
  • func (in *ImageListSpec) DeepCopy() *ImageListSpec
  • func (in *ImageListSpec) DeepCopyInto(out *ImageListSpec)
• type ImageListStatus
  • func (in *ImageListStatus) DeepCopy() *ImageListStatus
  • func (in *ImageListStatus) DeepCopyInto(out *ImageListStatus)
• type JobPhase

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "eraser.sh", 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
)

Types

type Image

type Image struct {
	ImageID string   `json:"image_id"`
	Names   []string `json:"names,omitempty"`
	Digests []string `json:"digests,omitempty"`
}

func (*Image) DeepCopy

func (in *Image) DeepCopy() *Image

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

func (*Image) DeepCopyInto

func (in *Image) DeepCopyInto(out *Image)

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

type ImageJob

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

	Spec   ImageJobSpec   `json:"spec,omitempty"`
	Status ImageJobStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope="Cluster" ImageJob is the Schema for the imagejobs API.

func (*ImageJob) DeepCopy

func (in *ImageJob) DeepCopy() *ImageJob

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

func (*ImageJob) DeepCopyInto

func (in *ImageJob) DeepCopyInto(out *ImageJob)

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

func (*ImageJob) DeepCopyObject

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

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

type ImageJobList

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

ImageJobList contains a list of ImageJob.

func (*ImageJobList) DeepCopy

func (in *ImageJobList) DeepCopy() *ImageJobList

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

func (*ImageJobList) DeepCopyInto

func (in *ImageJobList) DeepCopyInto(out *ImageJobList)

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

func (*ImageJobList) DeepCopyObject

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

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

type ImageJobSpec

type ImageJobSpec struct {
	// Specifies the job that will be created when executing an ImageJob.
	JobTemplate v1.PodTemplateSpec `json:"template"`
}

ImageJobSpec defines the desired state of ImageJob.

func (*ImageJobSpec) DeepCopy

func (in *ImageJobSpec) DeepCopy() *ImageJobSpec

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

func (*ImageJobSpec) DeepCopyInto

func (in *ImageJobSpec) DeepCopyInto(out *ImageJobSpec)

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

type ImageJobStatus

type ImageJobStatus struct {
	// number of pods that failed
	Failed int `json:"failed"`

	// number of pods that completed successfully
	Succeeded int `json:"succeeded"`

	// desired number of pods
	Desired int `json:"desired"`

	// number of nodes that were skipped e.g. because they are not a linux node
	Skipped int `json:"skipped"`

	// job running, successfully completed, or failed
	Phase JobPhase `json:"phase"`

	// Time to delay deletion until
	DeleteAfter *metav1.Time `json:"deleteAfter,omitempty"`
}

ImageJobStatus defines the observed state of ImageJob.

func (*ImageJobStatus) DeepCopy

func (in *ImageJobStatus) DeepCopy() *ImageJobStatus

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

func (*ImageJobStatus) DeepCopyInto

func (in *ImageJobStatus) DeepCopyInto(out *ImageJobStatus)

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

type ImageList

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

	Spec   ImageListSpec   `json:"spec,omitempty"`
	Status ImageListStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope="Cluster" ImageList is the Schema for the imagelists API.

func (*ImageList) DeepCopy

func (in *ImageList) DeepCopy() *ImageList

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

func (*ImageList) DeepCopyInto

func (in *ImageList) DeepCopyInto(out *ImageList)

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

func (*ImageList) DeepCopyObject

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

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

type ImageListList

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

ImageListList contains a list of ImageList.

func (*ImageListList) DeepCopy

func (in *ImageListList) DeepCopy() *ImageListList

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

func (*ImageListList) DeepCopyInto

func (in *ImageListList) DeepCopyInto(out *ImageListList)

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

func (*ImageListList) DeepCopyObject

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

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

type ImageListSpec

type ImageListSpec struct {
	// The list of non-compliant images to delete if non-running.
	Images []string `json:"images"`
}

ImageListSpec defines the desired state of ImageList.

func (*ImageListSpec) DeepCopy

func (in *ImageListSpec) DeepCopy() *ImageListSpec

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

func (*ImageListSpec) DeepCopyInto

func (in *ImageListSpec) DeepCopyInto(out *ImageListSpec)

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

type ImageListStatus

type ImageListStatus struct {
	// Information when the job was completed.
	Timestamp *metav1.Time `json:"timestamp"`
	// Number of nodes that successfully ran the job
	Success int64 `json:"success"`
	// Number of nodes that failed to run the job
	Failed int64 `json:"failed"`
	// Number of nodes that were skipped due to a skip selector
	Skipped int64 `json:"skipped"`
}

ImageListStatus defines the observed state of ImageList.

func (*ImageListStatus) DeepCopy

func (in *ImageListStatus) DeepCopy() *ImageListStatus

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

func (*ImageListStatus) DeepCopyInto

func (in *ImageListStatus) DeepCopyInto(out *ImageListStatus)

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

type JobPhase

type JobPhase string

JobPhase defines the phase of an ImageJob status.

const (
	PhaseRunning   JobPhase = "Running"
	PhaseCompleted JobPhase = "Completed"
	PhaseFailed    JobPhase = "Failed"
)