nifikop

README

NiFiKop

You can access to the full documentation on the NiFiKop Documentation

The Orange NiFi operator is a Kubernetes operator to automate provisioning, management, autoscaling and operations of Apache NiFi clusters deployed to K8s.

Overview

Apache NiFi is an open-source solution that supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. Some of the high-level capabilities and objectives of Apache NiFi include, and some of the main features of the NiFiKop are:

• Fine grained node configuration support
• Graceful rolling upgrade
• graceful NiFi cluster scaling
• encrypted communication using SSL
• the provisioning of secure NiFi clusters
• Advanced Dataflow and user management via CRD

Some of the roadmap features :

• Monitoring via Prometheus
• Automatic reaction and self healing based on alerts (plugin system, with meaningful default alert plugins)
• graceful NiFi cluster scaling and rebalancing

Motivation

At Orange we are building some Kubernetes operator, that operate NiFi and Cassandra clusters (among other types) for our business cases.

There are already some approaches to operating NiFi on Kubernetes, however, we did not find them appropriate for use in a highly dynamic environment, nor capable of meeting our needs.

• Helm chart
• Cloudera Nifi Operator

Finally, our motivation is to build an open source solution and a community which drives the innovation and features of this operator.

Installation

To get up and running quickly, check our Getting Started page

Development

Checkout out the Developer page

Features

Check out the Supported Features Page

Issues, feature requests and roadmap

Please note that the NiFi operator is constantly under development and new releases might introduce breaking changes. We are striving to keep backward compatibility as much as possible while adding new features at a fast pace. Issues, new features or bugs are tracked on the projects GitHub page - please feel free to add yours!

To track some of the significant features and future items from the roadmap please visit the roadmap doc.

Contributing

If you find this project useful here's how you can help:

• Send a pull request with your new features and bug fixes
• Help new users with issues they may encounter
• Support the development of this project and star this repo!

Community

If you have any questions about the NiFi operator, and would like to talk to us and the other members of the community, please join our Slack.

If you find this project useful, help us:

• Support the development of this project and star this repo! ⭐
• If you use the Nifi operator in a production environment, add yourself to the list of production adopters. 🤘
  
• Help new users with issues they may encounter 💪
• Send a pull request with your new features and bug fixes 🚀

Credits

• Operator implementation based on banzaicloud/kafka-operator
• NiFi kubernetes setup configuration inspired from cetic/helm-nifi
• Implementation is based on Operator SDK

License

Copyright (c) 2020 Orange, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.