You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by xt...@apache.org on 2021/01/13 01:05:29 UTC
[flink] branch master updated: [FLINK-20905][K8s] Format the
description of 'kubernetes.container.image' option
This is an automated email from the ASF dual-hosted git repository.
xtsong 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 a1d62e4 [FLINK-20905][K8s] Format the description of 'kubernetes.container.image' option
a1d62e4 is described below
commit a1d62e45f72e8cddd009bc907860a3937adb728c
Author: yuruguo <ji...@163.com>
AuthorDate: Sat Jan 9 18:08:18 2021 +0800
[FLINK-20905][K8s] Format the description of 'kubernetes.container.image' option
This closes #14597
---
.../generated/kubernetes_config_configuration.html | 2 +-
.../kubernetes/configuration/KubernetesConfigOptions.java | 14 +++++++++++---
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/docs/_includes/generated/kubernetes_config_configuration.html b/docs/_includes/generated/kubernetes_config_configuration.html
index c007d18..0f63926 100644
--- a/docs/_includes/generated/kubernetes_config_configuration.html
+++ b/docs/_includes/generated/kubernetes_config_configuration.html
@@ -36,7 +36,7 @@
<td><h5>kubernetes.container.image</h5></td>
<td style="word-wrap: break-word;">The default value depends on the actually running version. In general it looks like "flink:<FLINK_VERSION>-scala_<SCALA_VERSION>"</td>
<td>String</td>
- <td>Image to use for Flink containers. The specified image must be based upon the same Apache Flink and Scala versions as used by the application. Visit https://hub.docker.com/_/flink?tab=tags for the official docker images provided by the Flink project. The Flink project also publishes docker images here: https://hub.docker.com/r/apache/flink</td>
+ <td>Image to use for Flink containers. The specified image must be based upon the same Apache Flink and Scala versions as used by the application. Visit <a href="https://hub.docker.com/_/flink?tab=tags">here</a> for the official docker images provided by the Flink project. The Flink project also publishes docker images to <a href="https://hub.docker.com/r/apache/flink/tags">apache/flink DockerHub repository</a>.</td>
</tr>
<tr>
<td><h5>kubernetes.container.image.pull-policy</h5></td>
diff --git a/flink-kubernetes/src/main/java/org/apache/flink/kubernetes/configuration/KubernetesConfigOptions.java b/flink-kubernetes/src/main/java/org/apache/flink/kubernetes/configuration/KubernetesConfigOptions.java
index 50ab3fa..abeae35 100644
--- a/flink-kubernetes/src/main/java/org/apache/flink/kubernetes/configuration/KubernetesConfigOptions.java
+++ b/flink-kubernetes/src/main/java/org/apache/flink/kubernetes/configuration/KubernetesConfigOptions.java
@@ -30,6 +30,7 @@ import java.util.Locale;
import java.util.Map;
import static org.apache.flink.configuration.ConfigOptions.key;
+import static org.apache.flink.configuration.description.LinkElement.link;
import static org.apache.flink.configuration.description.TextElement.code;
/** This class holds configuration constants used by Flink's kubernetes runners. */
@@ -195,9 +196,16 @@ public class KubernetesConfigOptions {
.stringType()
.defaultValue(getDefaultFlinkImage())
.withDescription(
- "Image to use for Flink containers. "
- + "The specified image must be based upon the same Apache Flink and Scala versions as used by the application. "
- + "Visit https://hub.docker.com/_/flink?tab=tags for the official docker images provided by the Flink project. The Flink project also publishes docker images here: https://hub.docker.com/r/apache/flink");
+ Description.builder()
+ .text(
+ "Image to use for Flink containers. "
+ + "The specified image must be based upon the same Apache Flink and Scala versions as used by the application. "
+ + "Visit %s for the official docker images provided by the Flink project. The Flink project also publishes docker images to %s.",
+ link("https://hub.docker.com/_/flink?tab=tags", "here"),
+ link(
+ "https://hub.docker.com/r/apache/flink/tags",
+ "apache/flink DockerHub repository"))
+ .build());
/** The following config options need to be set according to the image. */
public static final ConfigOption<String> KUBERNETES_ENTRY_PATH =