This is an automated email from the ASF dual-hosted git repository.
zhuzh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 2be1ea801cf [FLINK-34126][configuration] Correct the description of
config option jobmanager.scheduler
2be1ea801cf is described below
commit 2be1ea801cf616d0d0a82729829245c205caaad8
Author: JunRuiLee <[email protected]>
AuthorDate: Wed Jan 17 13:54:55 2024 +0800
[FLINK-34126][configuration] Correct the description of config option
jobmanager.scheduler
This closes #24112.
---
.../generated/all_jobmanager_section.html | 2 +-
.../generated/expert_scheduling_section.html | 2 +-
.../generated/job_manager_configuration.html | 2 +-
.../flink/configuration/JobManagerOptions.java | 51 ++++++++++++++--------
4 files changed, 36 insertions(+), 21 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/all_jobmanager_section.html
b/docs/layouts/shortcodes/generated/all_jobmanager_section.html
index 79b0e7f804b..626aa50f386 100644
--- a/docs/layouts/shortcodes/generated/all_jobmanager_section.html
+++ b/docs/layouts/shortcodes/generated/all_jobmanager_section.html
@@ -120,7 +120,7 @@
<td><h5>jobmanager.scheduler</h5></td>
<td style="word-wrap: break-word;">Default</td>
<td><p>Enum</p></td>
- <td>Determines which scheduler implementation is used to schedule
tasks. Accepted values are:<ul><li>'Default': Default
scheduler</li><li>'Adaptive': Adaptive scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a>.</li><li>'AdaptiveBatch':
Adaptive batch scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-ba
[...]
+ <td>Determines which scheduler implementation is used to schedule
tasks. If this option is not explicitly set, batch jobs will use the
'AdaptiveBatch' scheduler as the default, while streaming jobs will default to
the 'Default' scheduler. <br /><br />Possible values:<ul><li>"Default": Default
scheduler</li><li>"Adaptive": Adaptive scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a
[...]
</tr>
<tr>
<td><h5>jobstore.cache-size</h5></td>
diff --git a/docs/layouts/shortcodes/generated/expert_scheduling_section.html
b/docs/layouts/shortcodes/generated/expert_scheduling_section.html
index 56837bda5e3..0c9c877c844 100644
--- a/docs/layouts/shortcodes/generated/expert_scheduling_section.html
+++ b/docs/layouts/shortcodes/generated/expert_scheduling_section.html
@@ -102,7 +102,7 @@
<td><h5>jobmanager.scheduler</h5></td>
<td style="word-wrap: break-word;">Default</td>
<td><p>Enum</p></td>
- <td>Determines which scheduler implementation is used to schedule
tasks. Accepted values are:<ul><li>'Default': Default
scheduler</li><li>'Adaptive': Adaptive scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a>.</li><li>'AdaptiveBatch':
Adaptive batch scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-ba
[...]
+ <td>Determines which scheduler implementation is used to schedule
tasks. If this option is not explicitly set, batch jobs will use the
'AdaptiveBatch' scheduler as the default, while streaming jobs will default to
the 'Default' scheduler. <br /><br />Possible values:<ul><li>"Default": Default
scheduler</li><li>"Adaptive": Adaptive scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a
[...]
</tr>
<tr>
<td><h5>scheduler-mode</h5></td>
diff --git a/docs/layouts/shortcodes/generated/job_manager_configuration.html
b/docs/layouts/shortcodes/generated/job_manager_configuration.html
index d07705d7018..b82ae03c3d7 100644
--- a/docs/layouts/shortcodes/generated/job_manager_configuration.html
+++ b/docs/layouts/shortcodes/generated/job_manager_configuration.html
@@ -174,7 +174,7 @@
<td><h5>jobmanager.scheduler</h5></td>
<td style="word-wrap: break-word;">Default</td>
<td><p>Enum</p></td>
- <td>Determines which scheduler implementation is used to schedule
tasks. Accepted values are:<ul><li>'Default': Default
scheduler</li><li>'Adaptive': Adaptive scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a>.</li><li>'AdaptiveBatch':
Adaptive batch scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-ba
[...]
+ <td>Determines which scheduler implementation is used to schedule
tasks. If this option is not explicitly set, batch jobs will use the
'AdaptiveBatch' scheduler as the default, while streaming jobs will default to
the 'Default' scheduler. <br /><br />Possible values:<ul><li>"Default": Default
scheduler</li><li>"Adaptive": Adaptive scheduler. More details can be found <a
href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a
[...]
</tr>
<tr>
<td><h5>jobstore.cache-size</h5></td>
diff --git
a/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
b/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
index 0378e380923..1e6c68c3506 100644
---
a/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
+++
b/flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
@@ -18,9 +18,11 @@
package org.apache.flink.configuration;
+import org.apache.flink.annotation.Internal;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.configuration.description.Description;
+import org.apache.flink.configuration.description.InlineElement;
import java.time.Duration;
@@ -458,29 +460,42 @@ public class JobManagerOptions {
.withDescription(
Description.builder()
.text(
- "Determines which scheduler
implementation is used to schedule tasks. Accepted values are:")
- .list(
- text("'Default': Default
scheduler"),
- text(
- "'Adaptive': Adaptive
scheduler. More details can be found %s.",
- link(
-
"{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler",
- "here")),
- text(
- "'AdaptiveBatch': Adaptive
batch scheduler. More details can be found %s.",
- link(
-
"{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-batch-scheduler",
- "here")))
+ "Determines which scheduler
implementation is used to schedule tasks. "
+ + "If this option is not
explicitly set, batch jobs will use the "
+ + "'AdaptiveBatch'
scheduler as the default, while streaming jobs "
+ + "will default to the
'Default' scheduler. ")
.build());
/** Type of scheduler implementation. */
- public enum SchedulerType {
+ public enum SchedulerType implements DescribedEnum {
/** @deprecated Use {@link SchedulerType#Default} instead. */
@Deprecated
- Ng,
- Default,
- Adaptive,
- AdaptiveBatch
+ Ng(text("Deprecated. Use Default scheduler instead.")),
+ Default(text("Default scheduler")),
+ Adaptive(
+ text(
+ "Adaptive scheduler. More details can be found %s.",
+ link(
+
"{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler",
+ "here"))),
+ AdaptiveBatch(
+ text(
+ "Adaptive batch scheduler. More details can be found
%s.",
+ link(
+
"{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-batch-scheduler",
+ "here")));
+
+ private final InlineElement description;
+
+ SchedulerType(InlineElement description) {
+ this.description = description;
+ }
+
+ @Internal
+ @Override
+ public InlineElement getDescription() {
+ return description;
+ }
}
@Documentation.Section(Documentation.Sections.EXPERT_SCHEDULING)
