This Getting Started section guides you through the local setup (on one machine, but in separate containers) of a Flink cluster using Docker containers.
Docker is a popular container runtime. There are official Docker images for Apache Flink available on Docker Hub. You can use the Docker images to deploy a Session or Application cluster on Docker. This page focuses on the setup of Flink on Docker, Docker Swarm and Docker Compose.
Deployment into managed containerized environments, such as standalone Kubernetes or native Kubernetes, are described on separate pages.
A Flink Session cluster can be used to run multiple jobs. Each job needs to be submitted to the cluster after the cluster has been deployed. To deploy a Flink Session cluster with Docker, you need to start a JobManager container. To enable communication between the containers, we first set a required Flink configuration property and create a network:
$ FLINK_PROPERTIES="jobmanager.rpc.address: jobmanager"
$ docker network create flink-network
Then we launch the JobManager:
$ docker run \
--rm \
--name=jobmanager \
--network flink-network \
--publish 8081:8081 \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
flink:1.12.7-scala_2.11 jobmanager
and one or more TaskManager containers:
$ docker run \
--rm \
--name=taskmanager \
--network flink-network \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
flink:1.12.7-scala_2.11 taskmanager
The web interface is now available at localhost:8081.
Submission of a job is now possible like this (assuming you have a local distribution of Flink available):
$ ./bin/flink run ./examples/streaming/TopSpeedWindowing.jar
To shut down the cluster, either terminate (e.g. with CTRL-C
) the JobManager and TaskManager processes, or use docker ps
to identify and docker stop
to terminate the containers.
The Flink image contains a regular Flink distribution with its default configuration and a standard entry point script. You can run its entry point in the following modes:
This allows you to deploy a standalone cluster (Session or Application Mode) in any containerised environment, for example:
Note The native Kubernetes also runs the same image by default and deploys TaskManagers on demand so that you do not have to do it manually.
The next chapters describe how to start a single Flink Docker container for various purposes.
Once you’ve started Flink on Docker, you can access the Flink Webfrontend on localhost:8081 or submit jobs like this ./bin/flink run ./examples/streaming/TopSpeedWindowing.jar
.
We recommend using Docker Compose or Docker Swarm for deploying Flink in Session Mode to ease system configuration.
A Flink Application cluster is a dedicated cluster which runs a single job. In this case, you deploy the cluster with the job as one step, thus, there is no extra job submission needed.
The job artifacts are included into the class path of Flink’s JVM process within the container and consist of:
To deploy a cluster for a single job with Docker, you need to
/opt/flink/usrlib
,To make the job artifacts available locally in the container, you can
either mount a volume (or multiple volumes) with the artifacts to /opt/flink/usrlib
when you start
the JobManager and TaskManagers:
$ FLINK_PROPERTIES="jobmanager.rpc.address: jobmanager"
$ docker network create flink-network
$ docker run \
--mount type=bind,src=/host/path/to/job/artifacts1,target=/opt/flink/usrlib/artifacts1 \
--mount type=bind,src=/host/path/to/job/artifacts2,target=/opt/flink/usrlib/artifacts2 \
--rm \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
--name=jobmanager \
--network flink-network \
flink:1.12.7-scala_2.11 standalone-job \
--job-classname com.job.ClassName \
[--job-id <job id>] \
[--fromSavepoint /path/to/savepoint [--allowNonRestoredState]] \
[job arguments]
$ docker run \
--mount type=bind,src=/host/path/to/job/artifacts1,target=/opt/flink/usrlib/artifacts1 \
--mount type=bind,src=/host/path/to/job/artifacts2,target=/opt/flink/usrlib/artifacts2 \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
flink:1.12.7-scala_2.11 taskmanager
or extend the Flink image by writing a custom Dockerfile
, build it and use it for starting the JobManager and TaskManagers:
FROM flink
ADD /host/path/to/job/artifacts/1 /opt/flink/usrlib/artifacts/1
ADD /host/path/to/job/artifacts/2 /opt/flink/usrlib/artifacts/2
$ docker build --tag flink_with_job_artifacts .
$ docker run \
flink_with_job_artifacts standalone-job \
--job-classname com.job.ClassName \
[--job-id <job id>] \
[--fromSavepoint /path/to/savepoint [--allowNonRestoredState]] \
[job arguments]
$ docker run flink_with_job_artifacts taskmanager
The standalone-job
argument starts a JobManager container in the Application Mode.
You can provide the following additional command line arguments to the cluster entrypoint:
--job-classname <job class name>
: Class name of the job to run.
By default, Flink scans its class path for a JAR with a Main-Class or program-class manifest entry and chooses it as the job class. Use this command line argument to manually set the job class. This argument is required in case that no or more than one JAR with such a manifest entry is available on the class path.
--job-id <job id>
(optional): Manually set a Flink job ID for the job (default: 00000000000000000000000000000000)
--fromSavepoint /path/to/savepoint
(optional): Restore from a savepoint
In order to resume from a savepoint, you also need to pass the savepoint path.
Note that /path/to/savepoint
needs to be accessible in all Docker containers of the cluster
(e.g., storing it on a DFS or from the mounted volume or adding it to the image).
--allowNonRestoredState
(optional): Skip broken savepoint state
Additionally you can specify this argument to allow that savepoint state is skipped which cannot be restored.
If the main function of the user job main class accepts arguments, you can also pass them at the end of the docker run
command.
Per-Job Mode is not supported by Flink on Docker.
Local deployment in the Session Mode has already been described in the Getting Started section above.
There are two distribution channels for the Flink Docker images:
apache/flink
(managed by the Flink developers)We recommend using the official images on Docker Hub, as they are reviewed by Docker. The images on apache/flink
are provided in case of delays in the review process by Docker.
Launching an image named flink:latest
will pull the latest image from Docker Hub. In order to use the images hosted in apache/flink
, replace flink
by apache/flink
. Any of the image tags (starting from Flink 1.11.3) are avaialble on apache/flink
as well.
The Flink Docker repository is hosted on Docker Hub and serves images of Flink version 1.2.1 and later. The source for these images can be found in the Apache flink-docker repository.
Images for each supported combination of Flink and Scala versions are available, and tag aliases are provided for convenience.
For example, you can use the following aliases:
flink:latest
→ flink:<latest-flink>-scala_<latest-scala>
flink:1.11
→ flink:1.11.<latest-flink-1.11>-scala_2.11
Note It is recommended to always use an explicit version tag of the docker image that specifies both the needed Flink and Scala
versions (for example flink:1.11-scala_2.12
).
This will avoid some class conflicts that can occur if the Flink and/or Scala versions used in the application are different
from the versions provided by the docker image.
Note Prior to Flink 1.5 version, Hadoop dependencies were always bundled with Flink.
You can see that certain tags include the version of Hadoop, e.g. (e.g. -hadoop28
).
Beginning with Flink 1.5, image tags that omit the Hadoop version correspond to Hadoop-free releases of Flink
that do not include a bundled Hadoop distribution.
When you run Flink image, you can also change its configuration options by setting the environment variable FLINK_PROPERTIES
:
$ FLINK_PROPERTIES="jobmanager.rpc.address: host
taskmanager.numberOfTaskSlots: 3
blob.server.port: 6124
"
$ docker run --env FLINK_PROPERTIES=${FLINK_PROPERTIES} flink:1.12.7-scala_2.11 <jobmanager|standalone-job|taskmanager>
The jobmanager.rpc.address
option must be configured, others are optional to set.
The environment variable FLINK_PROPERTIES
should contain a list of Flink cluster configuration options separated by new line,
the same way as in the flink-conf.yaml
. FLINK_PROPERTIES
takes precedence over configurations in flink-conf.yaml
.
The configuration files (flink-conf.yaml
, logging, hosts etc) are located in the /opt/flink/conf
directory in the Flink image.
To provide a custom location for the Flink configuration files, you can
either mount a volume with the custom configuration files to this path /opt/flink/conf
when you run the Flink image:
$ docker run \
--mount type=bind,src=/host/path/to/custom/conf,target=/opt/flink/conf \
flink:1.12.7-scala_2.11 <jobmanager|standalone-job|taskmanager>
or add them to your custom Flink image, build and run it:
FROM flink
ADD /host/path/to/flink-conf.yaml /opt/flink/conf/flink-conf.yaml
ADD /host/path/to/log4j.properties /opt/flink/conf/log4j.properties
Warning! The mounted volume must contain all necessary configuration files.
The flink-conf.yaml
file must have write permission so that the Docker entry point script can modify it in certain cases.
As described in the plugins documentation page: In order to use plugins they must be copied to the correct location in the Flink installation in the Docker container for them to work.
If you want to enable plugins provided with Flink (in the opt/
directory of the Flink distribution), you can pass the environment variable ENABLE_BUILT_IN_PLUGINS
when you run the Flink image.
The ENABLE_BUILT_IN_PLUGINS
should contain a list of plugin jar file names separated by ;
. A valid plugin name is for example flink-s3-fs-hadoop-1.12.7.jar
$ docker run \
--env ENABLE_BUILT_IN_PLUGINS=flink-plugin1.jar;flink-plugin2.jar \
flink:1.12.7-scala_2.11 <jobmanager|standalone-job|taskmanager>
There are also more advanced ways for customizing the Flink image.
To build a custom image which has Python and PyFlink prepared, you can refer to the following Dockerfile:
Note For base image flink:1.12.5 or above (which is based on Debian 11 in which Python has been updated to 3.9), Python 3 could be installed as following:
Build the image named as pyflink:latest:
Flink introduced jemalloc
as default memory allocator to resolve memory fragmentation problem (please refer to FLINK-19125).
You could switch back to use glibc
as memory allocator to restore the old behavior or if any unexpected memory consumption or problem observed
(and please report the issue via JIRA or mailing list if you found any), by setting environment variable DISABLE_JEMALLOC
as true:
$ docker run \
--env DISABLE_JEMALLOC=true \
flink:1.12.7-scala_2.11 <jobmanager|standalone-job|taskmanager>
There are several ways in which you can further customize the Flink image:
/opt/flink/opt
into /opt/flink/lib
or /opt/flink/plugins
/opt/flink/lib
(e.g. Hadoop)/opt/flink/plugins
You can customize the Flink image in several ways:
override the container entry point with a custom script where you can run any bootstrap actions.
At the end you can call the standard /docker-entrypoint.sh
script of the Flink image with the same arguments
as described in supported deployment modes.
The following example creates a custom entry point script which enables more libraries and plugins. The custom script, custom library and plugin are provided from a mounted volume. Then it runs the standard entry point script of the Flink image:
# create custom_lib.jar
# create custom_plugin.jar
$ echo "
# enable an optional library
ln -fs /opt/flink/opt/flink-queryable-state-runtime-*.jar /opt/flink/lib/
# enable a custom library
ln -fs /mnt/custom_lib.jar /opt/flink/lib/
mkdir -p /opt/flink/plugins/flink-s3-fs-hadoop
# enable an optional plugin
ln -fs /opt/flink/opt/flink-s3-fs-hadoop-*.jar /opt/flink/plugins/flink-s3-fs-hadoop/
mkdir -p /opt/flink/plugins/custom_plugin
# enable a custom plugin
ln -fs /mnt/custom_plugin.jar /opt/flink/plugins/custom_plugin/
/docker-entrypoint.sh <jobmanager|standalone-job|taskmanager>
" > custom_entry_point_script.sh
$ chmod 755 custom_entry_point_script.sh
$ docker run \
--mount type=bind,src=$(pwd),target=/mnt
flink:1.12.7-scala_2.11 /mnt/custom_entry_point_script.sh
extend the Flink image by writing a custom Dockerfile
and build a custom image:
FROM flink
RUN set -ex; apt-get update; apt-get -y install python
ADD /host/path/to/flink-conf.yaml /container/local/path/to/custom/conf/flink-conf.yaml
ADD /host/path/to/log4j.properties /container/local/path/to/custom/conf/log4j.properties
RUN ln -fs /opt/flink/opt/flink-queryable-state-runtime-*.jar /opt/flink/lib/.
RUN mkdir -p /opt/flink/plugins/flink-s3-fs-hadoop
RUN ln -fs /opt/flink/opt/flink-s3-fs-hadoop-*.jar /opt/flink/plugins/flink-s3-fs-hadoop/.
ENV VAR_NAME value
Commands for building:
$ docker build --tag custom_flink_image .
# optional push to your docker image registry if you have it,
# e.g. to distribute the custom image to your cluster
$ docker push custom_flink_image
Docker Compose is a way to run a group of Docker containers locally. The next sections show examples of configuration files to run Flink.
yaml
files with the container configuration, check examples for:
See also the Flink Docker image tags and how to customize the Flink Docker image for usage in the configuration files.
Launch a cluster in the foreground (use -d
for background)
$ docker-compose up
Scale the cluster up or down to N
TaskManagers
$ docker-compose scale taskmanager=<N>
Access the JobManager container
$ docker exec -it $(docker ps --filter name=jobmanager --format={{.ID}}) /bin/sh
Kill the cluster
$ docker-compose kill
Access Web UI
When the cluster is running, you can visit the web UI at http://localhost:8081. You can also use the web UI to submit a job to a Session cluster.
To submit a job to a Session cluster via the command line, you can either
use Flink CLI on the host if it is installed:
$ ./bin/flink run --detached --class ${JOB_CLASS_NAME} /job.jar
or copy the JAR to the JobManager container and submit the job using the CLI from there, for example:
$ JOB_CLASS_NAME="com.job.ClassName"
$ JM_CONTAINER=$(docker ps --filter name=jobmanager --format={{.ID}}))
$ docker cp path/to/jar "${JM_CONTAINER}":/job.jar
$ docker exec -t -i "${JM_CONTAINER}" flink run -d -c ${JOB_CLASS_NAME} /job.jar
Here, we provide the docker-compose.yml for Application Cluster.
Note: For the Application Mode cluster, the artifacts must be available in the Flink containers, check details here.
See also how to specify the JobManager arguments
in the command
for the jobmanager
service.
As well as the configuration file for Session Cluster:
The Docker swarm is a container orchestration tool, that allows you to manage multiple containers deployed across multiple host machines.
The following chapters contain examples of how to configure and start JobManager and TaskManager containers. You can adjust them accordingly to start a cluster. See also the Flink Docker image tags and how to customize the Flink Docker image for usage in the provided scripts.
The port 8081
is exposed for the Flink Web UI access.
If you run the swarm locally, you can visit the web UI at http://localhost:8081 after starting the cluster.
$ FLINK_PROPERTIES="jobmanager.rpc.address: flink-session-jobmanager
taskmanager.numberOfTaskSlots: 2
"
# Create overlay network
$ docker network create -d overlay flink-session
# Create the JobManager service
$ docker service create \
--name flink-session-jobmanager \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
--publish 8081:8081 \
--network flink-session \
flink:1.12.7-scala_2.11 \
jobmanager
# Create the TaskManager service (scale this out as needed)
$ docker service create \
--name flink-session-taskmanager \
--replicas 2 \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
--network flink-session \
flink:1.12.7-scala_2.11 \
taskmanager
$ FLINK_PROPERTIES="jobmanager.rpc.address: flink-jobmanager
taskmanager.numberOfTaskSlots: 2
"
# Create overlay network
$ docker network create -d overlay flink-job
# Create the JobManager service
$ docker service create \
--name flink-jobmanager \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
--mount type=bind,source=/host/path/to/job/artifacts,target=/opt/flink/usrlib \
--publish 8081:8081 \
--network flink-job \
flink:1.12.7-scala_2.11 \
standalone-job \
--job-classname com.job.ClassName \
[--job-id <job id>] \
[--fromSavepoint /path/to/savepoint [--allowNonRestoredState]] \
[job arguments]
# Create the TaskManager service (scale this out as needed)
$ docker service create \
--name flink-job-taskmanager \
--replicas 2 \
--env FLINK_PROPERTIES="${FLINK_PROPERTIES}" \
--mount type=bind,source=/host/path/to/job/artifacts,target=/opt/flink/usrlib \
--network flink-job \
flink:1.12.7-scala_2.11 \
taskmanager
The job artifacts must be available in the JobManager container, as outlined here.
See also how to specify the JobManager arguments to pass them
to the flink-jobmanager
container.
The example assumes that you run the swarm locally and expects the job artifacts to be in /host/path/to/job/artifacts
.
It also mounts the host path with the artifacts as a volume to the container’s path /opt/flink/usrlib
.