[FLINK-35357][docs] Add kubernetes.operator.plugins.listeners config (#…

…845)
apache · Jul 4, 2024 · ffaa3dd · ffaa3dd
1 parent f2adb15
commit ffaa3dd
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/layouts/shortcodes/generated/dynamic_section.html b/docs/layouts/shortcodes/generated/dynamic_section.html
@@ -140,6 +140,12 @@
             <td>String</td>
             <td>Option to enable automatic savepoint triggering. Can be specified either as a Duration type (i.e. '10m') or as a cron expression in Quartz format (6 or 7 positions, see http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).The triggering schedule is not guaranteed, savepoints will be triggered as part of the regular reconcile loop. WARNING: not intended to be used together with the cron-based periodic savepoint triggering</td>
         </tr>
+        <tr>
+            <td><h5>kubernetes.operator.plugins.listeners.&lt;listener-name&gt;.class</h5></td>
+            <td style="word-wrap: break-word;">(none)</td>
+            <td>String</td>
+            <td>Custom plugins listener class, 'listener-name' is the name of the plugin listener, and its value is a fully qualified class name.</td>
+        </tr>
         <tr>
             <td><h5>kubernetes.operator.pod-template.merge-arrays-by-name</h5></td>
             <td style="word-wrap: break-word;">false</td>

diff --git a/docs/layouts/shortcodes/generated/kubernetes_operator_config_configuration.html b/docs/layouts/shortcodes/generated/kubernetes_operator_config_configuration.html
@@ -278,6 +278,12 @@
             <td>String</td>
             <td>Option to enable automatic savepoint triggering. Can be specified either as a Duration type (i.e. '10m') or as a cron expression in Quartz format (6 or 7 positions, see http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).The triggering schedule is not guaranteed, savepoints will be triggered as part of the regular reconcile loop. WARNING: not intended to be used together with the cron-based periodic savepoint triggering</td>
         </tr>
+        <tr>
+            <td><h5>kubernetes.operator.plugins.listeners.&lt;listener-name&gt;.class</h5></td>
+            <td style="word-wrap: break-word;">(none)</td>
+            <td>String</td>
+            <td>Custom plugins listener class, 'listener-name' is the name of the plugin listener, and its value is a fully qualified class name.</td>
+        </tr>
         <tr>
             <td><h5>kubernetes.operator.pod-template.merge-arrays-by-name</h5></td>
             <td style="word-wrap: break-word;">false</td>

diff --git a/...ain/java/org/apache/flink/kubernetes/operator/config/KubernetesOperatorConfigOptions.java b/...ain/java/org/apache/flink/kubernetes/operator/config/KubernetesOperatorConfigOptions.java
@@ -333,6 +333,15 @@ public static String operatorConfigKey(String key) {
                                     + "WARNING: not intended to be used together with the cron-based "
                                     + "periodic checkpoint triggering");
 
+    @SuppressWarnings("unused")
+    @Documentation.Section(SECTION_DYNAMIC)
+    public static final ConfigOption<String> PLUGINS_LISTENERS_CLASS =
+            operatorConfig("plugins.listeners.<listener-name>.class")
+                    .stringType()
+                    .noDefaultValue()
+                    .withDescription(
+                            "Custom plugins listener class, 'listener-name' is the name of the plugin listener, and its value is a fully qualified class name.");
+
     @Documentation.Section(SECTION_SYSTEM)
     public static final ConfigOption<String> OPERATOR_WATCHED_NAMESPACES =
             operatorConfig("watched.namespaces")