v1alpha1

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 15, 2022 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Overview

This package contains the CRD code, describing how the operator API will work in Kubernetes. When the contents of this package are modified, you must run `make` command to make sure files with `zz_generated.` prefix are updated, the additional code is generated as expected.

Package v1alpha1 contains API Schema definitions for the meteor v1alpha1 API group +kubebuilder:object:generate=true +groupName=meteor.zone

Index

Constants

View Source
const (
	PhasePending   = Phase("Pending")
	PhaseFailed    = Phase("Failed")
	PhaseRunning   = Phase("Running")
	PhaseBuilding  = Phase("Building")
	PhaseSucceeded = Phase("Succeeded")
	PhaseUnknown   = Phase("Unknown")
)
View Source
const (
	// PipelineRunCreated indicates that the Tekton pipeline run was created
	PipelineRunCreated = "PipelineRunCreated"

	// ErrorPipelineRunCreate indicates that the Tekton pipeline run creation failed
	ErrorPipelineRunCreate = "ErrorPipelineRunCreate"

	// ImportingImage indicates that the image is being imported from a remote registry
	ImportingImage = "ImportingImage"

	// RequredSecretMissing indicates that the secret required for authentication to the container image registry is missing
	RequiredSecretMissing = "RequiredSecretMissing"

	// ValidatingImportedImage indicates that the imported image is being validated by a Tekton PipelineRun's Step
	ValidatingImportedImage = "ValidatingImportedImage"

	// ImageImportReady indicates that the imported image is ready to be used
	ImageImportReady = "ImageImportReady"

	// ImageImportInvalid indicates that the imported image is invalid
	ImageImportInvalid = "ImageImportInvalid"

	// ErrorResolvingDependencies indicates that the dependency resolution failed during preparation of the image build
	ErrorResolvingDependencies = "ErrorResolvingDependencies"

	// BuildingImage indicates that the image is being built by a Tekton PipelineRun
	BuildingImage = "BuildingImage"

	// PackageListBuildCompleted indicates that the package list build completed
	PackageListBuildCompleted = "PackageListBuildCompleted"

	// ErrorBuildingImage indicates that the image build failed
	ErrorBuildingImage = "ErrorBuildingImage"

	// GenericPipelineError indicates that the pipeline failed with an error
	GenericPipelineError = "GenericPipelineError"

	// PipelineRunCompleted indicates that the Tekton pipeline run completed
	PipelineRunCompleted = "PipelineRunCompleted"
)
View Source
const (
	CRENameAnnotationKey        = "opendatahub.io/notebook-image-name"
	CREDescriptionAnnotationKey = "opendatahub.io/notebook-image-desc"
	CRECreatorAnnotationKey     = "opendatahub.io/notebook-image-creator"
)

CRE Annotations is a list of annotations that are added to the custom notebook image

Variables

View Source
var (
	// Group is the group name used in this package
	Group = "meteor.zone"

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

Functions

This section is empty.

Types

type BuildType

type BuildType string

BuildType describes how to build a custom notebook image. Only one of the following build types may be specified. +kubebuilder:validation:MinLength:1 +kubebuilder:validation:Enum=ImageImport;PackageList;GitRepository

const (
	// ImportImage will simply import the image from the given URL
	ImportImage BuildType = "ImageImport"

	// PackageList will build a custom image using a specific List of Python Packages
	// if no RuntimeEnvironment is specified, a baseImage must be specified for the build
	PackageList BuildType = "PackageList"

	// BuildGitRepository will builds a custom image from a git repository
	GitRepository BuildType = "GitRepository"
)

type BuildTypeSpec

type BuildTypeSpec struct {
	// BuildType is the strategy
	// +required
	// +kubebuilder:Required
	BuildType BuildType `json:"buildType"`
	// FromImage is the reference to the source image, used for import strategy
	// +optional
	FromImage string `json:"fromImage,omitempty"`
	// BaseImage is the reference to the base image, used for building
	// +optional
	BaseImage string `json:"baseImage,omitempty"`
	// Repository is the URL of the git repository, used for building
	// +optional
	Repository string `json:"repository,omitempty"`
	// GitRef is the git reference within the Repository to use for building (e.g. "main")
	// +optional
	GitRef string `json:"gitRef,omitempty"`
	// ImagePullSecret is the name of the secret to use for pulling the base image
	// +optional
	ImagePullSecret ImagePullSecret `json:"imagePullSecret,omitempty"`
}

BuildTypeSpec is the strategy super-set of configurations for all strategies.

func (*BuildTypeSpec) DeepCopy

func (in *BuildTypeSpec) DeepCopy() *BuildTypeSpec

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

func (*BuildTypeSpec) DeepCopyInto

func (in *BuildTypeSpec) DeepCopyInto(out *BuildTypeSpec)

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

type Coma

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

	Spec   ComaSpec   `json:"spec,omitempty"`
	Status ComaStatus `json:"status,omitempty"`
}

