v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=core.olm.io

Index

• Variables
• func SetActiveBundleDeployment(o *Operator, name string)
• func SetSourceInfo(o *Operator, info SourceInfo)
• type ActiveBundleDeployment
  • func (in *ActiveBundleDeployment) DeepCopy() *ActiveBundleDeployment
  • func (in *ActiveBundleDeployment) DeepCopyInto(out *ActiveBundleDeployment)
• type CatalogSpec
  • func (in *CatalogSpec) DeepCopy() *CatalogSpec
  • func (in *CatalogSpec) DeepCopyInto(out *CatalogSpec)
• type Operator
  • func (in *Operator) DeepCopy() *Operator
  • func (in *Operator) DeepCopyInto(out *Operator)
  • func (in *Operator) DeepCopyObject() runtime.Object
• type OperatorList
  • func (in *OperatorList) DeepCopy() *OperatorList
  • func (in *OperatorList) DeepCopyInto(out *OperatorList)
  • func (in *OperatorList) DeepCopyObject() runtime.Object
• type OperatorSpec
  • func (in *OperatorSpec) DeepCopy() *OperatorSpec
  • func (in *OperatorSpec) DeepCopyInto(out *OperatorSpec)
• type OperatorStatus
  • func (in *OperatorStatus) DeepCopy() *OperatorStatus
  • func (in *OperatorStatus) DeepCopyInto(out *OperatorStatus)
• type PackageSpec
  • func (in *PackageSpec) DeepCopy() *PackageSpec
  • func (in *PackageSpec) DeepCopyInto(out *PackageSpec)
• type SourceInfo
  • func (in *SourceInfo) DeepCopy() *SourceInfo
  • func (in *SourceInfo) DeepCopyInto(out *SourceInfo)

Variables

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

var (
	TypeInstalled = "Installed"

	ReasonSourceFailed  = "SourceFailed"
	ReasonUnpackPending = "UnpackPending"

	ReasonInstallFailed     = "InstallFailed"
	ReasonInstallSuccessful = "InstallSuccessful"
	ReasonInstallPending    = "InstallPending"
)

Functions

func SetActiveBundleDeployment

func SetActiveBundleDeployment(o *Operator, name string)

SetActiveBundleDeployment is responsible for populating the status.ActiveBundleDeployment structure with the Operator resource the POM component is currently managing.

func SetSourceInfo

func SetSourceInfo(o *Operator, info SourceInfo)

SetSourceInfo is responsible for populating the status.SourceInfo structure with the Operator resource the POM component is currently managing.

Types

type ActiveBundleDeployment

type ActiveBundleDeployment struct {
	// name is the metadata.name of the referenced BundleDeployment object.
	// +kubebuilder:validation:Required
	Name string `json:"name"`
}

ActiveBundleDeployment references a BundleDeployment resource.

func (*ActiveBundleDeployment) DeepCopy

func (in *ActiveBundleDeployment) DeepCopy() *ActiveBundleDeployment

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

func (*ActiveBundleDeployment) DeepCopyInto

func (in *ActiveBundleDeployment) DeepCopyInto(out *ActiveBundleDeployment)

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

type CatalogSpec

type CatalogSpec struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
}

func (*CatalogSpec) DeepCopy

func (in *CatalogSpec) DeepCopy() *CatalogSpec

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

func (*CatalogSpec) DeepCopyInto

func (in *CatalogSpec) DeepCopyInto(out *CatalogSpec)

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

type Operator

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

	Spec   OperatorSpec   `json:"spec,omitempty"`
	Status OperatorStatus `json:"status,omitempty"`
}

Operator is the Schema for the operators API

func (*Operator) DeepCopy

func (in *Operator) DeepCopy() *Operator

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

func (*Operator) DeepCopyInto

func (in *Operator) DeepCopyInto(out *Operator)

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

func (*Operator) DeepCopyObject

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

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

type OperatorList

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

OperatorList contains a list of Operator

func (*OperatorList) DeepCopy

func (in *OperatorList) DeepCopy() *OperatorList

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

func (*OperatorList) DeepCopyInto

func (in *OperatorList) DeepCopyInto(out *OperatorList)

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

func (*OperatorList) DeepCopyObject

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

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

type OperatorSpec

type OperatorSpec struct {
	Catalog *CatalogSpec `json:"catalog,omitempty"`
	Package *PackageSpec `json:"package"`
}

OperatorSpec defines the desired state of Operator

func (*OperatorSpec) DeepCopy

func (in *OperatorSpec) DeepCopy() *OperatorSpec

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

func (*OperatorSpec) DeepCopyInto

func (in *OperatorSpec) DeepCopyInto(out *OperatorSpec)

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

type OperatorStatus

type OperatorStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// activeBundleDeployment is the reference to the BundleDeployment resource that's
	// being managed by this Operator resource. If this field is not populated in the status
	// then it means the Operator has either not been installed yet or is failing to install.
	// +optional
	ActiveBundleDeployment ActiveBundleDeployment `json:"activeBundleDeployment,omitempty"`

	// sourceInfo is the reference to the previously sourced catalog data that's being
	// installed by this Operator resource.
	SourceInfo SourceInfo `json:"sourceInfo,omitempty"`
}

OperatorStatus defines the observed state of Operator

func (*OperatorStatus) DeepCopy

func (in *OperatorStatus) DeepCopy() *OperatorStatus

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

func (*OperatorStatus) DeepCopyInto

func (in *OperatorStatus) DeepCopyInto(out *OperatorStatus)

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

type PackageSpec

type PackageSpec struct {
	Name    string `json:"name"`
	Version string `json:"version,omitempty"`
}

func (*PackageSpec) DeepCopy

func (in *PackageSpec) DeepCopy() *PackageSpec

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

func (*PackageSpec) DeepCopyInto

func (in *PackageSpec) DeepCopyInto(out *PackageSpec)

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

type SourceInfo

type SourceInfo struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
	Version   string `json:"version"`
}

SourceInfo contains metadata information for the current bundle being managed by an Operator resource.

func (*SourceInfo) DeepCopy

func (in *SourceInfo) DeepCopy() *SourceInfo

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

func (*SourceInfo) DeepCopyInto

func (in *SourceInfo) DeepCopyInto(out *SourceInfo)

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