Catalogd, the OLM v1 component for making catalog contents available on cluster, includes +a web server that serves catalog contents to clients via an HTTP(S) endpoint.
+The endpoint to retrieve this information can be composed from the .status.urls.base of a ClusterCatalog resource with the selected access API path.
+As an example, to access the full FBC via the v1 API endpoint (indicated by path api/v1/all) where .status.urls.base is
the URL to access the service would be https://catalogd-service.olmv1-system.svc/catalogs/operatorhubio/api/v1/all
Note
+The values of the .status.urls field in a ClusterCatalog resource are arbitrary string values and can change at any time.
+While there are no guarantees on the exact value of this field, it will always contain catalog-specific API endpoints for use
+by clients to make a request from within the cluster.
The HTTP request methods supported by the catalogd web server are:
+ +Responses are encoded as a JSON Lines stream of File-Based Catalog (FBC) Meta objects delimited by newlines.
+{
+ "schema": "olm.package",
+ "name": "cockroachdb",
+ "defaultChannel": "stable-v6.x",
+}
+{
+ "schema": "olm.channel",
+ "name": "stable-v6.x",
+ "package": "cockroachdb",
+ "entries": [
+ {
+ "name": "cockroachdb.v6.0.0",
+ "skipRange": "<6.0.0"
+ }
+ ]
+}
+{
+ "schema": "olm.bundle",
+ "name": "cockroachdb.v6.0.0",
+ "package": "cockroachdb",
+ "image": "quay.io/openshift-community-operators/cockroachdb@sha256:d3016b1507515fc7712f9c47fd9082baf9ccb070aaab58ed0ef6e5abdedde8ba",
+ "properties": [
+ {
+ "type": "olm.package",
+ "value": {
+ "packageName": "cockroachdb",
+ "version": "6.0.0"
+ }
+ },
+ ],
+}
+Corresponding JSON lines response: +
{"schema":"olm.package","name":"cockroachdb","defaultChannel":"stable-v6.x"}
+{"schema":"olm.channel","name":"stable-v6.x","package":"cockroachdb","entries":[{"name":"cockroachdb.v6.0.0","skipRange":"<6.0.0"}]}
+{"schema":"olm.bundle","name":"cockroachdb.v6.0.0","package":"cockroachdb","image":"quay.io/openshift-community-operators/cockroachdb@sha256:d3016b1507515fc7712f9c47fd9082baf9ccb070aaab58ed0ef6e5abdedde8ba","properties":[{"type":"olm.package","value":{"packageName":"cockroachdb","version":"6.0.0"}}]}
+The catalogd web server supports gzip compression of responses, which can significantly reduce associated network traffic. In order to signal that the client handles compressed responses, the client must include Accept-Encoding: gzip as a header in the HTTP request.
The web server will include a Content-Encoding: gzip header in compressed responses.
Note
+Only catalogs whose uncompressed response body would result in a response size greater than 1400 bytes will be compressed.
+For clients interested in caching the information returned from the catalogd web server, the Last-Modified header is set
+on responses and the If-Modified-Since header is supported for requests.
Package v1 contains API Schema definitions for the olm v1 API group
+Assertion is a discriminated union which defines the probe type and definition used as an assertion.
+Appears in: +- ProgressionProbe
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
type ProbeType |
+type is a required field which specifies the type of probe to use. The allowed probe types are "ConditionEqual", "FieldsEqual", and "FieldValue". When set to "ConditionEqual", the probe checks objects that have reached a condition of specified type and status. When set to "FieldsEqual", the probe checks that the values found at two provided field paths are matching. When set to "FieldValue", the probe checks that the value found at the provided field path matches what was specified. Experimental channel: |
++ | Enum: [ConditionEqual FieldsEqual FieldValue] Required: {} |
+
conditionEqual ConditionEqualProbe |
+conditionEqual contains the expected condition type and status. Experimental channel: |
++ | Optional: {} |
+
fieldsEqual FieldsEqualProbe |
+fieldsEqual contains the two field paths whose values are expected to match. Experimental channel: |
++ | Optional: {} |
+
fieldValue FieldValueProbe |
+fieldValue contains the expected field path and value found within. Experimental channel: |
++ | Optional: {} |
+
Underlying type: string
+AvailabilityMode defines the availability of the catalog
+Appears in: +- ClusterCatalogSpec
+| Field | +Description | +
|---|---|
Available |
++ |
Unavailable |
++ |
BundleMetadata is a representation of the identifying attributes of a bundle.
+Appears in: +- ClusterExtensionInstallStatus
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
name string |
+name is required and follows the DNS subdomain standard as defined in [RFC 1123]. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters. |
++ | Required: {} |
+
version string |
+version is required and references the version that this bundle represents. It follows the semantic versioning standard as defined in https://semver.org/. |
++ | Required: {} |
+
release string |
+release is an optional field that identifies a specific release of this bundle's version. A release represents a re-publication of the same version, typically used to deliver packaging or metadata changes without changing the version number. When multiple releases exist for the same version, higher releases are preferred. An unset release is less preferred than all other release values. The value consists of dot-separated identifiers, where each identifier is either a numeric value (without leading zeros) or an alphanumeric string (e.g., "2", "1.el9", "3.alpha.1"). Releases are compared identifier by identifier: numeric identifiers are compared as integers, alphanumeric identifiers are compared lexically, and numeric identifiers always sort before alphanumeric identifiers. For bundles with explicit pkg.Release metadata, this field contains that release value. For registry+v1 bundles lacking an explicit release value, this field contains the release extracted from version's build metadata (e.g., '2' from '1.0.0+2'). This field is omitted when the bundle's release value is unset. Experimental channel: |
++ | MaxLength: 20 Optional: {} |
+
Underlying type: string
+Appears in: +- CRDUpgradeSafetyPreflightConfig
+| Field | +Description | +
|---|---|
None |
+None will not perform CRD upgrade safety checks. |
+
Strict |
+Strict will enforce the CRD upgrade safety check and block the upgrade if the CRD would not pass the check. |
+
CRDUpgradeSafetyPreflightConfig is the configuration for CRD upgrade safety preflight check.
+Appears in: +- PreflightConfig
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
enforcement CRDUpgradeSafetyEnforcement |
+enforcement is required and configures the state of the CRD Upgrade Safety pre-flight check. Allowed values are "None" or "Strict". The default value is "Strict". When set to "None", the CRD Upgrade Safety pre-flight check is skipped during an upgrade operation. Use this option with caution as unintended consequences such as data loss can occur. When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. |
++ | Enum: [None Strict] Required: {} |
+
CatalogFilter defines the attributes used to identify and filter content from a catalog.
+Appears in: +- SourceConfig
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
packageName string |
+packageName specifies the name of the package to be installed and is used to filter the content from catalogs. It is required, immutable, and follows the DNS subdomain standard as defined in [RFC 1123]. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters. Some examples of valid values are: - some-package - 123-package - 1-package-2 - somepackage Some examples of invalid values are: - -some-package - some-package- - thisisareallylongpackagenamethatisgreaterthanthemaximumlength - some.package [RFC 1123]: https://tools.ietf.org/html/rfc1123 |
++ | MaxLength: 253 Required: {} |
+
version string |
+version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available is installed. Acceptable version ranges are no longer than 64 characters. Version ranges are composed of comma- or space-delimited values and one or more comparison operators, known as comparison strings. You can add additional comparison strings using the OR operator (||). # Range Comparisons To specify a version range, you can use a comparison string like ">=3.0, <3.6". When specifying a range, automatic updates will occur within that range. The example comparison string means "install any version greater than or equal to 3.0.0 but less than 3.6.0.". It also states intent that if any upgrades are available within the version range after initial installation, those upgrades should be automatically performed. # Pinned Versions To specify an exact version to install you can use a version range that "pins" to a specific version. When pinning to a specific version, no automatic updates will occur. An example of a pinned version range is "0.6.0", which means "only install version 0.6.0 and never upgrade from this version". # Basic Comparison Operators The basic comparison operators and their meanings are: - "=", equal (not aliased to an operator) - "!=", not equal - "<", less than - ">", greater than - ">=", greater than OR equal to - "<=", less than OR equal to # Wildcard Comparisons You can use the "x", "X", and "" characters as wildcard characters in all comparison operations. Some examples of using the wildcard characters: - "1.2.x", "1.2.X", and "1.2." is equivalent to ">=1.2.0, < 1.3.0" - ">= 1.2.x", ">= 1.2.X", and ">= 1.2." is equivalent to ">= 1.2.0" - "<= 2.x", "<= 2.X", and "<= 2." is equivalent to "< 3" - "x", "X", and "*" is equivalent to ">= 0.0.0" # Patch Release Comparisons When you want to specify a minor version up to the next major version you can use the "~" character to perform patch comparisons. Some examples: - "~1.2.3" is equivalent to ">=1.2.3, <1.3.0" - "~1" and "~1.x" is equivalent to ">=1, <2" - "~2.3" is equivalent to ">=2.3, <2.4" - "~1.2.x" is equivalent to ">=1.2.0, <1.3.0" # Major Release Comparisons You can use the "^" character to make major release comparisons after a stable 1.0.0 version is published. If there is no stable version published, // minor versions define the stability level. Some examples: - "^1.2.3" is equivalent to ">=1.2.3, <2.0.0" - "^1.2.x" is equivalent to ">=1.2.0, <2.0.0" - "^2.3" is equivalent to ">=2.3, <3" - "^2.x" is equivalent to ">=2.0.0, <3" - "^0.2.3" is equivalent to ">=0.2.3, <0.3.0" - "^0.2" is equivalent to ">=0.2.0, <0.3.0" - "^0.0.3" is equvalent to ">=0.0.3, <0.0.4" - "^0.0" is equivalent to ">=0.0.0, <0.1.0" - "^0" is equivalent to ">=0.0.0, <1.0.0" # OR Comparisons You can use the "||" character to represent an OR operation in the version range. Some examples: - ">=1.2.3, <2.0.0 || >3.0.0" - "^0 || ^3 || ^5" For more information on semver, please see https://semver.org/ |
++ | MaxLength: 64 Optional: {} |
+
channels string array |
+channels is optional and specifies a set of channels belonging to the package specified in the packageName field. A channel is a package-author-defined stream of updates for an extension. Each channel in the list must follow the DNS subdomain standard as defined in [RFC 1123]. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters. You can specify no more than 256 channels. When specified, it constrains the set of installable bundles and the automated upgrade path. This constraint is an AND operation with the version field. For example: - Given channel is set to "foo" - Given version is set to ">=1.0.0, <1.5.0" - Only bundles that exist in channel "foo" AND satisfy the version range comparison are considered installable - Automatic upgrades are constrained to upgrade edges defined by the selected channel When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x - alpha - stable - stable-v1 - v1-stable - dev-preview - preview - community Some examples of invalid values are: - -some-channel - some-channel- - thisisareallylongchannelnamethatisgreaterthanthemaximumlength - original_40 - --default-channel [RFC 1123]: https://tools.ietf.org/html/rfc1123 |
++ | MaxItems: 256 items:MaxLength: 253 items:XValidation: {self.matches("^a-z0-9?(\.a-z0-9?)*$") channels entries must be valid DNS1123 subdomains Optional: {} |
+
selector LabelSelector |
+selector is optional and filters the set of ClusterCatalogs used in the bundle selection process. When unspecified, all ClusterCatalogs are used in the bundle selection process. |
++ | Optional: {} |
+
upgradeConstraintPolicy UpgradeConstraintPolicy |
+upgradeConstraintPolicy is optional and controls whether the upgrade paths defined in the catalog are enforced for the package referenced in the packageName field. Allowed values are "CatalogProvided", "SelfCertified", or omitted. When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package author are met. When set to "SelfCertified", the upgrade constraints specified by the package author are ignored. This allows upgrades and downgrades to any version of the package. This is considered a dangerous operation as it can lead to unknown and potentially disastrous outcomes, such as data loss. Use this option only if you have independently verified the changes. When omitted, the default value is "CatalogProvided". |
+CatalogProvided | +Enum: [CatalogProvided SelfCertified] Optional: {} |
+
CatalogSource is a discriminated union of possible sources for a Catalog. +CatalogSource contains the sourcing information for a Catalog
+Appears in: +- ClusterCatalogSpec
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
type SourceType |
+type is a required field that specifies the type of source for the catalog. The only allowed value is "Image". When set to "Image", the ClusterCatalog content is sourced from an OCI image. When using an image source, the image field must be set and must be the only field defined for this type. |
++ | Enum: [Image] Required: {} |
+
image ImageSource |
+image configures how catalog contents are sourced from an OCI image. It is required when type is Image, and forbidden otherwise. |
++ | Optional: {} |
+
ClusterCatalog makes File-Based Catalog (FBC) data available to your cluster. +For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
+Appears in: +- ClusterCatalogList
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
apiVersion string |
+olm.operatorframework.io/v1 |
++ | + |
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 |
++ | Optional: {} |
+
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 |
++ | Optional: {} |
+
metadata ObjectMeta |
+Refer to Kubernetes API documentation for fields of metadata. |
++ | + |
spec ClusterCatalogSpec |
+spec is a required field that defines the desired state of the ClusterCatalog. The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. |
++ | Required: {} |
+
status ClusterCatalogStatus |
+status contains the following information about the state of the ClusterCatalog: - Whether the catalog contents are being served via the catalog content HTTP server - Whether the ClusterCatalog is progressing to a new state - A reference to the source from which the catalog contents were retrieved |
++ | Optional: {} |
+
ClusterCatalogList contains a list of ClusterCatalog
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
apiVersion string |
+olm.operatorframework.io/v1 |
++ | + |
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 |
++ | Optional: {} |
+
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 |
++ | Optional: {} |
+
metadata ListMeta |
+Refer to Kubernetes API documentation for fields of metadata. |
++ | + |
items ClusterCatalog array |
+items is a list of ClusterCatalogs. items is required. |
++ | Required: {} |
+
ClusterCatalogSpec defines the desired state of ClusterCatalog
+Appears in: +- ClusterCatalog
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
source CatalogSource |
+source is a required field that defines the source of a catalog. A catalog contains information on content that can be installed on a cluster. The catalog source makes catalog contents discoverable and usable by other on-cluster components. These components can present the content in a GUI dashboard or install content from the catalog on the cluster. The catalog source must contain catalog metadata in the File-Based Catalog (FBC) format. For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: source: type: Image image: ref: quay.io/operatorhubio/catalog:latest |
++ | Required: {} |
+
priority integer |
+priority is an optional field that defines a priority for this ClusterCatalog. Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. Higher numbers mean higher priority. Clients decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. Clients should prompt users for additional input to break the tie. When omitted, the default priority is 0. Use negative numbers to specify a priority lower than the default. Use positive numbers to specify a priority higher than the default. The lowest possible value is -2147483648. The highest possible value is 2147483647. |
+0 | +Maximum: 2.147483647e+09 Minimum: -2.147483648e+09 Optional: {} |
+
availabilityMode AvailabilityMode |
+availabilityMode is an optional field that defines how the ClusterCatalog is made available to clients on the cluster. Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". When set to "Available", the catalog contents are unpacked and served over the catalog content HTTP server. Clients should consider this ClusterCatalog and its contents as usable. When set to "Unavailable", the catalog contents are no longer served over the catalog content HTTP server. Treat this the same as if the ClusterCatalog does not exist. Use "Unavailable" when you want to keep the ClusterCatalog but treat it as if it doesn't exist. |
+Available | +Enum: [Unavailable Available] Optional: {} |
+
ClusterCatalogStatus defines the observed state of ClusterCatalog
+Appears in: +- ClusterCatalog
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
conditions Condition array |
+conditions represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. The Serving condition represents whether the catalog contents are being served via the HTTP(S) web server: - When status is True and reason is Available, the catalog contents are being served. - When status is False and reason is Unavailable, the catalog contents are not being served because the contents are not yet available. - When status is False and reason is UserSpecifiedUnavailable, the catalog contents are not being served because the catalog has been intentionally marked as unavailable. The Progressing condition represents whether the ClusterCatalog is progressing or is ready to progress towards a new state: - When status is True and reason is Retrying, an error occurred that may be resolved on subsequent reconciliation attempts. - When status is True and reason is Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When status is False and reason is Blocked, an error occurred that requires manual intervention for recovery. If the system initially fetched contents and polling identifies updates, both conditions can be active simultaneously: - The Serving condition remains True with reason Available because the previous contents are still served via the HTTP(S) web server. - The Progressing condition is True with reason Retrying because the system is working to serve the new version. |
++ | Optional: {} |
+
resolvedSource ResolvedCatalogSource |
+resolvedSource contains information about the resolved source based on the source type. | ++ | Optional: {} |
+
urls ClusterCatalogURLs |
+urls contains the URLs that can be used to access the catalog. | ++ | Optional: {} |
+
lastUnpacked Time |
+lastUnpacked represents the last time the catalog contents were extracted from their source format. For example, when using an Image source, the OCI image is pulled and image layers are written to a file-system backed cache. This extraction from the source format is called "unpacking". |
++ | Optional: {} |
+
ClusterCatalogURLs contains the URLs that can be used to access the catalog.
+Appears in: +- ClusterCatalogStatus
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
base string |
+base is a cluster-internal URL that provides endpoints for accessing the catalog content. Clients should append the path for the endpoint they want to access. Currently, only a single endpoint is served and is accessible at the path /api/v1. The endpoints served for the v1 API are: - /all - this endpoint returns the entire catalog contents in the FBC format New endpoints may be added as needs evolve. |
++ | MaxLength: 525 Required: {} |
+
ClusterExtension is the Schema for the clusterextensions API
+Appears in: +- ClusterExtensionList
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
apiVersion string |
+olm.operatorframework.io/v1 |
++ | + |
kind string |
+ClusterExtension |
++ | + |
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 |
++ | Optional: {} |
+
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 |
++ | Optional: {} |
+
metadata ObjectMeta |
+Refer to Kubernetes API documentation for fields of metadata. |
++ | Optional: {} |
+
spec ClusterExtensionSpec |
+spec is an optional field that defines the desired state of the ClusterExtension. |
++ | Optional: {} |
+
status ClusterExtensionStatus |
+status is an optional field that defines the observed state of the ClusterExtension. | ++ | Optional: {} |
+
ClusterExtensionConfig is a discriminated union which selects the source configuration values to be merged into +the ClusterExtension's rendered manifests.
+Appears in: +- ClusterExtensionSpec
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
configType ClusterExtensionConfigType |
+configType is required and specifies the type of configuration source. The only allowed value is "Inline". When set to "Inline", the cluster extension configuration is defined inline within the ClusterExtension resource. |
++ | Enum: [Inline] Required: {} |
+
inline JSON |
+inline contains JSON or YAML values specified directly in the ClusterExtension. It is used to specify arbitrary configuration values for the ClusterExtension. It must be set if configType is 'Inline' and must be a valid JSON/YAML object containing at least one property. The configuration values are validated at runtime against a JSON schema provided by the bundle. |
++ | MinProperties: 1 Type: object Optional: {} |
+
Underlying type: string
+Appears in: +- ClusterExtensionConfig
+| Field | +Description | +
|---|---|
Inline |
++ |
ClusterExtensionInstallConfig is a union which selects the clusterExtension installation config.
+Appears in: +- ClusterExtensionSpec
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
preflight PreflightConfig |
+preflight is optional and configures the checks that run before installation or upgrade of the content for the package specified in the packageName field. When specified, it replaces the default preflight configuration for install/upgrade actions. When not specified, the default configuration is used. |
++ | Optional: {} |
+
ClusterExtensionInstallStatus is a representation of the status of the identified bundle.
+Appears in: +- ClusterExtensionStatus
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
bundle BundleMetadata |
+bundle is required and represents the identifying attributes of a bundle. A "bundle" is a versioned set of content that represents the resources that need to be applied to a cluster to install a package. |
++ | Required: {} |
+
ClusterExtensionList contains a list of ClusterExtension
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
apiVersion string |
+olm.operatorframework.io/v1 |
++ | + |
kind string |
+ClusterExtensionList |
++ | + |
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 |
++ | Optional: {} |
+
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 |
++ | Optional: {} |
+
metadata ListMeta |
+Refer to Kubernetes API documentation for fields of metadata. |
++ | Optional: {} |
+
items ClusterExtension array |
+items is a required list of ClusterExtension objects. | ++ | Required: {} |
+
ClusterExtensionSpec defines the desired state of ClusterExtension
+Appears in: +- ClusterExtension
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
namespace string |
+namespace specifies a Kubernetes namespace. Standard channel: It designates the default namespace where namespace-scoped resources for the extension are applied to the cluster. Some extensions may contain namespace-scoped resources to be applied in other namespaces. This namespace must exist. The namespace field is required, immutable, and follows the DNS label standard as defined in [RFC 1123]. It must contain only lowercase alphanumeric characters or hyphens (-), start and end with an alphanumeric character, and be no longer than 63 characters. [RFC 1123]: https://tools.ietf.org/html/rfc1123 Experimental channel: It designates the default namespace where namespace-scoped resources for the extension are applied to. namespace is optional. When set, it must reference an existing namespace on the cluster. When omitted, operator-controller resolves and creates a managed namespace from the bundle's metadata. Whether namespace is set or omitted is fixed at creation time and cannot be changed afterwards. The namespace field follows the DNS label standard as defined in [RFC 1123]. It must contain only lowercase alphanumeric characters or hyphens (-), start and end with an alphanumeric character, and be no longer than 63 characters. [RFC 1123]: https://tools.ietf.org/html/rfc1123 |
++ | MaxLength: 63 Required: {} |
+
serviceAccount ServiceAccountReference |
+serviceAccount is a deprecated field and is completely ignored. OLMv1 is a single-tenant system where users with ClusterExtension write access are effectively delegated cluster-admin trust. The operator-controller runs with cluster-admin privileges and uses its own service account for all cluster interactions. Deprecated: serviceAccount is no longer used and will be removed in a future release. |
++ | MinProperties: 1 Optional: {} |
+
source SourceConfig |
+source is required and selects the installation source of content for this ClusterExtension. Set the sourceType field to perform the selection. Catalog is currently the only implemented sourceType. Setting sourceType to "Catalog" requires the catalog field to also be defined. Below is a minimal example of a source definition (in yaml): source: sourceType: Catalog catalog: packageName: example-package |
++ | Required: {} |
+
install ClusterExtensionInstallConfig |
+install is optional and configures installation options for the ClusterExtension, such as the pre-flight check configuration. |
++ | Optional: {} |
+
config ClusterExtensionConfig |
+config is optional and specifies bundle-specific configuration. Configuration is bundle-specific and a bundle may provide a configuration schema. When not specified, the default configuration of the resolved bundle is used. config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide a configuration schema the bundle is deemed to not be configurable. More information on how to configure bundles can be found in the OLM documentation associated with your current OLM version. Experimental channel: |
++ | Optional: {} |
+
progressDeadlineMinutes integer |
+progressDeadlineMinutes is an optional field that defines the maximum period of time in minutes after which an installation should be considered failed and require manual intervention. This functionality is disabled when no value is provided. The minimum period is 10 minutes, and the maximum is 720 minutes (12 hours). Experimental channel: |
++ | Maximum: 720 Minimum: 10 Optional: {} |
+
ClusterExtensionStatus defines the observed state of a ClusterExtension.
+Appears in: +- ClusterExtension
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
conditions Condition array |
+conditions represents the current state of the ClusterExtension. The set of condition types which apply to all spec.source variations are Installed and Progressing. The Installed condition represents whether the bundle has been installed for this ClusterExtension: - When Installed is True and the Reason is Succeeded, the bundle has been successfully installed. - When Installed is False and the Reason is Failed, the bundle has failed to install. The Progressing condition represents whether or not the ClusterExtension is advancing towards a new state. When Progressing is True and the Reason is Succeeded, the ClusterExtension is making progress towards a new state. When Progressing is True and the Reason is Retrying, the ClusterExtension has encountered an error that could be resolved on subsequent reconciliation attempts. When Progressing is False and the Reason is Blocked, the ClusterExtension has encountered an error that requires manual intervention for recovery. Experimental channel: When Progressing is True and Reason is RollingOut, the ClusterExtension has one or more ClusterObjectSets in active roll out. When the ClusterExtension is sourced from a catalog, it surfaces deprecation conditions based on catalog metadata. These are indications from a package owner to guide users away from a particular package, channel, or bundle: - BundleDeprecated is True if the installed bundle is marked deprecated, False if not deprecated, or Unknown if no bundle is installed yet or if catalog data is unavailable. - ChannelDeprecated is True if any requested channel is marked deprecated, False if not deprecated, or Unknown if catalog data is unavailable. - PackageDeprecated is True if the requested package is marked deprecated, False if not deprecated, or Unknown if catalog data is unavailable. - Deprecated is a rollup condition that is True when any deprecation exists, False when none exist, or Unknown when catalog data is unavailable. |
++ | Optional: {} |
+
install ClusterExtensionInstallStatus |
+install is a representation of the current installation status for this ClusterExtension. | ++ | Optional: {} |
+
activeRevisions RevisionStatus array |
+activeRevisions holds a list of currently active (non-archived) ClusterObjectSets, including both installed and rolling out revisions. Experimental channel: |
++ | Optional: {} |
+
ConditionEqualProbe defines the condition type and status required for the probe to succeed.
+Appears in: +- Assertion
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
type string |
+type sets the expected condition type, i.e. "Ready". Experimental channel: |
++ | MaxLength: 200 MinLength: 1 Required: {} |
+
status string |
+status sets the expected condition status. Allowed values are "True" and "False". Experimental channel: |
++ | Enum: [True False] Required: {} |
+
FieldValueProbe defines the path and value expected within for the probe to succeed.
+Appears in: +- Assertion
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
fieldPath string |
+fieldPath sets the field path for the field to check, i.e. "status.phase". The probe will fail if the path does not exist. Experimental channel: |
++ | MaxLength: 200 MinLength: 1 Required: {} |
+
value string |
+value sets the expected value found at fieldPath, i.e. "Bound". Experimental channel: |
++ | MaxLength: 200 MinLength: 1 Required: {} |
+
FieldsEqualProbe defines the paths of the two fields required to match for the probe to succeed.
+Appears in: +- Assertion
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
fieldA string |
+fieldA sets the field path for the first field, i.e. "spec.replicas". The probe will fail if the path does not exist. Experimental channel: |
++ | MaxLength: 200 MinLength: 1 Required: {} |
+
fieldB string |
+fieldB sets the field path for the second field, i.e. "status.readyReplicas". The probe will fail if the path does not exist. Experimental channel: |
++ | MaxLength: 200 MinLength: 1 Required: {} |
+
ImageSource enables users to define the information required for sourcing a Catalog from an OCI image
+If we see that there is a possibly valid digest-based image reference AND pollIntervalMinutes is specified, +reject the resource since there is no use in polling a digest-based image reference.
+Appears in: +- CatalogSource
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
ref string |
+ref is a required field that defines the reference to a container image containing catalog contents. It cannot be more than 1000 characters. A reference has 3 parts: the domain, name, and identifier. The domain is typically the registry where an image is located. It must be alphanumeric characters (lowercase and uppercase) separated by the "." character. Hyphenation is allowed, but the domain must start and end with alphanumeric characters. Specifying a port to use is also allowed by adding the ":" character followed by numeric values. The port must be the last value in the domain. Some examples of valid domain values are "registry.mydomain.io", "quay.io", "my-registry.io:8080". The name is typically the repository in the registry where an image is located. It must contain lowercase alphanumeric characters separated only by the ".", "", "__", "-" characters. Multiple names can be concatenated with the "/" character. The domain and name are combined using the "/" character. Some examples of valid name values are "operatorhubio/catalog", "catalog", "my-catalog.prod". An example of the domain and name parts of a reference being combined is "quay.io/operatorhubio/catalog". The identifier is typically the tag or digest for an image reference and is present at the end of the reference. It starts with a separator character used to distinguish the end of the name and beginning of the identifier. For a digest-based reference, the "@" character is the separator. For a tag-based reference, the ":" character is the separator. An identifier is required in the reference. Digest-based references must contain an algorithm reference immediately after the "@" separator. The algorithm reference must be followed by the ":" character and an encoded string. The algorithm must start with an uppercase or lowercase alpha character followed by alphanumeric characters and may contain the "-", "", "+", and "." characters. Some examples of valid algorithm values are "sha256", "sha256+b64u", "multihash+base58". The encoded string following the algorithm must be hex digits (a-f, A-F, 0-9) and must be a minimum of 32 characters. Tag-based references must begin with a word character (alphanumeric + "_") followed by word characters or ".", and "-" characters. The tag must not be longer than 127 characters. An example of a valid digest-based image reference is "quay.io/operatorhubio/catalog@sha256:200d4ddb2a73594b91358fe6397424e975205bfbe44614f5846033cad64b3f05" An example of a valid tag-based image reference is "quay.io/operatorhubio/catalog:latest" |
++ | MaxLength: 1000 Required: {} |
+
pollIntervalMinutes integer |
+pollIntervalMinutes is an optional field that sets the interval, in minutes, at which the image source is polled for new content. You cannot specify pollIntervalMinutes when ref is a digest-based reference. When omitted, the image is not polled for new content. |
++ | Minimum: 1 Optional: {} |
+
ObjectSelector is a discriminated union which defines the method by which we select objects to make assertions against.
+Appears in: +- ProgressionProbe
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
type SelectorType |
+type is a required field which specifies the type of selector to use. The allowed selector types are "GroupKind" and "Label". When set to "GroupKind", all objects which match the specified group and kind will be selected. When set to "Label", all objects which match the specified labels and/or expressions will be selected. Experimental channel: |
++ | Enum: [GroupKind Label] Required: {} |
+
groupKind GroupKind |
+groupKind specifies the group and kind of objects to select. Required when type is "GroupKind". Uses the Kubernetes format specified here: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupKind Experimental channel: |
++ | Optional: {} |
+
label LabelSelector |
+label is the label selector definition. Required when type is "Label". A probe using a Label selector will be executed against every object matching the labels or expressions; you must use care when using this type of selector. For example, if multiple Kind objects are selected via labels then the probe is likely to fail because the values of different Kind objects rarely share the same schema. The LabelSelector field uses the following Kubernetes format: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#LabelSelector Requires exactly one of matchLabels or matchExpressions. Experimental channel: |
++ | Optional: {} |
+
PreflightConfig holds the configuration for the preflight checks. If used, at least one preflight check must be non-nil.
+Appears in: +- ClusterExtensionInstallConfig
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
crdUpgradeSafety CRDUpgradeSafetyPreflightConfig |
+crdUpgradeSafety configures the CRD Upgrade Safety pre-flight checks that run before upgrades of installed content. The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, such as data loss. |
++ | + |
Underlying type: string
+ProbeType defines the type of probe used as an assertion.
+Appears in: +- Assertion
+| Field | +Description | +
|---|---|
ConditionEqual |
++ |
FieldsEqual |
++ |
FieldValue |
++ |
ResolvedCatalogSource is a discriminated union of resolution information for a Catalog. +ResolvedCatalogSource contains the information about a sourced Catalog
+Appears in: +- ClusterCatalogStatus
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
type SourceType |
+type is a required field that specifies the type of source for the catalog. The only allowed value is "Image". When set to "Image", information about the resolved image source is set in the image field. |
++ | Enum: [Image] Required: {} |
+
image ResolvedImageSource |
+image contains resolution information for a catalog sourced from an image. It must be set when type is Image, and forbidden otherwise. |
++ | + |
ResolvedImageSource provides information about the resolved source of a Catalog sourced from an image.
+Appears in: +- ResolvedCatalogSource
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
ref string |
+ref contains the resolved image digest-based reference. The digest format allows you to use other tooling to fetch the exact OCI manifests that were used to extract the catalog contents. |
++ | MaxLength: 1000 Required: {} |
+
RevisionStatus defines the observed state of a ClusterObjectSet.
+Appears in: +- ClusterExtensionStatus
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
name string |
+name of the ClusterObjectSet resource | ++ | + |
conditions Condition array |
+conditions optionally expose the Available condition of the revision, in case when it is not yet marked as successfully installed (completedAt is not set). Given that a ClusterExtension should remain available during upgrades, an observer may use these conditions to get more insights about reasons for its current state. |
++ | Optional: {} |
+
Underlying type: string
+SelectorType defines the type of selector used for progressionProbes.
+Appears in: +- ObjectSelector
+| Field | +Description | +
|---|---|
GroupKind |
++ |
Label |
++ |
ServiceAccountReference is a deprecated type and is completely ignored.
+Deprecated: ServiceAccountReference is no longer used and will be removed in a future release.
+Validation: +- MinProperties: 1
+Appears in: +- ClusterExtensionSpec
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
name string |
+name is a deprecated field and is completely ignored. Deprecated: name is no longer used and will be removed in a future release. The name field follows the DNS subdomain standard as defined in [RFC 1123]. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters. Some examples of valid values are: - some-serviceaccount - 123-serviceaccount - 1-serviceaccount-2 - someserviceaccount - some.serviceaccount Some examples of invalid values are: - -some-serviceaccount - some-serviceaccount- [RFC 1123]: https://tools.ietf.org/html/rfc1123 |
++ | MaxLength: 253 MinLength: 1 Optional: {} |
+
SourceConfig is a discriminated union which selects the installation source.
+Appears in: +- ClusterExtensionSpec
+| Field | +Description | +Default | +Validation | +
|---|---|---|---|
sourceType string |
+sourceType is required and specifies the type of install source. The only allowed value is "Catalog". When set to "Catalog", information for determining the appropriate bundle of content to install is fetched from ClusterCatalog resources on the cluster. When using the Catalog sourceType, the catalog field must also be set. |
++ | Enum: [Catalog] Required: {} |
+
catalog CatalogFilter |
+catalog configures how information is sourced from a catalog. It is required when sourceType is "Catalog", and forbidden otherwise. |
++ | Optional: {} |
+
Underlying type: string
+SourceType defines the type of source used for catalogs.
+Appears in: +- CatalogSource +- ResolvedCatalogSource
+| Field | +Description | +
|---|---|
Image |
++ |
Underlying type: string
+Appears in: +- CatalogFilter
+| Field | +Description | +
|---|---|
CatalogProvided |
+The extension will only upgrade if the new version satisfies the upgrade constraints set by the package author. |
+
SelfCertified |
+Unsafe option which allows an extension to be upgraded or downgraded to any available version of the package and ignore the upgrade path designed by package authors. This assumes that users independently verify the outcome of the changes. Use with caution as this can lead to unknown and potentially disastrous results such as data loss. |
+