Help us shape the future of Go! Take the 2026 Go Developer Survey

v1alpha1

package
v0.20.0 Latest Latest
Warning

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

Go to latest
Published: Jul 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source
const (
	SourceTypeImage SourceType = "image"

	TypeUnpacked = "Unpacked"
	TypeDelete   = "Delete"

	ReasonUnpackPending       = "UnpackPending"
	ReasonUnpacking           = "Unpacking"
	ReasonUnpackSuccessful    = "UnpackSuccessful"
	ReasonUnpackFailed        = "UnpackFailed"
	ReasonStorageFailed       = "FailedToStore"
	ReasonStorageDeleteFailed = "FailedToDelete"

	PhasePending   = "Pending"
	PhaseUnpacking = "Unpacking"
	PhaseFailing   = "Failing"
	PhaseUnpacked  = "Unpacked"
)

Variables

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

Functions

This section is empty.

Types

type CatalogSource

type CatalogSource struct {
	// Type defines the kind of Catalog content being sourced.
	// +kubebuilder:validation:Enum=image
	Type SourceType `json:"type"`
	// Image is the catalog image that backs the content of this catalog.
	Image *ImageSource `json:"image,omitempty"`
}

CatalogSource contains the sourcing information for a Catalog

func (*CatalogSource) DeepCopy

func (in *CatalogSource) DeepCopy() *CatalogSource

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

func (*CatalogSource) DeepCopyInto

func (in *CatalogSource) DeepCopyInto(out *CatalogSource)

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

type ClusterCatalog added in v0.13.0

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

	Spec   ClusterCatalogSpec   `json:"spec,omitempty"`
	Status ClusterCatalogStatus `json:"status,omitempty"`
}

ClusterCatalog is the Schema for the ClusterCatalogs API

func (*ClusterCatalog) DeepCopy added in v0.13.0

func (in *ClusterCatalog) DeepCopy() *ClusterCatalog

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

func (*ClusterCatalog) DeepCopyInto added in v0.13.0

func (in *ClusterCatalog) DeepCopyInto(out *ClusterCatalog)

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

func (*ClusterCatalog) DeepCopyObject added in v0.13.0

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

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

type ClusterCatalogList added in v0.13.0

type ClusterCatalogList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []ClusterCatalog `json:"items"`
}

ClusterCatalogList contains a list of ClusterCatalog

func (*ClusterCatalogList) DeepCopy added in v0.13.0

func (in *ClusterCatalogList) DeepCopy() *ClusterCatalogList

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

func (*ClusterCatalogList) DeepCopyInto added in v0.13.0

func (in *ClusterCatalogList) DeepCopyInto(out *ClusterCatalogList)

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

func (*ClusterCatalogList) DeepCopyObject added in v0.13.0

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

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

type ClusterCatalogSpec added in v0.13.0

type ClusterCatalogSpec struct {
	// Source is the source of a Catalog that contains Operators' metadata in the FBC format
	// https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
	Source CatalogSource `json:"source"`
}

ClusterCatalogSpec defines the desired state of ClusterCatalog +kubebuilder:validation:XValidation:rule="!has(self.source.image.pollInterval) || (self.source.image.ref.find('@sha256:') == \"\")",message="cannot specify PollInterval while using digest-based image"

func (*ClusterCatalogSpec) DeepCopy added in v0.13.0

func (in *ClusterCatalogSpec) DeepCopy() *ClusterCatalogSpec

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

func (*ClusterCatalogSpec) DeepCopyInto added in v0.13.0

func (in *ClusterCatalogSpec) DeepCopyInto(out *ClusterCatalogSpec)

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

type ClusterCatalogStatus added in v0.13.0

type ClusterCatalogStatus struct {
	// Conditions store the status conditions of the ClusterCatalog instances
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

	// ResolvedSource contains information about the resolved source
	ResolvedSource *ResolvedCatalogSource `json:"resolvedSource,omitempty"`
	// Phase represents a human-readable status of resolution of the content source.
	// It is not appropriate to use for business logic determination.
	Phase string `json:"phase,omitempty"`
	// ContentURL is a cluster-internal address that on-cluster components
	// can read the content of a catalog from
	ContentURL string `json:"contentURL,omitempty"`
	// observedGeneration is the most recent generation observed for this ClusterCatalog. It corresponds to the
	// ClusterCatalog's generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

ClusterCatalogStatus defines the observed state of ClusterCatalog

func (*ClusterCatalogStatus) DeepCopy added in v0.13.0

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

func (*ClusterCatalogStatus) DeepCopyInto added in v0.13.0

func (in *ClusterCatalogStatus) DeepCopyInto(out *ClusterCatalogStatus)

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

type ImageSource

type ImageSource struct {
	// Ref contains the reference to a container image containing Catalog contents.
	Ref string `json:"ref"`
	// PullSecret contains the name of the image pull secret in the namespace that catalogd is deployed.
	PullSecret string `json:"pullSecret,omitempty"`
	// PollInterval indicates the interval at which the image source should be polled for new content,
	// specified as a duration (e.g., "5m", "1h", "24h", "etc".). Note that PollInterval may not be
	// specified for a catalog image referenced by a sha256 digest.
	// +kubebuilder:validation:Format:=duration
	PollInterval *metav1.Duration `json:"pollInterval,omitempty"`
	// InsecureSkipTLSVerify indicates that TLS certificate validation should be skipped.
	// If this option is specified, the HTTPS protocol will still be used to
	// fetch the specified image reference.
	// This should not be used in a production environment.
	// +optional
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
}

ImageSource contains information required for sourcing a Catalog from an OCI image

func (*ImageSource) DeepCopy

func (in *ImageSource) DeepCopy() *ImageSource

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

func (*ImageSource) DeepCopyInto

func (in *ImageSource) DeepCopyInto(out *ImageSource)

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

type ResolvedCatalogSource added in v0.8.0

type ResolvedCatalogSource struct {
	// Type defines the kind of Catalog content that was sourced.
	Type SourceType `json:"type"`
	// Image is the catalog image that backs the content of this catalog.
	Image *ResolvedImageSource `json:"image,omitempty"`
}

ResolvedCatalogSource contains the information about a sourced Catalog

func (*ResolvedCatalogSource) DeepCopy added in v0.8.0

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

func (*ResolvedCatalogSource) DeepCopyInto added in v0.8.0

func (in *ResolvedCatalogSource) DeepCopyInto(out *ResolvedCatalogSource)

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

type ResolvedImageSource added in v0.8.0

type ResolvedImageSource struct {
	// Ref contains the reference to a container image containing Catalog contents.
	Ref string `json:"ref"`
	// ResolvedRef contains the resolved sha256 image ref containing Catalog contents.
	ResolvedRef string `json:"resolvedRef"`
	// LastPollAtempt is the time when the source resolved was last polled for new content.
	LastPollAttempt metav1.Time `json:"lastPollAttempt"`
	// pullSecret exists to retain compatibility with the existing v1alpha1 APIs. It will be removed in v1alpha2.
	PullSecret string `json:"pullSecret,omitempty"`
}

ResolvedImageSource contains information about the sourced Catalog

func (*ResolvedImageSource) DeepCopy added in v0.8.0

func (in *ResolvedImageSource) DeepCopy() *ResolvedImageSource

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

func (*ResolvedImageSource) DeepCopyInto added in v0.8.0

func (in *ResolvedImageSource) DeepCopyInto(out *ResolvedImageSource)

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

type SourceType

type SourceType string

Jump to

Keyboard shortcuts

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