This documentation is for an unreleased version of Apache Flink. We recommend you use the latest stable version.

Upgrading Applications and Flink Versions #

Flink DataStream programs are typically designed to run for long periods of time such as weeks, months, or even years. As with all long-running services, Flink streaming applications need to be maintained, which includes fixing bugs, implementing improvements, or migrating an application to a Flink cluster of a later version.

This document describes how to update a Flink streaming application and how to migrate a running streaming application to a different Flink cluster.

API compatibility guarantees #

The classes & members of the Java/Scala APIs that are intended for users are annotated with the following stability annotations:

• Public
• PublicEvolving
• Experimental

Annotations on a class also apply to all members of that class, unless otherwise annotated.

Any API without such an annotation is considered internal to Flink, with no guarantees being provided.

An API that is source compatible means that code written against the API will continue to compile against a later version.
An API that is binary compatible means that code compiled against the API will continue to run against a later version.

This table lists the source / binary compatibility guarantees for each annotation when upgrading to a particular release:

Example Consider the code written against a Public API in 1.15.2:

• The code can continue to run when upgrading to Flink 1.15.3 without recompiling, because patch version upgrades for Public APIs guarantee binary compatibility.
• The same code may have to be recompiled when upgrading from 1.15.x to 1.16.0, because minor version upgrades for Public APIs only provide source compatibility, not binary compatibility.
• Code change may be required when upgrading from 1.x to 2.x because major version upgrades for Public APIs provide neither source nor binary compatibility.

Consider the code written against a PublicEvolving API in 1.15.2:

• The code can continue to run when upgrading to Flink 1.15.3 without recompiling, because patch version upgrades for PublicEvolving APIs guarantee binary compatibility.
• A code change may be required when upgrading from 1.15.x to Flink 1.16.0, because minor version upgrades for PublicEvolving APIs provide neither source nor binary compatibility.

Deprecated API Migration Period #

When an API is deprecated, it is marked with the @Deprecated annotation and a deprecation message is added to the Javadoc. According to FLIP-321, starting from release 1.18, each deprecated API will have a guaranteed migration period depending on the API stability level:

The source code of a deprecated API will be kept for at least the guaranteed migration period, and may be removed at any point after the migration period has passed.

Example Assuming a release sequence of 1.18, 1.19, 1.20, 2.0, 2.1, …, 3.0,

• if a Public API is deprecated in 1.18, it will not be removed until 2.0.
• if a Public API is deprecated in 1.20, the source code will be kept in 2.0 because the migration period is 2 minor releases. Also, because a Public API must maintain source compatibility throughout a major version, the source code will be kept for all the 2.x versions and removed in 3.0 at the earliest.
• if a PublicEvolving API is deprecated in 1.18, it will be removed in 1.20 at the earliest.
• if a PublicEvolving API is deprecated in 1.20, the source code will be kept in 2.0 because the migration period is 1 minor releases. The source code may be removed in 2.1 at the earliest.
• if an Experimental API is deprecated in 1.18.0, the source code will be kept for 1.18.1 and removed in 1.18.2 at the earliest. Also, the source code can be removed in 1.19.0.

Please check the FLIP-321 wiki for more details.

Restarting Streaming Applications #

The line of action for upgrading a streaming application or migrating an application to a different cluster is based on Flink’s Savepoint feature. A savepoint is a consistent snapshot of the state of an application at a specific point in time.

There are two ways of taking a savepoint from a running streaming application.

• Taking a savepoint and continue processing.

> ./bin/flink savepoint <jobID> [pathToSavepoint]

It is recommended to periodically take savepoints in order to be able to restart an application from a previous point in time. If you want to trigger a savepoint in detached mode, just add the option -detached.

• Taking a savepoint and stopping the application as a single action.

> ./bin/flink cancel -s [pathToSavepoint] <jobID>

This means that the application is canceled immediately after the savepoint completed, i.e., no other checkpoints are taken after the savepoint.

Given a savepoint taken from an application, the same or a compatible application (see Application State Compatibility section below) can be started from that savepoint. Starting an application from a savepoint means that the state of its operators is initialized with the operator state persisted in the savepoint. This is done by starting an application using a savepoint.

> ./bin/flink run -d -s [pathToSavepoint] ~/application.jar

The operators of the started application are initialized with the operator state of the original application (i.e., the application the savepoint was taken from) at the time when the savepoint was taken. The started application continues processing from exactly this point on.

