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

v1alpha1

package
v0.6.0 Latest Latest
Warning

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

 Go to latest Published: Sep 13, 2023 License: Apache-2.0 Imports: 6 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 Catalog 

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

	Spec   CatalogSpec   `json:"spec,omitempty"`
	Status CatalogStatus `json:"status,omitempty"`
}

Catalog is the Schema for the Catalogs API

func (*Catalog) DeepCopy 

func (in *Catalog) DeepCopy() *Catalog

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

func (*Catalog) DeepCopyInto 

func (in *Catalog) DeepCopyInto(out *Catalog)

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

func (*Catalog) DeepCopyObject 

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

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

type CatalogList 

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

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

CatalogList contains a list of Catalog

func (*CatalogList) DeepCopy 

func (in *CatalogList) DeepCopy() *CatalogList

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

func (*CatalogList) DeepCopyInto 

func (in *CatalogList) DeepCopyInto(out *CatalogList)

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

func (*CatalogList) DeepCopyObject 

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

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

type CatalogMetadata added in v0.4.0 

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

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

CatalogMetadata is the Schema for the catalogs API

func (*CatalogMetadata) DeepCopy added in v0.4.0 

func (in *CatalogMetadata) DeepCopy() *CatalogMetadata

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

func (*CatalogMetadata) DeepCopyInto added in v0.4.0 

func (in *CatalogMetadata) DeepCopyInto(out *CatalogMetadata)

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

func (*CatalogMetadata) DeepCopyObject added in v0.4.0 

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

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

type CatalogMetadataList added in v0.4.0 

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

CatalogMetadataList contains a list of CatalogMetadata

func (*CatalogMetadataList) DeepCopy added in v0.4.0 

func (in *CatalogMetadataList) DeepCopy() *CatalogMetadataList

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

func (*CatalogMetadataList) DeepCopyInto added in v0.4.0 

func (in *CatalogMetadataList) DeepCopyInto(out *CatalogMetadataList)

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

func (*CatalogMetadataList) DeepCopyObject added in v0.4.0 

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

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

type CatalogMetadataSpec added in v0.4.0 

type CatalogMetadataSpec struct {
	Catalog corev1.LocalObjectReference `json:"catalog"`
	Schema  string                      `json:"schema"`
	Package string                      `json:"package,omitempty"`
	Name    string                      `json:"name,omitempty"`
	// +kubebuilder:validation:Schemaless
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Type=object
	Content json.RawMessage `json:"content,omitempty"`
}

CatalogMetadataSpec defines the desired state of CatalogMetadata. It is based on the `Meta` schema defined in Operator Registry (https://olm.operatorframework.io/docs/reference/file-based-catalogs/#schema) and it adheres to the format of `Meta` schema that contains fields such as `Schema` (Required), `Package` (Optional), `Name` (Optional) and `Blob`. The `CatalogMetadataSpec` is an extension of the `Meta` schema that additionally contains a `Catalog` field which references the Catalog and a `Content` field which is a JSON representation of the File-Based Catalog blob.

func (*CatalogMetadataSpec) DeepCopy added in v0.4.0 

func (in *CatalogMetadataSpec) DeepCopy() *CatalogMetadataSpec

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

func (*CatalogMetadataSpec) DeepCopyInto added in v0.4.0 

func (in *CatalogMetadataSpec) DeepCopyInto(out *CatalogMetadataSpec)

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

type CatalogSource 

type CatalogSource struct {
	// Type defines the kind of Catalog content being sourced.
	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 CatalogSpec 

type CatalogSpec 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"`
}

CatalogSpec defines the desired state of Catalog

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 CatalogStatus 

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

	ResolvedSource *CatalogSource `json:"resolvedSource,omitempty"`
	Phase          string         `json:"phase,omitempty"`
}

CatalogStatus defines the observed state of Catalog

func (*CatalogStatus) DeepCopy 

func (in *CatalogStatus) DeepCopy() *CatalogStatus

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

func (*CatalogStatus) DeepCopyInto 

func (in *CatalogStatus) DeepCopyInto(out *CatalogStatus)

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"`
}

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 SourceType 

type SourceType string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.