Skip to content

[Docs] Update Flink version references on the Flink runner page #39212

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

Merged
Abacn merged 2 commits into from
Aug 3, 2026
+12 −11
Merged

[Docs] Update Flink version references on the Flink runner page #39212

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e643925
[Docs] Add local Flink cluster guide for Python, update Flink version…
Eliaaazzz Jul 3, 2026
8a94599
[Docs] Split out the contributor guide, note Flink 2+ job server images
Eliaaazzz Aug 2, 2026
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
23 changes: 12 additions & 11 deletions website/www/site/content/en/documentation/runners/flink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ from the [compatibility table](#flink-version-compatibility) below. For example:
{{< highlight java >}}
<dependency>
<groupId>org.apache.beam</groupId>
<artifactId>beam-runners-flink-1.18</artifactId>
<artifactId>beam-runners-flink-1.20</artifactId>
<version>{{< param release_latest >}}</version>
</dependency>
{{< /highlight >}}
Expand Down Expand Up @@ -166,7 +166,7 @@ If you have a Flink `JobManager` running on your local machine you can provide `
To run a pipeline on Flink, set the runner to `FlinkRunner`
and `flink_master` to the master URL of a Flink cluster.
In addition, optionally set `environment_type` set to `LOOPBACK`. For example,
after starting up a [local flink cluster](https://ci.apache.org/projects/flink/flink-docs-release-1.18/getting-started/tutorials/local_setup.html),
after starting up a [local flink cluster](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/try-flink/local_installation/),
one could run:
{{< /paragraph >}}

Expand Down Expand Up @@ -196,9 +196,10 @@ The optional `flink_version` option may be required as well for older versions o

{{< paragraph class="language-portable" >}}
Starting with Beam 2.18.0, pre-built Flink Job Service Docker images are available at Docker Hub:
[Flink 1.16](https://hub.docker.com/r/apache/beam_flink1.16_job_server).
[Flink 1.17](https://hub.docker.com/r/apache/beam_flink1.17_job_server).
[Flink 1.18](https://hub.docker.com/r/apache/beam_flink1.18_job_server).
[Flink 1.19](https://hub.docker.com/r/apache/beam_flink1.19_job_server).
[Flink 1.20](https://hub.docker.com/r/apache/beam_flink1.20_job_server).

@Abacn Abacn Aug 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Flink 2+, the naming changed to, e.g. https://hub.docker.com/layers/apache/beam_flink_job_server/2.75.0-flink2.0

@Eliaaazzz Eliaaazzz Aug 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thank you. Added a line recording that Flink 2 and later share the apache/beam_flink_job_server repository with the Beam and Flink versions in the tag, using 2.75.0-flink2.0 as the example.

I also split the contributor guide out of this PR into #39580, so this one is just the version reference updates.

For Flink 2 and later the images share one repository, with the Beam and Flink versions in the tag,
for example [beam_flink_job_server:2.75.0-flink2.0](https://hub.docker.com/layers/apache/beam_flink_job_server/2.75.0-flink2.0).
{{< /paragraph >}}

<!-- TODO(BEAM-10214): Use actual lists here and below. -->
Expand All @@ -207,7 +208,7 @@ To run a pipeline on an embedded Flink cluster:
{{< /paragraph >}}

{{< paragraph class="language-portable" >}}
(1) Start the JobService endpoint: `docker run --net=host apache/beam_flink1.18_job_server:latest`
(1) Start the JobService endpoint: `docker run --net=host apache/beam_flink1.20_job_server:latest`
{{< /paragraph >}}

{{< paragraph class="language-portable" >}}
Expand All @@ -217,7 +218,7 @@ You might encounter an error message like `Caused by: java.io.IOException: Insuf
This can be resolved by providing a Flink configuration file to override the default settings.
You can find an example configuration file [here](https://github.com/apache/beam/blob/master/runners/flink/src/test/resources/flink-conf.yaml).
To start the Job Service endpoint with your custom configuration, mount a local directory containing your Flink configuration to the `/flink-conf` path in the Docker container and pass this as `--flink-conf-dir`:
`docker run --net=host -v <your_flink_conf_dir>:/flink-conf beam-flink-runner apache/beam_flink1.18_job_server:latest --flink-conf-dir /flink-conf`
`docker run --net=host -v <your_flink_conf_dir>:/flink-conf beam-flink-runner apache/beam_flink1.20_job_server:latest --flink-conf-dir /flink-conf`
{{< /paragraph >}}

{{< paragraph class="language-portable" >}}
Expand All @@ -240,15 +241,15 @@ with beam.Pipeline(options) as p:
<!-- Span implicitly ended -->

{{< paragraph class="language-portable" >}}
To run on a separate [Flink cluster](https://ci.apache.org/projects/flink/flink-docs-release-1.18/getting-started/tutorials/local_setup.html):
To run on a separate [Flink cluster](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/try-flink/local_installation/):
{{< /paragraph >}}

{{< paragraph class="language-portable" >}}
(1) Start a Flink cluster which exposes the Rest interface (e.g. `localhost:8081` by default).
{{< /paragraph >}}

{{< paragraph class="language-portable" >}}
(2) Start JobService with Flink Rest endpoint: `docker run --net=host apache/beam_flink1.18_job_server:latest --flink-master=localhost:8081`.
(2) Start JobService with Flink Rest endpoint: `docker run --net=host apache/beam_flink1.20_job_server:latest --flink-master=localhost:8081`.
{{< /paragraph >}}

{{< paragraph class="language-portable" >}}
Expand Down Expand Up @@ -316,8 +317,8 @@ reference.
## Flink Version Compatibility

The Flink cluster version has to match the minor version used by the FlinkRunner.
The minor version is the first two numbers in the version string, e.g. in `1.18.0` the
minor version is `1.18`.
The minor version is the first two numbers in the version string, e.g. in `1.20.0` the
minor version is `1.20`.

We try to track the latest version of Apache Flink at the time of the Beam release.
A Flink version is supported by Beam for the time it is supported by the Flink community.
Expand Down
Loading