Coma is a complementary resource to Meteor in namespaces defined by Shower's externalServices property. This resource is generated automatically.

func (*Coma) DeepCopy

func (in *Coma) DeepCopy() *Coma

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

func (*Coma) DeepCopyInto

func (in *Coma) DeepCopyInto(out *Coma)

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

func (*Coma) DeepCopyObject

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

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

type ComaList

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

ComaList contains a list of Coma

func (*ComaList) DeepCopy

func (in *ComaList) DeepCopy() *ComaList

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

func (*ComaList) DeepCopyInto

func (in *ComaList) DeepCopyInto(out *ComaList)

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

func (*ComaList) DeepCopyObject

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

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

type ComaSpec

type ComaSpec struct {
}

ComaSpec defines the desired state of Coma

func (*ComaSpec) DeepCopy

func (in *ComaSpec) DeepCopy() *ComaSpec

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

func (*ComaSpec) DeepCopyInto

func (in *ComaSpec) DeepCopyInto(out *ComaSpec)

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

type ComaStatus

type ComaStatus struct {
	// Meteor owning this coma in a different namespace
	Owner NamespacedOwnerReference `json:"owner"`
}

ComaStatus defines the observed state of Coma

func (*ComaStatus) DeepCopy

func (in *ComaStatus) DeepCopy() *ComaStatus

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

func (*ComaStatus) DeepCopyInto

func (in *ComaStatus) DeepCopyInto(out *ComaStatus)

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

type ComponentStatus

type ComponentStatus struct {
	// Component is in running state
	//+optional
	Running []string `json:"running,omitempty"`
	// Component finished successfully
	//+optional
	Succeeded []string `json:"succeeded,omitempty"`
	// Component terminated with a failure
	//+optional
	Failed []string `json:"failed,omitempty"`
}

func (*ComponentStatus) DeepCopy

func (in *ComponentStatus) DeepCopy() *ComponentStatus

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

func (*ComponentStatus) DeepCopyInto

func (in *ComponentStatus) DeepCopyInto(out *ComponentStatus)

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

type CustomRuntimeEnvironment added in v0.2.0

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

	Spec   CustomRuntimeEnvironmentSpec   `json:"spec,omitempty"`
	Status CustomRuntimeEnvironmentStatus `json:"status,omitempty"`
}

CustomRuntimeEnvironment is the Schema for the customruntimeenvironments API

func (*CustomRuntimeEnvironment) AggregatePhase added in v0.2.0

func (cre *CustomRuntimeEnvironment) AggregatePhase() Phase

Aggregate phase from conditions

func (*CustomRuntimeEnvironment) DeepCopy added in v0.2.0

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

func (*CustomRuntimeEnvironment) DeepCopyInto added in v0.2.0

func (in *CustomRuntimeEnvironment) DeepCopyInto(out *CustomRuntimeEnvironment)

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

func (*CustomRuntimeEnvironment) DeepCopyObject added in v0.2.0

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

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

