From 5a2a49e7c5dccd201f01bb6b84af6f3c97ae2bc1 Mon Sep 17 00:00:00 2001 From: Per Goncalves da Silva Date: Fri, 12 Dec 2025 10:34:07 +0100 Subject: [PATCH] Update .spec.config api doc to direct users to docs Signed-off-by: Per Goncalves da Silva --- api/v1/clusterextension_types.go | 4 ++-- docs/api-reference/olmv1-api-reference.md | 2 +- .../olm.operatorframework.io_clusterextensions.yaml | 4 ++-- manifests/experimental-e2e.yaml | 4 ++-- manifests/experimental.yaml | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/api/v1/clusterextension_types.go b/api/v1/clusterextension_types.go index 8c99cf67b..fb82b7a23 100644 --- a/api/v1/clusterextension_types.go +++ b/api/v1/clusterextension_types.go @@ -103,8 +103,8 @@ type ClusterExtensionSpec struct { // a configuration schema. When not specified, the default configuration of the resolved bundle will be used. // // config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide - // a configuration schema the final manifests will be derived on a best-effort basis. More information on how - // to configure the bundle should be found in its end-user documentation. + // 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. // // // +optional diff --git a/docs/api-reference/olmv1-api-reference.md b/docs/api-reference/olmv1-api-reference.md index 866de5327..4fc8cb3c6 100644 --- a/docs/api-reference/olmv1-api-reference.md +++ b/docs/api-reference/olmv1-api-reference.md @@ -343,7 +343,7 @@ _Appears in:_ | `serviceAccount` _[ServiceAccountReference](#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](#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: \{\}
| | `install` _[ClusterExtensionInstallConfig](#clusterextensioninstallconfig)_ | install is an optional field used to configure the installation options
for the ClusterExtension such as the pre-flight check configuration. | | | -| `config` _[ClusterExtensionConfig](#clusterextensionconfig)_ | config is an optional field used to specify bundle specific configuration
used to configure the bundle. Configuration is bundle specific and a bundle may provide
a configuration schema. When not specified, the default configuration of the resolved bundle will be used.
config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
a configuration schema the final manifests will be derived on a best-effort basis. More information on how
to configure the bundle should be found in its end-user documentation.
| | | +| `config` _[ClusterExtensionConfig](#clusterextensionconfig)_ | config is an optional field used to specify bundle specific configuration
used to configure the bundle. Configuration is bundle specific and a bundle may provide
a configuration schema. When not specified, the default configuration of the resolved bundle will be 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.
| | | #### ClusterExtensionStatus diff --git a/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml b/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml index b51817c16..0d1bbd71c 100644 --- a/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml +++ b/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml @@ -64,8 +64,8 @@ spec: a configuration schema. When not specified, the default configuration of the resolved bundle will be used. config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide - a configuration schema the final manifests will be derived on a best-effort basis. More information on how - to configure the bundle should be found in its end-user documentation. + 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. properties: configType: description: |- diff --git a/manifests/experimental-e2e.yaml b/manifests/experimental-e2e.yaml index 862edac12..1b583d207 100644 --- a/manifests/experimental-e2e.yaml +++ b/manifests/experimental-e2e.yaml @@ -964,8 +964,8 @@ spec: a configuration schema. When not specified, the default configuration of the resolved bundle will be used. config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide - a configuration schema the final manifests will be derived on a best-effort basis. More information on how - to configure the bundle should be found in its end-user documentation. + 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. properties: configType: description: |- diff --git a/manifests/experimental.yaml b/manifests/experimental.yaml index 3ea459499..7bff36748 100644 --- a/manifests/experimental.yaml +++ b/manifests/experimental.yaml @@ -929,8 +929,8 @@ spec: a configuration schema. When not specified, the default configuration of the resolved bundle will be used. config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide - a configuration schema the final manifests will be derived on a best-effort basis. More information on how - to configure the bundle should be found in its end-user documentation. + 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. properties: configType: description: |-