Skip to content

Commit ffaa3dd

Browse files
[FLINK-35357][docs] Add kubernetes.operator.plugins.listeners config (#845)
1 parent f2adb15 commit ffaa3dd

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

docs/layouts/shortcodes/generated/dynamic_section.html

+6
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,12 @@
140140
<td>String</td>
141141
<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>
142142
</tr>
143+
<tr>
144+
<td><h5>kubernetes.operator.plugins.listeners.&lt;listener-name&gt;.class</h5></td>
145+
<td style="word-wrap: break-word;">(none)</td>
146+
<td>String</td>
147+
<td>Custom plugins listener class, 'listener-name' is the name of the plugin listener, and its value is a fully qualified class name.</td>
148+
</tr>
143149
<tr>
144150
<td><h5>kubernetes.operator.pod-template.merge-arrays-by-name</h5></td>
145151
<td style="word-wrap: break-word;">false</td>

docs/layouts/shortcodes/generated/kubernetes_operator_config_configuration.html

+6
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,12 @@
278278
<td>String</td>
279279
<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>
280280
</tr>
281+
<tr>
282+
<td><h5>kubernetes.operator.plugins.listeners.&lt;listener-name&gt;.class</h5></td>
283+
<td style="word-wrap: break-word;">(none)</td>
284+
<td>String</td>
285+
<td>Custom plugins listener class, 'listener-name' is the name of the plugin listener, and its value is a fully qualified class name.</td>
286+
</tr>
281287
<tr>
282288
<td><h5>kubernetes.operator.pod-template.merge-arrays-by-name</h5></td>
283289
<td style="word-wrap: break-word;">false</td>

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

+9
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,15 @@ public static String operatorConfigKey(String key) {
333333
+ "WARNING: not intended to be used together with the cron-based "
334334
+ "periodic checkpoint triggering");
335335

336+
@SuppressWarnings("unused")
337+
@Documentation.Section(SECTION_DYNAMIC)
338+
public static final ConfigOption<String> PLUGINS_LISTENERS_CLASS =
339+
operatorConfig("plugins.listeners.<listener-name>.class")
340+
.stringType()
341+
.noDefaultValue()
342+
.withDescription(
343+
"Custom plugins listener class, 'listener-name' is the name of the plugin listener, and its value is a fully qualified class name.");
344+
336345
@Documentation.Section(SECTION_SYSTEM)
337346
public static final ConfigOption<String> OPERATOR_WATCHED_NAMESPACES =
338347
operatorConfig("watched.namespaces")

0 commit comments

Comments
 (0)