Skip to content

Commit 211786d

Browse files
author
Per Goncalves da Silva
committed
Update docs
Signed-off-by: Per Goncalves da Silva <[email protected]>
1 parent ac0290c commit 211786d

File tree

2 files changed

+45
-6
lines changed

2 files changed

+45
-6
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.<br /><br />inline must be set if configType is 'Inline'. | | Type: object <br /> |
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 optional configuration values applied during rendering of the<br />ClusterExtension's manifests. Values can be specified inline.<br /><br />config is optional. When not specified, the default configuration of the resolved bundle will be used.<br /><br /><opcon:experimental> | | |
312347

313348

314349
#### ClusterExtensionStatus

docs/draft/howto/single-ownnamespace-install.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ kubectl rollout status -n olmv1-system deployment/operator-controller-controller
5656
## Configuring the `ClusterExtension`
5757

5858
A `ClusterExtension` can be configured to install bundle in `Single-` or `OwnNamespace` mode through the
59-
`olm.operatorframework.io/watch-namespace: <namespace>` annotation. The *installMode* is inferred in the following way:
59+
`.spec.config.inline.watchNamespace` property. The *installMode* is inferred in the following way:
6060

61-
- *AllNamespaces*: `<namespace>` is empty, or the annotation is not present
62-
- *OwnNamespace*: `<namespace>` is the install namespace (i.e. `.spec.namespace`)
63-
- *SingleNamespace*: `<namespace>` not the install namespace
61+
- *AllNamespaces*: `watchNamespace` is empty, or not set
62+
- *OwnNamespace*: `watchNamespace` is the install namespace (i.e. `.spec.namespace`)
63+
- *SingleNamespace*: `watchNamespace` *not* the install namespace
6464

6565
### Examples
6666

@@ -70,12 +70,13 @@ apiVersion: olm.operatorframework.io/v1
7070
kind: ClusterExtension
7171
metadata:
7272
name: argocd
73-
annotations:
74-
olm.operatorframework.io/watch-namespace: argocd-watch
7573
spec:
7674
namespace: argocd
7775
serviceAccount:
7876
name: argocd-installer
77+
config:
78+
inline:
79+
watchNamespace: argocd-watch
7980
source:
8081
sourceType: Catalog
8182
catalog:
@@ -96,6 +97,9 @@ spec:
9697
namespace: argocd
9798
serviceAccount:
9899
name: argocd-installer
100+
config:
101+
inline:
102+
watchNamespace: argocd
99103
source:
100104
sourceType: Catalog
101105
catalog:

0 commit comments

Comments
 (0)