[FLINK-20905] Format the description of 'kubernetes.container.image' option

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.11.3, 1.12.0
• Fix Version/s: 1.13.0
• Component/s: Deployment / Kubernetes
• Labels: pull-request-available
• Assignee: Ruguo Yu
• Reporter: Ruguo Yu
• Created: 09/Jan/21 09:42
• Updated: 28/May/21 07:06
• Resolved: 13/Jan/21 01:05

Description

The description of ConfigOption 'kubernetes.container.image' has a URL link, as follows:

@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");

so the most reasonable way is to use Text Description with Link, as follows:

@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());

Issue Links

• links to: GitHub Pull Request #14597