func (*CustomRuntimeEnvironment) Default added in v0.2.0

func (r *CustomRuntimeEnvironment) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*CustomRuntimeEnvironment) SetupWebhookWithManager added in v0.2.0

func (r *CustomRuntimeEnvironment) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*CustomRuntimeEnvironment) ValidateCreate added in v0.2.0

func (r *CustomRuntimeEnvironment) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*CustomRuntimeEnvironment) ValidateCustomRuntimeEnvironment added in v0.2.0

func (r *CustomRuntimeEnvironment) ValidateCustomRuntimeEnvironment() error

ValidateCustomRuntimeEnvironment implements webhook.Validator for create/update

func (*CustomRuntimeEnvironment) ValidateDelete added in v0.2.0

func (r *CustomRuntimeEnvironment) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*CustomRuntimeEnvironment) ValidateUpdate added in v0.2.0

func (r *CustomRuntimeEnvironment) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type CustomRuntimeEnvironmentList added in v0.2.0

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

CustomRuntimeEnvironmentList contains a list of CustomRuntimeEnvironment

func (*CustomRuntimeEnvironmentList) DeepCopy added in v0.2.0

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

func (*CustomRuntimeEnvironmentList) DeepCopyInto added in v0.2.0

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

func (*CustomRuntimeEnvironmentList) DeepCopyObject added in v0.2.0

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

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

type CustomRuntimeEnvironmentRuntimeSpec added in v0.2.0

type CustomRuntimeEnvironmentRuntimeSpec struct {
	// PythonVersion is the version of Python to use
	// +optional
	PythonVersion string `json:"pythonVersion,omitempty"`
	// OSName is the Name of the Operating System to use
	// +optional
	OSName string `json:"osName,omitempty"`
	// OSVersion is the Version of the Operating System to use
	// +optional
	OSVersion string `json:"osVersion,omitempty"`
}

CustomRuntimeEnvironmentRuntimeSpec defines a Runtime Environment, aka 'the Python version used'

func (*CustomRuntimeEnvironmentRuntimeSpec) DeepCopy added in v0.2.0

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

func (*CustomRuntimeEnvironmentRuntimeSpec) DeepCopyInto added in v0.2.0

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

type CustomRuntimeEnvironmentSpec added in v0.2.0

type CustomRuntimeEnvironmentSpec struct {
	// RuntimeEnvironment is the runtime environment to use for the Custom Runtime Environment
	// +optional
	RuntimeEnvironment CustomRuntimeEnvironmentRuntimeSpec `json:"runtimeEnvironment,omitempty"`
	// PackageVersions is a set of Packages including their Version Specifiers
	// +optional
	PackageVersions []string `json:"packageVersions,omitempty"`
	// BuildType is the configuration for the build
	// +required
	// +kubebuilder:Required
	BuildTypeSpec `json:",inline"`
}

CustomRuntimeEnvironmentSpec defines the desired state of CustomRuntimeEnvironment

func (*CustomRuntimeEnvironmentSpec) DeepCopy added in v0.2.0

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

func (*CustomRuntimeEnvironmentSpec) DeepCopyInto added in v0.2.0

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

type CustomRuntimeEnvironmentStatus added in v0.2.0

type CustomRuntimeEnvironmentStatus struct {
	// ObservedGeneration is the most recent generation observed. It corresponds to the
	// Object's generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Current condition of the Custom Runtime Environment
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Phase",xDescriptors={"urn:alm:descriptor:io.kubernetes.phase'"}
	//+optional
	Phase Phase `json:"phase,omitempty"`
	// Current service state of Meteor.
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Conditions",xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
	// Stores results from pipelines. Empty if neither pipeline has completed.
	//+optional
	Pipelines []PipelineResult `json:"pipelines,omitempty"`
}

+kubebuilder:object:generate=true CustomRuntimeEnvironmentStatus defines the observed state of CustomRuntimeEnvironment

func (*CustomRuntimeEnvironmentStatus) DeepCopy added in v0.2.0

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