Note: Even though Flink consistently restores the state of an application, it cannot revert writes to external systems. This can be an issue if you resume from a savepoint that was taken without stopping the application. In this case, the application has probably emitted data after the savepoint was taken. The restarted application might (depending on whether you changed the application logic or not) emit the same data again. The exact effect of this behavior can be very different depending on the SinkFunction and storage system. Data that is emitted twice might be OK in case of idempotent writes to a key-value store like Cassandra but problematic in case of appends to a durable log such as Kafka. In any case, you should carefully check and test the behavior of a restarted application.

Application State Compatibility #

When upgrading an application in order to fix a bug or to improve the application, usually the goal is to replace the application logic of the running application while preserving its state. We do this by starting the upgraded application from a savepoint which was taken from the original application. However, this does only work if both applications are state compatible, meaning that the operators of upgraded application are able to initialize their state with the state of the operators of original application.

In this section, we discuss how applications can be modified to remain state compatible.

DataStream API #

Matching Operator State #

When an application is restarted from a savepoint, Flink matches the operator state stored in the savepoint to stateful operators of the started application. The matching is done based on operator IDs, which are also stored in the savepoint. Each operator has a default ID that is derived from the operator’s position in the application’s operator topology. Hence, an unmodified application can always be restarted from one of its own savepoints. However, the default IDs of operators are likely to change if an application is modified. Therefore, modified applications can only be started from a savepoint if the operator IDs have been explicitly specified. Assigning IDs to operators is very simple and done using the uid(String) method as follows:

val mappedEvents: DataStream[(Int, Long)] = events
  .map(new MyStatefulMapFunc()).uid("mapper-1")

Note: Since the operator IDs stored in a savepoint and IDs of operators in the application to start must be equal, it is highly recommended to assign unique IDs to all operators of an application that might be upgraded in the future. This advice applies to all operators, i.e., operators with and without explicitly declared operator state, because some operators have internal state that is not visible to the user. Upgrading an application without assigned operator IDs is significantly more difficult and may only be possible via a low-level workaround using the setUidHash() method.

Important: As of 1.3.x this also applies to operators that are part of a chain.

By default all state stored in a savepoint must be matched to the operators of a starting application. However, users can explicitly agree to skip (and thereby discard) state that cannot be matched to an operator when starting a application from a savepoint. Stateful operators for which no state is found in the savepoint are initialized with their default state. Users may enforce best practices by calling ExecutionConfig#disableAutoGeneratedUIDs which will fail the job submission if any operator does not contain a custom unique ID.

Stateful Operators and User Functions #

When upgrading an application, user functions and operators can be freely modified with one restriction. It is not possible to change the data type of the state of an operator. This is important because, state from a savepoint can (currently) not be converted into a different data type before it is loaded into an operator. Hence, changing the data type of operator state when upgrading an application breaks application state consistency and prevents the upgraded application from being restarted from the savepoint.

Operator state can be either user-defined or internal.

• User-defined operator state: In functions with user-defined operator state the type of the state is explicitly defined by the user. Although it is not possible to change the data type of operator state, a workaround to overcome this limitation can be to define a second state with a different data type and to implement logic to migrate the state from the original state into the new state. This approach requires a good migration strategy and a solid understanding of the behavior of key-partitioned state.

• Internal operator state: Operators such as window or join operators hold internal operator state which is not exposed to the user. For these operators the data type of the internal state depends on the input or output type of the operator. Consequently, changing the respective input or output type breaks application state consistency and prevents an upgrade. The following table lists operators with internal state and shows how the state data type relates to their input and output types. For operators which are applied on a keyed stream, the key type (KEY) is always part of the state data type as well.

Application Topology #

Besides changing the logic of one or more existing operators, applications can be upgraded by changing the topology of the application, i.e., by adding or removing operators, changing the parallelism of an operator, or modifying the operator chaining behavior.

When upgrading an application by changing its topology, a few things need to be considered in order to preserve application state consistency.

• Adding or removing a stateless operator: This is no problem unless one of the cases below applies.
• Adding a stateful operator: The state of the operator will be initialized with the default state unless it takes over the state of another operator.
• Removing a stateful operator: The state of the removed operator is lost unless another operator takes it over. When starting the upgraded application, you have to explicitly agree to discard the state.
• Changing of input and output types of operators: When adding a new operator before or behind an operator with internal state, you have to ensure that the input or output type of the stateful operator is not modified to preserve the data type of the internal operator state (see above for details).
• Changing operator chaining: Operators can be chained together for improved performance. When restoring from a savepoint taken since 1.3.x it is possible to modify chains while preserving state consistency. It is possible a break the chain such that a stateful operator is moved out of the chain. It is also possible to append or inject a new or existing stateful operator into a chain, or to modify the operator order within a chain. However, when upgrading a savepoint to 1.3.x it is paramount that the topology did not change in regards to chaining. All operators that are part of a chain should be assigned an ID as described in the Matching Operator State section above.

Table API & SQL #

Due to the declarative nature of Table API & SQL programs, the underlying operator topology and state representation are mostly determined and optimized by the table planner.

Be aware that any change to both the query and the Flink version could lead to state incompatibility. Every new major-minor Flink version (e.g. 1.12 to 1.13) might introduce new optimizer rules or more specialized runtime operators that change the execution plan. However, the community tries to keep patch versions state-compatible (e.g. 1.13.1 to 1.13.2).

See the table state management section for more information.

Upgrading the Flink Framework Version #

This section describes the general way of upgrading Flink across versions and migrating your jobs between the versions.

In a nutshell, this procedure consists of 2 fundamental steps:

1. Take a savepoint in the previous, old Flink version for the jobs you want to migrate.
2. Resume your jobs under the new Flink version from the previously taken savepoints.

Besides those two fundamental steps, some additional steps can be required that depend on the way you want to change the Flink version. In this guide we differentiate two approaches to upgrade across Flink versions: in-place upgrade and shadow copy upgrade.

For in-place update, after taking savepoints, you need to:

1. Stop/cancel all running jobs.
2. Shutdown the cluster that runs the old Flink version.
3. Upgrade Flink to the newer version on the cluster.
4. Restart the cluster under the new version.

For shadow copy, you need to:

1. Before resuming from the savepoint, setup a new installation of the new Flink version besides your old Flink installation.
2. Resume from the savepoints with the new Flink installation.
3. If everything runs ok, stop and shutdown the old Flink cluster.

In the following, we will first present the preconditions for successful job migration and then go into more detail about the steps that we outlined before.

Preconditions #

Before starting the migration, please check that the jobs you are trying to migrate are following the best practices for savepoints.

In particular, we advise you to check that explicit uids were set for operators in your job.

This is a soft precondition, and restore should still work in case you forgot about assigning uids. If you run into a case where this is not working, you can manually add the generated legacy vertex ids from previous Flink versions to your job using the setUidHash(String hash) call. For each operator (in operator chains: only the head operator) you must assign the 32 character hex string representing the hash that you can see in the web ui or logs for the operator.

Besides operator uids, there are currently two hard preconditions for job migration that will make migration fail:

1. We do not support migration for state in RocksDB that was checkpointed using semi-asynchronous mode. In case your old job was using this mode, you can still change your job to use fully-asynchronous mode before taking the savepoint that is used as the basis for the migration.

2. Another important precondition is that all the savepoint data must be accessible from the new installation under the same (absolute) path. This also includes access to any additional files that are referenced from inside the savepoint file (the output from state backend snapshots), including, but not limited to additional referenced savepoints from modifications with the State Processor API.

STEP 1: Stop the existing job with a savepoint #

The first major step in version migration is taking a savepoint and stopping your job running on the old Flink version.

You can do this with the command:

$ bin/flink stop [--savepointPath :savepointPath] :jobId

If you want to trigger the savepoint in detached mode, add option -detached to the command.

For more details, please read the savepoint documentation.

STEP 2: Update your cluster to the new Flink version. #

In this step, we update the framework version of the cluster. What this basically means is replacing the content of the Flink installation with the new version. This step can depend on how you are running Flink in your cluster (e.g. standalone, …).

If you are unfamiliar with installing Flink in your cluster, please read the deployment and cluster setup documentation.

STEP 3: Resume the job under the new Flink version from savepoint. #

As the last step of job migration, you resume from the savepoint taken above on the updated cluster. You can do this with the command:

$ bin/flink run -s :savepointPath [:runArgs]

For more details, please take a look at the savepoint documentation.

Compatibility Table #

Savepoints are compatible across Flink versions as indicated by the table below:

Please refer to the last Compatibility Table for the savepoint compatibility information of older Flink versions.

Back to top