Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yuruguo wants to merge 3 commits into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b90ef4d
[FLINK-20905][K8s] Format the description of 'kubernetes.container.im…
yuruguo Jan 9, 2021
6ee5ee1
Change 'DockerHub' to 'apache/flink DockerHub repository'
yuruguo Jan 11, 2021
9e0cb70
Correct flink DockerHub repository link
yuruguo Jan 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_includes/generated/kubernetes_config_configuration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:&lt;FLINK_VERSION&gt;-scala_&lt;SCALA_VERSION&gt;"</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>
Expand Down
14 changes: 11 additions & 3 deletions ...etes/src/main/java/org/apache/flink/kubernetes/configuration/KubernetesConfigOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
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. */
Expand Down Expand Up @@ -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 =
Expand Down