Skip to content

Commit e3f69dd

Browse files
author
Per Goncalves da Silva
committed
Update api reference
Signed-off-by: Per Goncalves da Silva <[email protected]>
1 parent cd6bdb9 commit e3f69dd

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,40 @@ _Appears in:_
239239
| `status` _[ClusterExtensionStatus](#clusterextensionstatus)_ | status is an optional field that defines the observed state of the ClusterExtension. | | |
240240

241241

242+
#### ClusterExtensionConfig
243+
244+
245+
246+
ClusterExtensionConfig is a discriminated union which selects the source configuration values to be merged into
247+
the ClusterExtension's rendered manifests.
248+
249+
250+
251+
_Appears in:_
252+
- [ClusterExtensionSpec](#clusterextensionspec)
253+
254+
| Field | Description | Default | Validation |
255+
| --- | --- | --- | --- |
256+
| `configType` _[ClusterExtensionConfigType](#clusterextensionconfigtype)_ | configType is a required reference to the type of configuration source.<br /><br />Allowed values are "Inline"<br /><br />When this field is set to "Inline", the cluster extension configuration is defined inline within the<br />ClusterExtension resource. | | Enum: [Inline] <br />Required: \{\} <br /> |
257+
| `inline` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#json-v1-apiextensions-k8s-io)_ | inline contains JSON or YAML values specified directly in the<br />ClusterExtension. | | |
258+
259+
260+
#### ClusterExtensionConfigType
261+
262+
_Underlying type:_ _string_
263+
264+
265+
266+
267+
268+
_Appears in:_
269+
- [ClusterExtensionConfig](#clusterextensionconfig)
270+
271+
| Field | Description |
272+
| --- | --- |
273+
| `Inline` | |
274+
275+
242276
#### ClusterExtensionInstallConfig
243277

244278

@@ -309,6 +343,7 @@ _Appears in:_
309343
| `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 /> |
310344
| `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 /><br />Catalog is currently the only implemented sourceType, and setting the<br />sourcetype to "Catalog" requires the catalog field to also be defined.<br /><br />Below is a minimal example of a source definition (in yaml):<br /><br />source:<br /> sourceType: Catalog<br /> catalog:<br /> packageName: example-package | | Required: \{\} <br /> |
311345
| `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 contains configuration values applied during rendering of the<br />ClusterExtension's manifests. Values can be specified inline or sourced<br />from a referenced Secret.<br /><br /><opcon:experimental> | | |
312347

313348

314349
#### ClusterExtensionStatus

0 commit comments

Comments
 (0)