Skip to content

Commit 39718ba

Browse files
perdasilvaPer Goncalves da Silva
andauthored
Update .spec.config api doc to direct users to docs (#2383)
Signed-off-by: Per Goncalves da Silva <[email protected]> Co-authored-by: Per Goncalves da Silva <[email protected]>
1 parent d66afb6 commit 39718ba

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

api/v1/clusterextension_types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ type ClusterExtensionSpec struct {
103103
// a configuration schema. When not specified, the default configuration of the resolved bundle will be used.
104104
//
105105
// config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
106-
// a configuration schema the final manifests will be derived on a best-effort basis. More information on how
107-
// to configure the bundle should be found in its end-user documentation.
106+
// a configuration schema the bundle is deemed to not be configurable. More information on how
107+
// to configure bundles can be found in the OLM documentation associated with your current OLM version.
108108
//
109109
// <opcon:experimental>
110110
// +optional

docs/api-reference/olmv1-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ _Appears in:_
343343
| `serviceAccount` _[ServiceAccountReference](#serviceaccountreference)_ | serviceAccount is a reference to a ServiceAccount used to perform all interactions<br />with the cluster that are required to manage the extension.<br />The ServiceAccount must be configured with the necessary permissions to perform these interactions.<br />The ServiceAccount must exist in the namespace referenced in the spec.<br />serviceAccount is required. | | Required: \{\} <br /> |
344344
| `source` _[SourceConfig](#sourceconfig)_ | source is a required field which selects the installation source of content<br />for this ClusterExtension. Selection is performed by setting the sourceType.<br />Catalog is currently the only implemented sourceType, and setting the<br />sourcetype to "Catalog" requires the catalog field to also be defined.<br />Below is a minimal example of a source definition (in yaml):<br />source:<br /> sourceType: Catalog<br /> catalog:<br /> packageName: example-package | | Required: \{\} <br /> |
345345
| `install` _[ClusterExtensionInstallConfig](#clusterextensioninstallconfig)_ | install is an optional field used to configure the installation options<br />for the ClusterExtension such as the pre-flight check configuration. | | |
346-
| `config` _[ClusterExtensionConfig](#clusterextensionconfig)_ | config is an optional field used to specify bundle specific configuration<br />used to configure the bundle. Configuration is bundle specific and a bundle may provide<br />a configuration schema. When not specified, the default configuration of the resolved bundle will be used.<br />config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide<br />a configuration schema the final manifests will be derived on a best-effort basis. More information on how<br />to configure the bundle should be found in its end-user documentation.<br /><opcon:experimental> | | |
346+
| `config` _[ClusterExtensionConfig](#clusterextensionconfig)_ | config is an optional field used to specify bundle specific configuration<br />used to configure the bundle. Configuration is bundle specific and a bundle may provide<br />a configuration schema. When not specified, the default configuration of the resolved bundle will be used.<br />config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide<br />a configuration schema the bundle is deemed to not be configurable. More information on how<br />to configure bundles can be found in the OLM documentation associated with your current OLM version.<br /><opcon:experimental> | | |
347347

348348

349349
#### ClusterExtensionStatus

helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ spec:
6464
a configuration schema. When not specified, the default configuration of the resolved bundle will be used.
6565
6666
config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
67-
a configuration schema the final manifests will be derived on a best-effort basis. More information on how
68-
to configure the bundle should be found in its end-user documentation.
67+
a configuration schema the bundle is deemed to not be configurable. More information on how
68+
to configure bundles can be found in the OLM documentation associated with your current OLM version.
6969
properties:
7070
configType:
7171
description: |-

manifests/experimental-e2e.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -964,8 +964,8 @@ spec:
964964
a configuration schema. When not specified, the default configuration of the resolved bundle will be used.
965965
966966
config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
967-
a configuration schema the final manifests will be derived on a best-effort basis. More information on how
968-
to configure the bundle should be found in its end-user documentation.
967+
a configuration schema the bundle is deemed to not be configurable. More information on how
968+
to configure bundles can be found in the OLM documentation associated with your current OLM version.
969969
properties:
970970
configType:
971971
description: |-

manifests/experimental.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -929,8 +929,8 @@ spec:
929929
a configuration schema. When not specified, the default configuration of the resolved bundle will be used.
930930
931931
config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
932-
a configuration schema the final manifests will be derived on a best-effort basis. More information on how
933-
to configure the bundle should be found in its end-user documentation.
932+
a configuration schema the bundle is deemed to not be configurable. More information on how
933+
to configure bundles can be found in the OLM documentation associated with your current OLM version.
934934
properties:
935935
configType:
936936
description: |-

0 commit comments

Comments
 (0)