Skip to content

Kubernetes operator for managing the lifecycle of Apache Flink applications.

License

Notifications You must be signed in to change notification settings

kz33/flink-on-k8s-operator

 
 

Repository files navigation

Kubernetes Operator for Apache Flink

This is not an officially supported Google product.

Kubernetes Operator for Apache Flink is a control plane for running Apache Flink on Kubernetes.

Project Status

Alpha

The operator is under active development, backward compatibility of the APIs is not guaranteed for alpha releases.

Prerequisites

  • Version >= 1.9 of Kubernetes
  • Version >= 1.7 of Apache Flink

Overview

The Kubernetes Operator for Apache Flink extends the vocabulary (e.g., Pod, Service, etc) of the Kubernetes language with custom resource definition FlinkCluster and runs a controller Pod to keep watching the custom resources. Once a FlinkCluster custom resource is created and detected by the controller, the controller creates the underlying Kubernetes resources (e.g., JobManager Pod) based on the spec of the custom resource. With the operator installed in a cluster, users can then talk to the cluster through the Kubernetes API and Flink custom resources to manage their Flink clusters and jobs.

Features

  • Support for both Flink job cluster and session cluster depending on whether a job spec is provided
  • Custom Flink images
  • Flink and Hadoop configs and container environment variables
  • Init containers and sidecar containers
  • Remote job jar
  • Configurable access scope for JobManager service
  • Taking savepoints periodically
  • Taking savepoints on demand
  • Restarting failed job from the latest savepoint automatically
  • Cancelling job with savepoint
  • Cleanup policy on job success and failure
  • GCP integration (service account, GCE connector, networking)

Installation

The operator is still under active development, there is no Helm chart available yet, please follow the Developer Guide to build the operator and deploy it to your Kubernetes cluster.

Documentation

Contributing

Please check CONTRIBUTING.md and the Developer Guide out.

About

Kubernetes operator for managing the lifecycle of Apache Flink applications.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 93.3%
  • Shell 3.9%
  • Makefile 1.4%
  • Other 1.4%