[FLINK-23738][state] Hide ChangelogBackend config options

The feature won't be released in the upcoming release. # Please enter the commit message for your changes. Lines starting
lightClouds917 · Aug 15, 2021 · 67dd493 · 67dd493
1 parent d7794b8
commit 67dd493
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 24 deletions.
diff --git a/docs/layouts/shortcodes/generated/checkpointing_configuration.html b/docs/layouts/shortcodes/generated/checkpointing_configuration.html
@@ -8,18 +8,6 @@
         </tr>
     </thead>
     <tbody>
-        <tr>
-            <td><h5>state.backend.changelog.enabled</h5></td>
-            <td style="word-wrap: break-word;">false</td>
-            <td>Boolean</td>
-            <td>Whether to enable state backend to write state changes to StateChangelog. If this config is not set explicitly, it means no preference for enabling the change log, and the value in lower config level will take effect. The default value 'false' here means if no value set (job or cluster), the change log will not be enabled.</td>
-        </tr>
-        <tr>
-            <td><h5>state.backend.changelog.storage</h5></td>
-            <td style="word-wrap: break-word;">"memory"</td>
-            <td>String</td>
-            <td>The storage to be used to store state changelog.<br />The implementation can be specified via their shortcut name.<br />The list of recognized shortcut names currently includes 'memory' and 'filesystem'.</td>
-        </tr>
         <tr>
             <td><h5>state.backend.incremental</h5></td>
             <td style="word-wrap: break-word;">false</td>

diff --git a/docs/layouts/shortcodes/generated/common_state_backends_section.html b/docs/layouts/shortcodes/generated/common_state_backends_section.html
@@ -32,18 +32,6 @@
             <td>String</td>
             <td>The default directory for savepoints. Used by the state backends that write savepoints to file systems (HashMapStateBackend, EmbeddedRocksDBStateBackend).</td>
         </tr>
-        <tr>
-            <td><h5>state.backend.changelog.enabled</h5></td>
-            <td style="word-wrap: break-word;">false</td>
-            <td>Boolean</td>
-            <td>Whether to enable state backend to write state changes to StateChangelog. If this config is not set explicitly, it means no preference for enabling the change log, and the value in lower config level will take effect. The default value 'false' here means if no value set (job or cluster), the change log will not be enabled.</td>
-        </tr>
-        <tr>
-            <td><h5>state.backend.changelog.storage</h5></td>
-            <td style="word-wrap: break-word;">"memory"</td>
-            <td>String</td>
-            <td>The storage to be used to store state changelog.<br />The implementation can be specified via their shortcut name.<br />The list of recognized shortcut names currently includes 'memory' and 'filesystem'.</td>
-        </tr>
         <tr>
             <td><h5>state.backend.incremental</h5></td>
             <td style="word-wrap: break-word;">false</td>

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java
@@ -102,6 +102,7 @@ public class CheckpointingOptions {
 
     /** Whether to enable state change log. */
     @Documentation.Section(value = Documentation.Sections.COMMON_STATE_BACKENDS)
+    @Documentation.ExcludeFromDocumentation("ChangelogBackend is under development")
     public static final ConfigOption<Boolean> ENABLE_STATE_CHANGE_LOG =
             ConfigOptions.key("state.backend.changelog.enabled")
                     .booleanType()
@@ -121,6 +122,7 @@ public class CheckpointingOptions {
      * InMemoryStateChangelogStorageFactory.getIdentifier()}, which is also the default value.
      */
     @Documentation.Section(value = Documentation.Sections.COMMON_STATE_BACKENDS)
+    @Documentation.ExcludeFromDocumentation("ChangelogBackend is under development")
     public static final ConfigOption<String> STATE_CHANGE_LOG_STORAGE =
             ConfigOptions.key("state.backend.changelog.storage")
                     .stringType()

diff --git a/...l/flink-dstl-dfs/src/main/java/org/apache/flink/changelog/fs/FsStateChangelogOptions.java b/...l/flink-dstl-dfs/src/main/java/org/apache/flink/changelog/fs/FsStateChangelogOptions.java
@@ -18,6 +18,7 @@
 package org.apache.flink.changelog.fs;
 
 import org.apache.flink.annotation.Experimental;
+import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.ConfigOptions;
 import org.apache.flink.configuration.MemorySize;
@@ -28,6 +29,7 @@
 
 /** {@link ConfigOptions} for {@link FsStateChangelogStorage}. */
 @Experimental
+@Documentation.ExcludeFromDocumentation("ChangelogBackend is under development")
 public class FsStateChangelogOptions {
 
     public static final ConfigOption<String> BASE_PATH =