Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group +kubebuilder:object:generate=true +groupName=catalogd.operatorframework.io
Index ¶
- Constants
- Variables
- type BundleMetadata
- type BundleMetadataList
- type BundleMetadataSpec
- type BundleMetadataStatus
- type Catalog
- type CatalogList
- type CatalogSource
- type CatalogSpec
- type CatalogStatus
- type ChannelEntry
- type Icon
- type ImageSource
- type Package
- type PackageChannel
- type PackageList
- type PackageSpec
- type PackageStatus
- type Property
- type RelatedImage
- type SourceType
Constants ¶
const ( SourceTypeImage SourceType = "image" TypeUnpacked = "Unpacked" ReasonUnpackPending = "UnpackPending" ReasonUnpacking = "Unpacking" ReasonUnpackSuccessful = "UnpackSuccessful" ReasonUnpackFailed = "UnpackFailed" PhasePending = "Pending" PhaseUnpacking = "Unpacking" PhaseFailing = "Failing" PhaseUnpacked = "Unpacked" )
Variables ¶
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 BundleMetadata ¶
type BundleMetadata struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec BundleMetadataSpec `json:"spec,omitempty"`
Status BundleMetadataStatus `json:"status,omitempty"`
}
BundleMetadata is the Schema for the bundlemetadata API
func (*BundleMetadata) DeepCopy ¶
func (in *BundleMetadata) DeepCopy() *BundleMetadata
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleMetadata.
func (*BundleMetadata) DeepCopyInto ¶
func (in *BundleMetadata) DeepCopyInto(out *BundleMetadata)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BundleMetadata) DeepCopyObject ¶
func (in *BundleMetadata) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BundleMetadataList ¶
type BundleMetadataList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []BundleMetadata `json:"items"`
}
BundleMetadataList contains a list of BundleMetadata
func (*BundleMetadataList) DeepCopy ¶
func (in *BundleMetadataList) DeepCopy() *BundleMetadataList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleMetadataList.
func (*BundleMetadataList) DeepCopyInto ¶
func (in *BundleMetadataList) DeepCopyInto(out *BundleMetadataList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BundleMetadataList) DeepCopyObject ¶
func (in *BundleMetadataList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BundleMetadataSpec ¶
type BundleMetadataSpec struct {
// Catalog is the name of the Catalog that provides this bundle
Catalog corev1.LocalObjectReference `json:"catalog"`
// Package is the name of the package that provides this bundle
Package string `json:"package"`
// Image is a reference to the image that provides the bundle contents
Image string `json:"image"`
// Properties is a string of references to property objects that are part of the bundle
Properties []Property `json:"properties,omitempty"`
// RelatedImages are the RelatedImages in the bundle
RelatedImages []RelatedImage `json:"relatedImages,omitempty"`
}
BundleMetadataSpec defines the desired state of BundleMetadata
func (*BundleMetadataSpec) DeepCopy ¶
func (in *BundleMetadataSpec) DeepCopy() *BundleMetadataSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleMetadataSpec.
func (*BundleMetadataSpec) DeepCopyInto ¶
func (in *BundleMetadataSpec) DeepCopyInto(out *BundleMetadataSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BundleMetadataStatus ¶
type BundleMetadataStatus struct{}
BundleMetadataStatus defines the observed state of BundleMetadata
func (*BundleMetadataStatus) DeepCopy ¶
func (in *BundleMetadataStatus) DeepCopy() *BundleMetadataStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleMetadataStatus.
func (*BundleMetadataStatus) DeepCopyInto ¶
func (in *BundleMetadataStatus) DeepCopyInto(out *BundleMetadataStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Catalog.
func (*Catalog) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Catalog) DeepCopyObject ¶
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 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 ChannelEntry ¶
type ChannelEntry struct {
Name string `json:"name"`
Replaces string `json:"replaces,omitempty"`
Skips []string `json:"skips,omitempty"`
SkipRange string `json:"skipRange,omitempty"`
}
func (*ChannelEntry) DeepCopy ¶
func (in *ChannelEntry) DeepCopy() *ChannelEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelEntry.
func (*ChannelEntry) DeepCopyInto ¶
func (in *ChannelEntry) DeepCopyInto(out *ChannelEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Icon ¶
type Icon struct {
Data []byte `json:"data,omitempty"`
MediaType string `json:"mediatype,omitempty"`
}
Icon defines a base64 encoded icon and media type
func (*Icon) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Icon.
func (*Icon) DeepCopyInto ¶
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 Package ¶
type Package struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PackageSpec `json:"spec,omitempty"`
Status PackageStatus `json:"status,omitempty"`
}
Package is the Schema for the packages API
func (*Package) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Package.
func (*Package) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Package) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageChannel ¶
type PackageChannel struct {
// Name is the name of the channel, e.g. `alpha` or `stable`
Name string `json:"name"`
// Entries is all the channel entries within a channel
Entries []ChannelEntry `json:"entries"`
}
PackageChannel defines a single channel under a package, pointing to a version of that package.
func (*PackageChannel) DeepCopy ¶
func (in *PackageChannel) DeepCopy() *PackageChannel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageChannel.
func (*PackageChannel) DeepCopyInto ¶
func (in *PackageChannel) DeepCopyInto(out *PackageChannel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageList ¶
type PackageList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Package `json:"items"`
}
PackageList contains a list of Package
func (*PackageList) DeepCopy ¶
func (in *PackageList) DeepCopy() *PackageList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageList.
func (*PackageList) DeepCopyInto ¶
func (in *PackageList) DeepCopyInto(out *PackageList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageList) DeepCopyObject ¶
func (in *PackageList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageSpec ¶
type PackageSpec struct {
// Catalog is the name of the Catalog this package belongs to
Catalog corev1.LocalObjectReference `json:"catalog"`
// Name is the name of the package, ala `etcd`.
Name string `json:"packageName"`
// Description is the description of the package
Description string `json:"description"`
// Channels are the declared channels for the package, ala `stable` or `alpha`.
Channels []PackageChannel `json:"channels"`
//Icon is the Base64data image of the package for console display
Icon *Icon `json:"icon,omitempty"`
// DefaultChannel is, if specified, the name of the default channel for the package. The
// default channel will be installed if no other channel is explicitly given. If the package
// has a single channel, then that channel is implicitly the default.
DefaultChannel string `json:"defaultChannel"`
}
PackageSpec defines the desired state of Package
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 PackageStatus ¶
type PackageStatus struct{}
PackageStatus defines the observed state of Package
func (*PackageStatus) DeepCopy ¶
func (in *PackageStatus) DeepCopy() *PackageStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageStatus.
func (*PackageStatus) DeepCopyInto ¶
func (in *PackageStatus) DeepCopyInto(out *PackageStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Property ¶
type Property struct {
Type string `json:"type"`
// +kubebuilder:pruning:PreserveUnknownFields
// +kubebuilder:validation:Schemaless
Value json.RawMessage `json:"value"`
}
func (*Property) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Property.
func (*Property) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RelatedImage ¶
TODO: In the future we should remove this in favor of using `declcfg.RelatedImage` (or similar) from https://pkg.go.dev/github.com/operator-framework/operator-registry@v1.26.3/alpha/declcfg#RelatedImage This will likely require some changes to the `declcfg.RelatedImage` type to make it suitable for usage within the Spec for a CustomResource
func (*RelatedImage) DeepCopy ¶
func (in *RelatedImage) DeepCopy() *RelatedImage
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RelatedImage.
func (*RelatedImage) DeepCopyInto ¶
func (in *RelatedImage) DeepCopyInto(out *RelatedImage)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SourceType ¶
type SourceType string