func (*CustomRuntimeEnvironmentStatus) DeepCopyInto added in v0.2.0

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

func (CustomRuntimeEnvironmentStatus) IsReady added in v0.2.0

func (status CustomRuntimeEnvironmentStatus) IsReady() bool

IsReady returns true the Ready condition status is True

type ExternalServiceSpec

type ExternalServiceSpec struct {
	Name string `json:"name"`
	//+optional
	Namespace string `json:"namespace,omitempty"`
	//+optional
	Url string `json:"url,omitempty"`
}

ExternalServiceSpec defines external integration point wich can be used by pipelines submitted by Meteor

func (*ExternalServiceSpec) DeepCopy

func (in *ExternalServiceSpec) DeepCopy() *ExternalServiceSpec

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

func (*ExternalServiceSpec) DeepCopyInto

func (in *ExternalServiceSpec) DeepCopyInto(out *ExternalServiceSpec)

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

type ImagePullSecret added in v0.1.1

type ImagePullSecret struct {
	// Name of the secret to be used
	Name string `json:"name"`
}

ImagePullSecret is a secret that is used to pull images from a private registry

func (*ImagePullSecret) DeepCopy added in v0.1.1

func (in *ImagePullSecret) DeepCopy() *ImagePullSecret

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

func (*ImagePullSecret) DeepCopyInto added in v0.1.1

func (in *ImagePullSecret) DeepCopyInto(out *ImagePullSecret)

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

type IngressSpec

type IngressSpec struct {
	//+optional
	Annotations map[string]string `json:"annotations,omitempty"`
	//+optional
	Labels map[string]string `json:"labels,omitempty"`
	//+optional
	Host string `json:"host,omitempty"`
	//+optional
	Path string `json:"path,omitempty"`
}

IngressSpec configures Route resource exposed by the Shower deployment

func (*IngressSpec) DeepCopy

func (in *IngressSpec) DeepCopy() *IngressSpec

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

func (*IngressSpec) DeepCopyInto

func (in *IngressSpec) DeepCopyInto(out *IngressSpec)

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

type Meteor

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

	Spec   MeteorSpec   `json:"spec,omitempty"`
	Status MeteorStatus `json:"status,omitempty"`
}

Meteor resource represents a repository build. It defines which pipelines are executed and what is the livespan of the produced resources

func (*Meteor) AggregatePhase

func (m *Meteor) AggregatePhase() Phase

Aggregate phase from conditions

func (*Meteor) DeepCopy

func (in *Meteor) DeepCopy() *Meteor

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

func (*Meteor) DeepCopyInto

func (in *Meteor) DeepCopyInto(out *Meteor)

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

func (*Meteor) DeepCopyObject

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

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

func (*Meteor) GetExpirationTimestamp

func (m *Meteor) GetExpirationTimestamp() time.Time

func (*Meteor) GetReference

func (m *Meteor) GetReference(isController bool) NamespacedOwnerReference

func (*Meteor) GetRemainingTTL

func (m *Meteor) GetRemainingTTL() float64

func (*Meteor) IsTTLReached

func (m *Meteor) IsTTLReached() bool

Return true if TTL is reached

type MeteorConfig

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

	Spec MeteorConfigSpec `json:"spec,omitempty"`
}

MeteorConfig is the Schema for the meteorconfigs API

func (*MeteorConfig) Complete

Complete implements config.ControllerManagerConfiguration

func (*MeteorConfig) DeepCopy

func (in *MeteorConfig) DeepCopy() *MeteorConfig

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

func (*MeteorConfig) DeepCopyInto

func (in *MeteorConfig) DeepCopyInto(out *MeteorConfig)

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

func (*MeteorConfig) DeepCopyObject

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

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

type MeteorConfigSpec

type MeteorConfigSpec struct {
	metav1.TypeMeta `json:",inline"`

	// ControllerManagerConfigurationSpec returns the contfigurations for controllers
	config.ControllerManagerConfigurationSpec `json:",inline"`

	// EnableShower is the feature flar/config to enable Shower
	EnableShower bool `json:"enableComa,omitempty"`
}

