You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Yang Wang (Jira)" <ji...@apache.org> on 2021/01/11 03:27:00 UTC
[jira] [Commented] (FLINK-20905) Format the description of
'kubernetes.container.image' option
[ https://issues.apache.org/jira/browse/FLINK-20905?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17262368#comment-17262368 ]
Yang Wang commented on FLINK-20905:
-----------------------------------
[~xintongsong] Could you please assign this ticket to [~jiang7chengzitc]? I think this improvement makes sense.
> Format the description of 'kubernetes.container.image' option
> -------------------------------------------------------------
>
> Key: FLINK-20905
> URL: https://issues.apache.org/jira/browse/FLINK-20905
> Project: Flink
> Issue Type: Improvement
> Components: Deployment / Kubernetes
> Affects Versions: 1.12.0, 1.11.3
> Reporter: Ruguo Yu
> Priority: Minor
> Labels: pull-request-available
> Fix For: 1.13.0
>
>
> The description of ConfigOption 'kubernetes.container.image' has a URL link, as follows:
> {code:java}
> @Documentation.OverrideDefault(
> "The default value depends on the actually running version. In general it looks like \"flink:<FLINK_VERSION>-scala_<SCALA_VERSION>\"")
> public static final ConfigOption<String> CONTAINER_IMAGE =
> key("kubernetes.container.image")
> .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");
> {code}
> so the most reasonable way is to use *Text Description* with *Link,* as follows:
> {code:java}
> @Documentation.OverrideDefault(
> "The default value depends on the actually running version. In general it looks like \"flink:<FLINK_VERSION>-scala_<SCALA_VERSION>\"")
> public static final ConfigOption<String> CONTAINER_IMAGE =
> key("kubernetes.container.image")
> .stringType()
> .defaultValue(getDefaultFlinkImage())
> .withDescription(
> 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", "DockerHub"))
> .build());
> {code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)