Nussknacker

Nussknacker lets you design, deploy and monitor real time decision algorithms with easy to use GUI.

For stateless use cases we provide lightweight, but scalable and performant engine deploying to Kubernetes.
When more advanced, stateful scenarios are needed we can leverage the power and reliability of Apache Flink
to make your processes fast and accurate.

See nussknacker.io to learn more.

Demo

Demo is available at demo.nussknacker.io

Documentation

Documentation is available at nussknacker.io/documentation.

Quickstart

If you want to see Nussknacker in action without any other dependencies, you can use embedded engine in Request-response mode (scenario logic is exposed with REST API), just run:

docker run -it --network host -e DEFAULT_SCENARIO_TYPE=request-response-embedded touk/nussknacker:latest

Be aware that some things (e.g. metrics) will not work, and this engine is not intended for production use.

If you want to follow step-by-step via more complex tutorials, based on production ready engines, read one of quickstart guides for: Streaming mode on Flink engine
or Streaming mode on Lite engine or Request-response mode on Lite engine

Contact

Talk to us on mailing list
or start a discussion

Scala compatibility

Currently, we do support Scala 2.12, we will cross publish when Flink supports Scala >= 2.13.

Flink compatibility

We currently support only one Flink version (more or less the latest one, please see flinkV in build.sbt).
However, it should be possible to run Nussknacker with older Flink version.

While we don't provide out-of-the-box
support as it would complicate the build process, there is separate repo
with detailed instructions how to run Nussknacker with some of the older versions.

Related projects

• nussknacker-quickstart - Repository with quick setup (docker-compose or helm) presenting typical usage of Nussknacker
• nussknacker-sample-components - Start here if you intend to create own Nussknacker components
• nussknacker-helm - Helm chart of the project
• nussknacker-flink-compatibility - Toolbox providing backward compatibility for older Flink's versions
• prinz-nussknacker - Nussknacker integration with ML models and model registries - currently supports mlflow, PMML (via JPMML) and H2O Java models
• nussknacker-benchmarks - micro and e2e benchmarks visualization

Contributing

Nussknacker is an open source project - contribution is welcome. Read how to do it in Contributing guide.
There you can also find out how to build and run development version of Nussknacker.

License

Nussknacker is published under Apache License 2.0.