MeteorConfigSpec defines the desired state of MeteorConfig

func (*MeteorConfigSpec) DeepCopy

func (in *MeteorConfigSpec) DeepCopy() *MeteorConfigSpec

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

func (*MeteorConfigSpec) DeepCopyInto

func (in *MeteorConfigSpec) DeepCopyInto(out *MeteorConfigSpec)

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

type MeteorList

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

MeteorList contains a list of Meteor

func (*MeteorList) DeepCopy

func (in *MeteorList) DeepCopy() *MeteorList

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

func (*MeteorList) DeepCopyInto

func (in *MeteorList) DeepCopyInto(out *MeteorList)

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

func (*MeteorList) DeepCopyObject

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

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

type MeteorSpec

type MeteorSpec struct {
	// Url points to the source repository.
	//+kubebuilder:validation:Pattern=`^https?:\/\/.+$`
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Repository URL",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	Url string `json:"url"`
	// Branch or tag or commit reference within the repository.
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Branch Reference",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	Ref string `json:"ref"`
	// Time to live after the resource was created.
	//+optional
	TTL int64 `json:"ttl,omitempty"`
	// List of pipelines to initiate for this meteor
	//+kubebuilder:default={jupyterhub,jupyterbook}
	Pipelines []string `json:"pipelines"`
}

MeteorSpec defines the desired state of Meteor

func (*MeteorSpec) DeepCopy

func (in *MeteorSpec) DeepCopy() *MeteorSpec

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

func (*MeteorSpec) DeepCopyInto

func (in *MeteorSpec) DeepCopyInto(out *MeteorSpec)

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

type MeteorStatus

type MeteorStatus struct {
	// Current condition of the Meteor.
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Phase",xDescriptors={"urn:alm:descriptor:io.kubernetes.phase"}
	//+optional
	Phase string `json:"phase,omitempty"`
	// Current service state of Meteor.
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Conditions",xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
	// Stores results from pipelines. Empty if neither pipeline has completed.
	//+optional
	Pipelines []PipelineResult `json:"pipelines,omitempty"`
	// Once created the expiration clock starts ticking.
	//+optional
	ExpirationTimestamp metav1.Time `json:"expirationTimestamp,omitempty"`
	// Most recent observed generation of Meteor. Sanity check.
	//+optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// List of comas owned in different namespaces
	//+optional
	Comas []NamespacedOwnerReference `json:"comas,omitempty"`
	// State of individual pipelines
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Pipelines",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:podStatuses"}
	Stage ComponentStatus `json:"stage,omitempty"`
}

MeteorStatus defines the observed state of Meteor

func (*MeteorStatus) DeepCopy

func (in *MeteorStatus) DeepCopy() *MeteorStatus

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

func (*MeteorStatus) DeepCopyInto

func (in *MeteorStatus) DeepCopyInto(out *MeteorStatus)

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

type NamespacedOwnerReference

type NamespacedOwnerReference struct {
	metav1.OwnerReference `json:",inline"`
	// Namespace of the resource
	Namespace string `json:"namespace"`
}

func (*NamespacedOwnerReference) DeepCopy

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

func (*NamespacedOwnerReference) DeepCopyInto

func (in *NamespacedOwnerReference) DeepCopyInto(out *NamespacedOwnerReference)

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

type Phase added in v0.1.1

type Phase string

Phase describes the phase of the CustomRuntimeEnvironment +kubebuilder:validation:Enum=Pending;Failed;Running;Succeeded;Unknown

type PipelineResult

type PipelineResult struct {
	Name string `json:"name"`
	// Name of the corresponding PipelineRun resource
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="PipelineRun",xDescriptors={"urn:alm:descriptor:io.kubernetes:tekton.dev:v1beta1:PipelineRun"}
	PipelineRunName string `json:"pipelineRunName"`
	// Url to a running deployment. Routable at least within the cluster. Empty if not yet scheduled.
	//+optional
	Url string `json:"url,omitempty"`
	// True if build completed successfully.
	//+optional
	Ready string `json:"ready,omitempty"`
}

