Skip to content

Commit bed991f

Browse files
tony810430tillrohrmann
authored andcommitted
[FLINK-22476][docs] Extend the description of the config option execution.target
This closes #15777.
1 parent 0fc09d2 commit bed991f

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

docs/layouts/shortcodes/generated/deployment_configuration.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<td><h5>execution.target</h5></td>
3131
<td style="word-wrap: break-word;">(none)</td>
3232
<td>String</td>
33-
<td>The deployment target for the execution. This can take one of the following values:<ul><li>remote</li><li>local</li><li>yarn-per-job</li><li>yarn-session</li><li>kubernetes-session</li></ul>.</td>
33+
<td>The deployment target for the execution. This can take one of the following values when calling <code class="highlighter-rouge">bin/flink run</code>:<ul><li>remote</li><li>local</li><li>yarn-per-job</li><li>yarn-session</li><li>kubernetes-session</li></ul>And one of the following values when calling <code class="highlighter-rouge">bin/flink run-application</code>:<ul><li>yarn-application</li><li>kubernetes-application</li></ul></td>
3434
</tr>
3535
</tbody>
3636
</table>

flink-core/src/main/java/org/apache/flink/configuration/DeploymentOptions.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
import org.apache.flink.annotation.PublicEvolving;
2222
import org.apache.flink.configuration.description.Description;
23+
import org.apache.flink.configuration.description.TextElement;
2324

2425
import java.util.List;
2526

@@ -37,14 +38,19 @@ public class DeploymentOptions {
3738
.withDescription(
3839
Description.builder()
3940
.text(
40-
"The deployment target for the execution. This can take one of the following values:")
41+
"The deployment target for the execution. This can take one of the following values "
42+
+ "when calling %s:",
43+
TextElement.code("bin/flink run"))
4144
.list(
4245
text("remote"),
4346
text("local"),
4447
text("yarn-per-job"),
4548
text("yarn-session"),
4649
text("kubernetes-session"))
47-
.text(".")
50+
.text(
51+
"And one of the following values when calling %s:",
52+
TextElement.code("bin/flink run-application"))
53+
.list(text("yarn-application"), text("kubernetes-application"))
4854
.build());
4955

5056
public static final ConfigOption<Boolean> ATTACHED =

0 commit comments

Comments
 (0)