mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
46 lines
1.7 KiB
Plaintext
46 lines
1.7 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * extensions/ce/olmv1-configuring-extensions.adoc
|
|
|
|
:_mod-docs-content-type: CONCEPT
|
|
[id="olmv1-config-api_{context}"]
|
|
= Extension configuration
|
|
|
|
[role="_abstract"]
|
|
Configure the namespace an extension watches by using the `.spec.config` field in the `ClusterExtension` resource.
|
|
|
|
:FeatureName: {olmv1} configuration API
|
|
include::snippets/technology-preview.adoc[]
|
|
|
|
Extensions watch all namespaces by default. Some Operators support only namespace-scoped watching based on {olmv0} install modes. Configure the `.spec.config.inline.watchNamespace` field to install these Operators.
|
|
|
|
Whether you must configure this field depends on the install modes supported by the bundle.
|
|
|
|
[id="olmv1-config-api-structure_{context}"]
|
|
== Configuration API structure
|
|
|
|
The configuration API uses an opaque structure. The bundle validates the configuration values, not {olmv1}. Operator authors can define their own configuration requirements.
|
|
|
|
Currently, the `Inline` configuration type is the only supported type:
|
|
|
|
.Example inline configuration
|
|
[source,yaml]
|
|
----
|
|
apiVersion: olm.operatorframework.io/v1
|
|
kind: ClusterExtension
|
|
metadata:
|
|
name: <extension_name>
|
|
...
|
|
spec:
|
|
namespace: <installation_namespace>
|
|
config:
|
|
configType: Inline
|
|
inline:
|
|
watchNamespace: <watch_namespace>
|
|
----
|
|
where:
|
|
|
|
`<installation_namespace>`:: Specifies the namespace where the extension components run.
|
|
`config.configType`:: Specifies the configuration type. Currently, `Inline` is the only supported type.
|
|
`<watch_namespace>`:: Specifies the namespace where the extension watches for custom resources. The watch namespace can match or differ from the installation namespace, depending on the install modes supported by the bundle.
|