func (*PipelineResult) DeepCopy

func (in *PipelineResult) DeepCopy() *PipelineResult

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

func (*PipelineResult) DeepCopyInto

func (in *PipelineResult) DeepCopyInto(out *PipelineResult)

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

type Shower

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

	Spec   ShowerSpec   `json:"spec,omitempty"`
	Status ShowerStatus `json:"status,omitempty"`
}

Shower represents a Shower UI and runtime configuration associated with Meteors produced from this instance.

func (*Shower) AggregatePhase

func (m *Shower) AggregatePhase() Phase

Aggregate phase from conditions

func (*Shower) DeepCopy

func (in *Shower) DeepCopy() *Shower

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

func (*Shower) DeepCopyInto

func (in *Shower) DeepCopyInto(out *Shower)

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

func (*Shower) DeepCopyObject

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

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

func (*Shower) GetReference

func (m *Shower) GetReference(isController bool) NamespacedOwnerReference

type ShowerList

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

ShowerList contains a list of Shower

func (*ShowerList) DeepCopy

func (in *ShowerList) DeepCopy() *ShowerList

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

func (*ShowerList) DeepCopyInto

func (in *ShowerList) DeepCopyInto(out *ShowerList)

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

func (*ShowerList) DeepCopyObject

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

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

type ShowerSpec

type ShowerSpec struct {
	// Shower UI replicas count
	//+kubebuilder:default=1
	Replicas int32 `json:"replicas"`
	// An optional custom host for Route object
	//+optional
	Ingress IngressSpec `json:"ingress,omitempty"`
	// Workspace PVC setting, defauilts to ReadWriteOnce 500Mi
	//+optional
	Workspace corev1.PersistentVolumeClaimSpec `json:"workspace,omitempty"`
	// Optional shower image. By default the same version as operator is used from quay.io/aicoe/meteor-shower
	//+optional
	Image string `json:"image,omitempty"`
	// Environment variables configuration passed to Shower Deployment spec
	//+optional
	Env []corev1.EnvVar `json:"showerEnv,omitempty"`
	// External services dependencies which can be used by individual pipelines as configurable intergrations e.g. ODH Jupyterhub namespace
	//+optional
	ExternalServices []ExternalServiceSpec `json:"externalServices,omitempty"`
	// Custom host for persistent meteors.
	//+optional
	PersistentMeteorsHost string `json:"persistentMeteorHost,omitempty"`
}

ShowerSpec defines the desired state of Shower

func (*ShowerSpec) DeepCopy

func (in *ShowerSpec) DeepCopy() *ShowerSpec

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

func (*ShowerSpec) DeepCopyInto

func (in *ShowerSpec) DeepCopyInto(out *ShowerSpec)

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

type ShowerStatus

type ShowerStatus struct {
	// Current condition of the Shower.
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Phase",xDescriptors={"urn:alm:descriptor:io.kubernetes.phase'"}
	//+optional
	Phase string `json:"phase,omitempty"`
	// Current service state of Meteor.
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Conditions",xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
	// Most recent observed generation of Shower. Sanity check.
	//+optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Optional shower image. By default the same version as operator is used from quay.io/aicoe/meteor-shower
	//+optional
	Image string `json:"image,omitempty"`
	// Route to access Shower UI
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Shower URL",xDescriptors={"urn:alm:descriptor:org.w3:link"}
	//+optional
	Url string `json:"url"`
}

ShowerStatus defines the observed state of Shower

func (*ShowerStatus) DeepCopy

func (in *ShowerStatus) DeepCopy() *ShowerStatus

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

func (*ShowerStatus) DeepCopyInto

func (in *ShowerStatus) DeepCopyInto(out *ShowerStatus)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL