Skip to content

Commit b72ad7f

Browse files
kumar-mallikarjunagyfora
authored andcommitted
[FLINK-37391][docs] Improve documentation for dynamic namespace watching configuration
- Add example configuration for enabling dynamic namespace watching - Clarify that dynamic.namespaces.enabled requires dynamic.config.enabled to be true
1 parent b0274cb commit b72ad7f

File tree

4 files changed

+16
-3
lines changed

4 files changed

+16
-3
lines changed

docs/content.zh/docs/operations/configuration.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,18 @@ Verify whether the config value of `kubernetes.operator.reconcile.interval` is u
8686
2022-05-28 13:08:30,115 o.a.f.k.o.c.FlinkConfigManager [INFO ] Updating default configuration to {kubernetes.operator.reconcile.interval=PT30S}
8787
```
8888

89+
### Example: Enabling Dynamic Namespace Watching
90+
91+
To allow the operator to react to changes in the `watchNamespaces` list dynamically, i.e., without restarting its pod, you must set both of the following in your configuration:
92+
93+
```yaml
94+
# 1. Enable the global dynamic configuration feature
95+
kubernetes.operator.dynamic.config.enabled: true
96+
97+
# 2. Enable the specific feature for dynamic namespaces
98+
kubernetes.operator.dynamic.namespaces.enabled: true
99+
```
100+
89101
## Leader Election and High Availability
90102
91103
The operator supports high availability through leader election and standby operator instances. To enable leader election you need to add the following two mandatory operator configuration parameters.

docs/layouts/shortcodes/generated/kubernetes_operator_config_configuration.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
<td><h5>kubernetes.operator.dynamic.namespaces.enabled</h5></td>
9797
<td style="word-wrap: break-word;">false</td>
9898
<td>Boolean</td>
99-
<td>Enables dynamic change of watched/monitored namespaces.</td>
99+
<td>Enables the operator to dynamically update the list of namespaces it watches. Requires dynamic.config.enabled to be set to true.</td>
100100
</tr>
101101
<tr>
102102
<td><h5>kubernetes.operator.events.exceptions.limit-per-reconciliation</h5></td>

docs/layouts/shortcodes/generated/system_section.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<td><h5>kubernetes.operator.dynamic.namespaces.enabled</h5></td>
1313
<td style="word-wrap: break-word;">false</td>
1414
<td>Boolean</td>
15-
<td>Enables dynamic change of watched/monitored namespaces.</td>
15+
<td>Enables the operator to dynamically update the list of namespaces it watches. Requires dynamic.config.enabled to be set to true.</td>
1616
</tr>
1717
<tr>
1818
<td><h5>kubernetes.operator.exception.field.max.length</h5></td>

flink-kubernetes-operator/src/main/java/org/apache/flink/kubernetes/operator/config/KubernetesOperatorConfigOptions.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,8 @@ public static String operatorConfigKey(String key) {
404404
operatorConfig("dynamic.namespaces.enabled")
405405
.booleanType()
406406
.defaultValue(false)
407-
.withDescription("Enables dynamic change of watched/monitored namespaces.");
407+
.withDescription(
408+
"Enables the operator to dynamically update the list of namespaces it watches. Requires dynamic.config.enabled to be set to true.");
408409

409410
@Documentation.Section(SECTION_SYSTEM)
410411
public static final ConfigOption<Duration> OPERATOR_RETRY_INITIAL_INTERVAL =

0 commit comments

Comments
 (0)