Apache Flink TriggerSavepoint

Apache Flink TriggerSavepoint

Certified

Create a savepoint for a running Flink job

Requests a savepoint via the Flink REST API and waits for completion. Supports optional target directory, format type, and post-savepoint cancellation.

yaml
type: io.kestra.plugin.flink.TriggerSavepoint

Trigger savepoint with specific directory

yaml
id: create-savepoint
namespace: company.team

inputs:
  - id: jobId
    type: STRING
    required: true

tasks:
  - id: trigger-savepoint
    type: io.kestra.plugin.flink.TriggerSavepoint
    restUrl: "http://flink-jobmanager:8081"
    jobId: "{{ inputs.jobId }}"
    targetDirectory: "s3://flink/savepoints/backup/{{ execution.id }}"
    savepointTimeout: 300

# jobId must identify an existing Flink job and the Flink JobManager must be reachable.
# The cluster must support the target filesystem and have access permissions for this path.

Trigger savepoint with default directory

yaml
id: default-savepoint
namespace: company.team

inputs:
  - id: jobId
    type: STRING
    required: true

tasks:
  - id: trigger-savepoint
    type: io.kestra.plugin.flink.TriggerSavepoint
    restUrl: "http://flink-jobmanager:8081"
    jobId: "{{ inputs.jobId }}"

# jobId must identify an existing Flink job and the Flink JobManager must be reachable.
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-flink --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Job ID

ID of the Flink job to snapshot.

Flink REST API URL

Base URL of the Flink REST API (e.g., http://flink-jobmanager: 8081).

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultfalse

Cancel job after savepoint

Cancel the job after the savepoint completes; defaults to false.

DefaultCANONICAL

Format type

Savepoint format type: CANONICAL or NATIVE. Defaults to CANONICAL for broader compatibility.

Default300

Savepoint timeout

Maximum wait time for savepoint completion in seconds; defaults to 300.

Target directory

Target directory for the savepoint; falls back to the cluster default when omitted.

Job ID

ID of the Flink job for which the savepoint was created.

Request ID

Savepoint request ID used for status polling.

Savepoint path

Path returned by Flink for the created savepoint.