[FLINK-33236][config] Deprecate the unused high-availability.zookeepe…

…r.path.running-registry option (#23506)
apache · Oct 16, 2023 · 935188f · 935188f
1 parent aaaa07a
commit 935188f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 13 deletions.
diff --git a/docs/layouts/shortcodes/generated/expert_high_availability_zk_section.html b/docs/layouts/shortcodes/generated/expert_high_availability_zk_section.html
@@ -56,11 +56,5 @@
             <td>String</td>
             <td>ZooKeeper root path (ZNode) for job graphs</td>
         </tr>
-        <tr>
-            <td><h5>high-availability.zookeeper.path.running-registry</h5></td>
-            <td style="word-wrap: break-word;">"/running_job_registry/"</td>
-            <td>String</td>
-            <td></td>
-        </tr>
     </tbody>
 </table>
diff --git a/docs/layouts/shortcodes/generated/high_availability_configuration.html b/docs/layouts/shortcodes/generated/high_availability_configuration.html
@@ -86,12 +86,6 @@
             <td>String</td>
             <td>The root path under which Flink stores its entries in ZooKeeper.</td>
         </tr>
-        <tr>
-            <td><h5>high-availability.zookeeper.path.running-registry</h5></td>
-            <td style="word-wrap: break-word;">"/running_job_registry/"</td>
-            <td>String</td>
-            <td></td>
-        </tr>
         <tr>
             <td><h5>high-availability.zookeeper.quorum</h5></td>
             <td style="word-wrap: break-word;">(none)</td>

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
@@ -167,11 +167,16 @@ public class HighAvailabilityOptions {
                     .withDescription(
                             "Defines the number of connection retries before the client gives up.");
 
+    /** @deprecated Don't use this option anymore. It has no effect on Flink. */
+    @Deprecated
     @Documentation.Section(Documentation.Sections.EXPERT_ZOOKEEPER_HIGH_AVAILABILITY)
     public static final ConfigOption<String> ZOOKEEPER_RUNNING_JOB_REGISTRY_PATH =
             key("high-availability.zookeeper.path.running-registry")
                     .stringType()
-                    .defaultValue("/running_job_registry/");
+                    .defaultValue("/running_job_registry/")
+                    .withDescription(
+                            "Don't use this option anymore. It has no effect on Flink. The RunningJobRegistry has been "
+                                    + "replaced by the JobResultStore in Flink 1.15.");
 
     @Documentation.Section(Documentation.Sections.EXPERT_ZOOKEEPER_HIGH_AVAILABILITY)
     public static final ConfigOption<String> ZOOKEEPER_CLIENT_ACL =