[flink-kubernetes-operator] branch release-1.0 updated: [FLINK-27668] Document dynamic operator configuration

[gy...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gyfora pushed a commit to branch release-1.0
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git


The following commit(s) were added to refs/heads/release-1.0 by this push:
     new 2e55d41  [FLINK-27668] Document dynamic operator configuration
2e55d41 is described below

commit 2e55d4193adc22b1025ff8c8c48042a6d5cfaa3b
Author: Nicholas Jiang <pr...@163.com>
AuthorDate: Wed Jun 1 17:41:37 2022 +0800

    [FLINK-27668] Document dynamic operator configuration
---
 docs/content/docs/operations/configuration.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/docs/content/docs/operations/configuration.md b/docs/content/docs/operations/configuration.md
index 6cea9a7..1d4411d 100644
--- a/docs/content/docs/operations/configuration.md
+++ b/docs/content/docs/operations/configuration.md
@@ -50,11 +50,30 @@ defaultConfiguration:
 
 To learn more about metrics and logging configuration please refer to the dedicated [docs page]({{< ref "docs/operations/metrics-logging" >}}).
 
+## Dynamic Operator Configuration
+
+The Kubernetes operator supports dynamic config changes through the operator ConfigMaps. Dynamic operator configuration is enabled by default, and can be disabled by setting `kubernetes.operator.dynamic.config.enabled`  to false. Time interval for checking dynamic config changes is specified by `kubernetes.operator.dynamic.config.check.interval` of which default value is 5 minutes. 
+
+Verify whether dynamic operator configuration updates is enabled via the `deploy/flink-kubernetes-operator` log has:
+
+```
+2022-05-28 13:08:29,222 o.a.f.k.o.c.FlinkConfigManager [INFO ] Enabled dynamic config updates, checking config changes every PT5M
+```
+
+To change config values dynamically the ConfigMap can be directly edited via `kubectl patch` or `kubectl edit` command. For example to change the reschedule interval you can override `kubernetes.operator.reconciler.reschedule.interval`.
+
+Verify whether the config value of `kubernetes.operator.reconciler.reschedule.interval` is updated to 30 seconds via the `deploy/flink-kubernetes-operator` log has:
+
+```text
+2022-05-28 13:08:30,115 o.a.f.k.o.c.FlinkConfigManager [INFO ] Updating default configuration to {kubernetes.operator.reconciler.reschedule.interval=PT30S}
+```
+
 ## Operator Configuration Reference
 
 {{< generated/kubernetes_operator_config_configuration >}}
 
 ## Job Specific Configuration Reference
+
 Job specific configuration can be configured under `spec.flinkConfiguration` and it will override flink configurations defined in `flink-conf.yaml`.
 
 - For application clusters, `spec.flinkConfiguration` will be located in `FlinkDeployment` CustomResource.