Skip to content

Overview

Abstract

The punchplatform provides its users with very few concepts to understand and a minimal set of commands to learn. This chapter provides a quick overview of everything you need to understand. Dedicated chapters provides more detailed informations on each topic.

Every data processing pipeline, every administrative task is defined as part of a tenant. In each tenant, you further organize your processing units into channels. A channel is a set of data processing pipelines, possibly made up from several pieces : storm topologies, spark jobs, shiva tasks etc.. You act upon a channel using single commands : start, stop, reload. Channels may also contain administrative tasks to provide you with your data lifecycle configuration.

Your channels are stored in a REST-like file tree folder. Here is an example with one tenant and two channels:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    punchplatform.properties
    mytenant/
        channels/
            admin/
                channel_structure.json
                ...
            apache_httpd/
                channel_structure.json
                ...
        etc/
            conf.json
  • punchplatform.properties : contains the complete description of your platform. This is a platform level configuration file that is used by all tenants.
  • channel_structure.json : each channel is described by this file. It lists the various pieces your channels are composed of.
  • conf.json : this is a per-tenant configuration file. There are defined a few configuration properties defined for each of your tenant.