API Reference

Packages

Package api is the internal version of the API.

Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group

CatalogSource contains the sourcing information for a Catalog

Field	Description	Default	Validation
`type` SourceType	type defines the kind of Catalog content being sourced.		Enum: [image] Required: {}
`image` ImageSource	image is the catalog image that backs the content of this catalog.

ClusterCatalog is the Schema for the ClusterCatalogs API

Field	Description	Default	Validation
`apiVersion` string	`olm.operatorframework.io/v1alpha1`
`kind` string	`ClusterCatalog`
`kind` string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`apiVersion` string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` ClusterCatalogSpec
`status` ClusterCatalogStatus

ClusterCatalogList contains a list of ClusterCatalog

Field	Description	Default	Validation
`apiVersion` string	`olm.operatorframework.io/v1alpha1`
`kind` string	`ClusterCatalogList`
`kind` string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`apiVersion` string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` ClusterCatalog array

ClusterCatalogSpec defines the desired state of ClusterCatalog

Appears in: - ClusterCatalog

Field	Description	Default	Validation
`source` CatalogSource	source is the source of a Catalog that contains catalog metadata in the FBC format https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
`priority` integer	priority is used as the tie-breaker between bundles selected from different catalogs; a higher number means higher priority.	0

ClusterCatalogStatus defines the observed state of ClusterCatalog

Appears in: - ClusterCatalog

Field	Description	Default	Validation
`conditions` Condition array	conditions store the status conditions of the ClusterCatalog instances
`resolvedSource` ResolvedCatalogSource	resolvedSource contains information about the resolved source
`contentURL` string	contentURL is a cluster-internal address that on-cluster components can read the content of a catalog from
`observedGeneration` integer	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.
`lastUnpacked` Time	LastUnpacked represents the time when the ClusterCatalog object was last unpacked.

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

Appears in: - CatalogSource

Field	Description	Default	Validation
`ref` string	ref contains the reference to a container image containing Catalog contents.
`pollInterval` Duration	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.		Format: duration

ResolvedCatalogSource contains the information about a sourced Catalog

Field	Description	Default	Validation
`type` SourceType	type defines the kind of Catalog content that was sourced.		Enum: [image] Required: {}
`image` ResolvedImageSource	image is the catalog image that backs the content of this catalog.

ResolvedImageSource contains information about the sourced Catalog

Field	Description	Default	Validation
`ref` string	ref contains the reference to a container image containing Catalog contents.
`resolvedRef` string	resolvedRef contains the resolved sha256 image ref containing Catalog contents.
`lastPollAttempt` Time	lastPollAtempt is the time when the source resolved was last polled for new content.
`lastUnpacked` Time	LastUnpacked is the time when the catalog contents were successfully unpacked.

Underlying type: string

Field	Description
`image`