This is an automated email from the ASF dual-hosted git repository.
xqhu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 10c7eb34af1 fix the flink runner doc (#33182)
10c7eb34af1 is described below
commit 10c7eb34af1c001e6ec71fecfe4ba96109e9ba9d
Author: liferoad <[email protected]>
AuthorDate: Wed Nov 20 17:06:54 2024 -0500
fix the flink runner doc (#33182)
---
.../www/site/content/en/documentation/runners/flink.md | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/website/www/site/content/en/documentation/runners/flink.md
b/website/www/site/content/en/documentation/runners/flink.md
index e9522d76e83..8356b9067a6 100644
--- a/website/www/site/content/en/documentation/runners/flink.md
+++ b/website/www/site/content/en/documentation/runners/flink.md
@@ -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.10/getting-started/tutorials/local_setup.html),
+after starting up a [local flink
cluster](https://ci.apache.org/projects/flink/flink-docs-release-1.18/getting-started/tutorials/local_setup.html),
one could run:
{{< /paragraph >}}
@@ -207,12 +207,17 @@ 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.10_job_server:latest`
+(1) Start the JobService endpoint: `docker run --net=host
apache/beam_flink1.18_job_server:latest`
{{< /paragraph >}}
{{< paragraph class="language-portable" >}}
The JobService is the central instance where you submit your Beam pipeline to.
-The JobService will create a Flink job for the pipeline and execute the job.
+It creates a Flink job from your pipeline and executes it.
+You might encounter an error message like `Caused by: java.io.IOException:
Insufficient number of network buffers:...`.
+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`
{{< /paragraph >}}
{{< paragraph class="language-portable" >}}
@@ -235,7 +240,7 @@ 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.10/getting-started/tutorials/local_setup.html):
+To run on a separate [Flink
cluster](https://ci.apache.org/projects/flink/flink-docs-release-1.18/getting-started/tutorials/local_setup.html):
{{< /paragraph >}}
{{< paragraph class="language-portable" >}}
@@ -243,7 +248,7 @@ To run on a separate [Flink
cluster](https://ci.apache.org/projects/flink/flink-
{{< /paragraph >}}
{{< paragraph class="language-portable" >}}
-(2) Start JobService with Flink Rest endpoint: `docker run --net=host
apache/beam_flink1.10_job_server:latest --flink-master=localhost:8081`.
+(2) Start JobService with Flink Rest endpoint: `docker run --net=host
apache/beam_flink1.18_job_server:latest --flink-master=localhost:8081`.
{{< /paragraph >}}
{{< paragraph class="language-portable" >}}