Skip to content

Commit fbbfb8f

Browse files
authored
docs: improve javadocs for namespace properties (#614)
1 parent cd74bc9 commit fbbfb8f

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/RunTimeControllerConfiguration.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ public class RunTimeControllerConfiguration {
1212
/**
1313
* An optional list of comma-separated namespace names the controller should watch. If this
1414
* property is left empty then the controller will watch all namespaces.
15+
* The value can be set to "JOSDK_WATCH_CURRENT" to watch the current (default) namespace from kube config.
16+
* Constant(s) can be found in at {@link io.javaoperatorsdk.operator.api.reconciler.Constants}".
1517
*/
1618
@ConfigItem
1719
public Optional<List<String>> namespaces;

core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/RunTimeOperatorConfiguration.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ public class RunTimeOperatorConfiguration {
4747
/**
4848
* An optional list of comma-separated namespace names all controllers will watch if not specified. If this
4949
* property is left empty then controllers will watch all namespaces by default. Sets the default value for all controllers.
50+
* The value can be set to "JOSDK_WATCH_CURRENT" to watch the current (default) namespace from kube config.
51+
* Constant(s) can be found in at {@link io.javaoperatorsdk.operator.api.reconciler.Constants}".
5052
*/
5153
@ConfigItem
5254
public Optional<List<String>> namespaces;

docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ a| [[quarkus-operator-sdk_quarkus.operator-sdk.namespaces]]`link:#quarkus-operat
274274

275275
[.description]
276276
--
277-
An optional list of comma-separated namespace names all controllers will watch if not specified. If this property is left empty then controllers will watch all namespaces by default. Sets the default value for all controllers.
277+
An optional list of comma-separated namespace names all controllers will watch if not specified. If this property is left empty then controllers will watch all namespaces by default. Sets the default value for all controllers. The value can be set to "JOSDK_WATCH_CURRENT" to watch the current (default) namespace from kube config. Constant(s) can be found in at `io.javaoperatorsdk.operator.api.reconciler.Constants`".
278278

279279
ifdef::add-copy-button-to-env-var[]
280280
Environment variable: env_var_with_copy_button:+++QUARKUS_OPERATOR_SDK_NAMESPACES+++[]
@@ -355,7 +355,7 @@ a| [[quarkus-operator-sdk_quarkus.operator-sdk.controllers.-controllers-.namespa
355355

356356
[.description]
357357
--
358-
An optional list of comma-separated namespace names the controller should watch. If this property is left empty then the controller will watch all namespaces.
358+
An optional list of comma-separated namespace names the controller should watch. If this property is left empty then the controller will watch all namespaces. The value can be set to "JOSDK_WATCH_CURRENT" to watch the current (default) namespace from kube config. Constant(s) can be found in at `io.javaoperatorsdk.operator.api.reconciler.Constants`".
359359

360360
ifdef::add-copy-button-to-env-var[]
361361
Environment variable: env_var_with_copy_button:+++QUARKUS_OPERATOR_SDK_CONTROLLERS__CONTROLLERS__NAMESPACES+++[]

0 commit comments

Comments
 (0)