API Reference
Packages
olm.operatorframework.io/v1
Package v1 contains API Schema definitions for the olm v1 API group
Resource Types
BundleMetadata
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 a required field and is a reference to the version that this bundle represents version follows the semantic versioning standard as defined in https://semver.org/. |
Required: {} |
BundleSource
BundleSource defines the configuration used to retrieve a bundle directly from its OCI-based image reference.
Appears in: - SourceConfig
| Field | Description | Default | Validation |
|---|---|---|---|
ref string |
ref allows users to define the reference to a container image containing bundle contents. ref is required. ref can not be more than 1000 characters. A reference can be broken down into 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/bundle", "bundle", "my-bundle.prod". An example of the domain and name parts of a reference being combined is "quay.io/operatorhubio/bundle". 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: {} |
CRDUpgradeSafetyEnforcement
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
CRDUpgradeSafetyPreflightConfig is the configuration for CRD upgrade safety preflight check.
Appears in: - PreflightConfig
| Field | Description | Default | Validation |
|---|---|---|---|
enforcement CRDUpgradeSafetyEnforcement |
enforcement is a required field, used to configure 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 will be skipped when performing an upgrade operation. This should be used with caution as unintended consequences such as data loss can occur. When set to "Strict", the CRD Upgrade Safety pre-flight check will be run when performing an upgrade operation. |
Enum: [None Strict] Required: {} |
CatalogSource
CatalogSource defines the attributes used to identify and filter content from a catalog.
Appears in: - SourceConfig
| Field | Description | Default | Validation |
|---|---|---|---|
packageName string |
packageName is a reference to the name of the package to be installed and is used to filter the content from catalogs. packageName 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 will be 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. Additional comparison strings can be added 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 |
|
channels string array |
channels is an optional reference to 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. No more than 256 channels can be specified. When specified, it is used to constrain 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 will be considered installable - Automatic upgrades will be constrained to upgrade edges defined by the selected channel When unspecified, upgrade edges across all channels will be 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 |
|
selector LabelSelector |
selector is an optional field that can be used to filter the set of ClusterCatalogs used in the bundle selection process. When unspecified, all ClusterCatalogs will be used in the bundle selection process. |
||
upgradeConstraintPolicy UpgradeConstraintPolicy |
upgradeConstraintPolicy is an optional field that controls whether the upgrade path(s) defined in the catalog are enforced for the package referenced in the packageName field. Allowed values are: "CatalogProvided" or "SelfCertified", or omitted. When this field is set to "CatalogProvided", automatic upgrades will only occur when upgrade constraints specified by the package author are met. When this field is set to "SelfCertified", the upgrade constraints specified by the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when using this option. When this field is omitted, the default value is "CatalogProvided". |
CatalogProvided | Enum: [CatalogProvided SelfCertified] |
ClusterExtension
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 |
||
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 ClusterExtensionSpec |
spec is an optional field that defines the desired state of the ClusterExtension. | ||
status ClusterExtensionStatus |
status is an optional field that defines the observed state of the ClusterExtension. |
ClusterExtensionInstallConfig
ClusterExtensionInstallConfig is a union which selects the clusterExtension installation config. ClusterExtensionInstallConfig requires the namespace and serviceAccount which should be used for the installation of packages.
Appears in: - ClusterExtensionSpec
| Field | Description | Default | Validation |
|---|---|---|---|
preflight PreflightConfig |
preflight is an optional field that can be used to configure the checks that are 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 will be used. |
ClusterExtensionInstallStatus
ClusterExtensionInstallStatus is a representation of the status of the identified bundle.
Appears in: - ClusterExtensionStatus
| Field | Description | Default | Validation |
|---|---|---|---|
bundle BundleMetadata |
bundle is a required field which 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
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 |
||
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 ClusterExtension array |
items is a required list of ClusterExtension objects. | Required: {} |
ClusterExtensionSpec
ClusterExtensionSpec defines the desired state of ClusterExtension
Appears in: - ClusterExtension
| Field | Description | Default | Validation |
|---|---|---|---|
namespace string |
namespace is a reference to a Kubernetes namespace. This is the namespace in which the provided ServiceAccount must exist. It also 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. namespace 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 |
MaxLength: 63 Required: {} |
|
serviceAccount ServiceAccountReference |
serviceAccount is a reference to a ServiceAccount used to perform all interactions with the cluster that are required to manage the extension. The ServiceAccount must be configured with the necessary permissions to perform these interactions. The ServiceAccount must exist in the namespace referenced in the spec. serviceAccount is required. |
Required: {} |
|
source SourceConfig |
source is a required field which selects the installation source of content for this ClusterExtension. Selection is performed by setting the sourceType. Catalog is currently the only implemented sourceType, and setting the 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: {} |
|
template ClusterExtensionTemplate |
config stores any custom configuration to be used when templating content for this extension. config is optional. When not specified, the package manager will use the default configuration of the extension. |
||
install ClusterExtensionInstallConfig |
install is an optional field used to configure the installation options for the ClusterExtension such as the pre-flight check configuration. |
ClusterExtensionStatus
ClusterExtensionStatus defines the observed state of a ClusterExtension.
Appears in: - ClusterExtension
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array |
The set of condition types which apply to all spec.source variations are Installed and Progressing. The Installed condition represents whether or not 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. When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. These are indications from a package owner to guide users away from a particular package, channel, or bundle. BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. PackageDeprecated is set if the requested package is marked deprecated in the catalog. Deprecated is a rollup condition that is present when any of the deprecated conditions are present. |
||
install ClusterExtensionInstallStatus |
install is a representation of the current installation status for this ClusterExtension. |
ClusterExtensionTemplate
Appears in: - ClusterExtensionSpec
| Field | Description | Default | Validation |
|---|---|---|---|
valuesSources ValuesSource array |
valuesSources is a list of sources from which to obtain arbitrary values that provide configuration for the installation of bundles managed by the ClusterExtension. valuesSources is optional. When not specified, the package manager will use the default configuration of the resolved bundle. If multiple valuesSources are specified, the values are merged in the order they are specified. Values from later sources will override values from earlier sources. Bundles can optionally provide a schema for these values. When bundles provide a schema, it is used to validate these values before proceeding with the installation. Validation errors are reported via the ClusterExtension status. |
LocalObjectReferenceWithKey
Appears in: - ValuesSource
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
name is the name of a resource in the same namespace as the ClusterExtension. name is required. |
Required: {} |
|
key string |
key is a reference to a key in the data field of the referenced object. key is required. |
Required: {} |
PreflightConfig
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 is used to configure the CRD Upgrade Safety pre-flight checks that run prior to upgrades of installed content. The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, such as data loss. |
ServiceAccountReference
ServiceAccountReference identifies the serviceAccount used to install a ClusterExtension.
Appears in: - ClusterExtensionSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
name is a required, immutable reference to the name of the ServiceAccount to be used for installation and management of the content for the package specified in the packageName field. This ServiceAccount must exist in the installNamespace. name 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 Required: {} |
SourceConfig
SourceConfig is a discriminated union which selects the installation source.
Appears in: - ClusterExtensionSpec
| Field | Description | Default | Validation |
|---|---|---|---|
sourceType string |
sourceType is a required reference to the type of install source. Allowed values are "Bundle" or "Catalog" When this field is set to "Bundle", the bundle of content to install is specified directly. In this case, no interaction with ClusterCatalog resources is necessary. When using the Bundle sourceType, the bundle field must also be set. When this field is set to "Catalog", information for determining the appropriate bundle of content to install will be fetched from ClusterCatalog resources existing on the cluster. When using the Catalog sourceType, the catalog field must also be set. |
Enum: [Bundle Catalog] Required: {} |
|
bundle BundleSource |
bundle is used to configure how information is sourced from a bundle. This field is required when sourceType is "Bundle", and forbidden otherwise. |
||
catalog CatalogSource |
catalog is used to configure how information is sourced from a catalog. This field is required when sourceType is "Catalog", and forbidden otherwise. |
UpgradeConstraintPolicy
Underlying type: string
Appears in: - CatalogSource
| 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. |
ValuesSource
ValuesSource is a discriminated union of possible sources for values. ValuesSource contains the sourcing information for those values.
Appears in: - ClusterExtensionTemplate
| Field | Description | Default | Validation |
|---|---|---|---|
type ValuesSourceType |
type is a reference to the type of source the values are sourced from. type is required. The allowed values are "Inline", "ConfigMap", and "Secret". When set to "Inline", the values are sourced directly from the inlined content. When using an inline source, the inline field must be set and must be the only field defined for this type. When set to "ConfigMap", the values are sourced from the specified ConfigMap in the installNamespace. When using a ConfigMap source, the configMap field must be set and must be the only field defined for this type. When set to "Secret", the values are sourced from the specified Secret in the installNamespace. When using a Secret source, the secret field must be set and must be the only field defined for this type. |
Enum: [Inline ConfigMap Secret] Required: {} |
|
inline JSON |
inline is a map of arbitrary key-value pairs. Inlined values are useful for small, simple configurations that do not include sensitive information. |
Schemaless: {} Type: object |
|
configMap LocalObjectReferenceWithKey |
configMap is a reference to a key in a specific ConfigMap in the installNamespace. The referenced ConfigMap is expected to contain the specified key, whose value contains the desired configuration. ConfigMaps are useful for storing larger, more complex configurations that do not include sensitive information. The service account provided in the spec.install field must have 'get' permission in order to read the referenced ConfigMap. |
||
secret LocalObjectReferenceWithKey |
secret is a reference to a key in a specific Secret in the installNamespace. The referenced Secret is expected to contain the specified key, whose value contains the desired configuration. Secrets are useful for storing larger, more complex configurations or configurations that include sensitive information. The service account provided in the spec.install field must have 'get' permission in order to read the referenced Secret. |
ValuesSourceType
Underlying type: string
Appears in: - ValuesSource
| Field | Description |
|---|---|
Inline |
|
ConfigMap |
|
Secret |