Welcome¶
Welcome to the Punch product documentation for the Craig release.
why Craig ?
Craig Marvin Taborn, born February 20, 1970), is an American pianist, organist, keyboardist and composer. His piano style is based on a prodigious polyrhythmic intricacy as well as on counterpoints which are at times dense and at other times delicate and expansive. A writer compared his music to a witch-hazel tree that had not yet blossomed. Checkout this video.
Here is this piece of music that you can have and listen to, and enjoy. Some day it may blossom for you, and you may find that it gives you something that you may not even know you need.
Overview & Value Proposition¶
To go through the Punch rationale and understand its unique offering, start here:
- Understand the architectural patterns of data centric applications
- A tour of the various punch enablers
- Understand the forward engineering Punch team offering
Concepts¶
The Punchplatform relies on a few simple concepts. Together they enable you to design and run various kinds of processing logics : stream and batch computing, complex event processing, correlation and detection, machine learning algorithms, and more. This short chapter explains these core punchplatform concepts and ideas in details.
- Pipelines : the base processing units
- Channels : to combine pipelines into applications
- Services : to put in place the required administration tasks
- Tenants : to design a multi-tenant platform
- Platform : building, running, upgrading your system
Getting Started¶
The Punchplatform is freely available for testing. Simply download the standalone package from https://punchplatform.com, then follow the getting started chapter instructions. You will design, deploy and run complete data pipelines in minutes. You will then be ready to design your own use cases.
Reference Guide¶
The Punchplatform provides you with many building blocks, features and functions you can in turn assemble into higher level use cases. The reference guide provides detailed explanations for each component. This is the richest part of the documentation.
- Data movement : Streaming connectors
- Data processing : Punch programming language
- Data analytics : Spark & PML
- Data storage : Kafka, Ceph & Elasticsearch
- Data visualisation : Kibana & the punch plugin
- Security guide
- Platform services : Shiva & related services
- Complex event processing : Correlation & detection
Operations¶
The punch is designed to be production ready. This chapter provides instructions and guidances to best operate your platform, and provide helpful troubleshooting notes.
- Overview - channel configuration
- Platform deployment - devops activities
- Platform management - data engineer activities
- Platform monitoring - transversal activities
Contributions¶
Want to participate ? Welcome !