Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.51 KB

README.md

File metadata and controls

61 lines (37 loc) · 3.51 KB
Raw

Apache Flink Kubernetes Operator

A Kubernetes operator for Apache Flink, implemented in Java. It allows users to manage Flink applications and their lifecycle through native k8s tooling like kubectl.

Operator Overview

Documentation & Getting Started

Please check out the full documentation, hosted by the ASF, for detailed information and user guides.

Check our quick-start guide for simple setup instructions to get you started with the operator.

Features at a glance

  • Deploy and monitor Flink Application, Session and Job deployments
  • Upgrade, suspend and delete deployments
  • Full logging and metrics integration
  • Flexible deployments and native integration with Kubernetes tooling
  • Flink Job Autoscaler

For the complete feature-set please refer to our documentation.

Project Status

Project status: Production Ready

Current API version: v1beta1

To download the latest stable version please visit the Flink Downloads Page. The official operator images are also available on Dockerhub.

Please check out our docs to read about the upgrade process and our backward compatibility guarantees.

Support

Don’t hesitate to ask!

Contact the developers and community on the mailing lists if you need any help.

Open an issue if you found a bug in Flink.

Contributing

You can learn more about how to contribute in the Apache Flink website. For code contributions, please read carefully the Contributing Code section for an overview of ongoing community work.

License

The code in this repository is licensed under the Apache Software License 2.

ShareChat's fork

We maintain our own fork of Flink Kubernetes Operator according to the following rules:

  • ShareChat's main branch is main-sharechat
  • When proposing changes, we create branch from main-sharechat and make pull request with the base = main-sharechat
  • All pull request must have [ShareChat] prefix in the title so it gets passed to the corresponding commit in the main-sharechat branch
  • When new release of upstream Flink Kubernetes Operator is released, we create branch with the name release-sharechat-xxx starting from the corresponding release-xxx of the upstream operator
  • Once branch is created, we cherry-pick all the commits marked as [ShareChat] from main-sharechat
  • After that, we tag the last commit in the release branch by release-sharechat-xxx tag

After that, to push the image to GCR, this TeamCity build config should be used.