View Source Overview

Skitter is a distributed stream processing framework written in Elixir which enables the creation of scalable, distributed stream processing applications. Unique to Skitter is its ability to control how the various operations which constitute a stream processing application are distributed at runtime.

These pages serve as the main documentation for Skitter users. They consist of three main parts, which can be accessed from the top of the sidebar.

  • The manual: this is the section of the docs you are currently browsing. It is a collection of guides which document how to get started with Skitter. We recommend first-time users to read through most pages in this manual to get familiar with Skitter.

  • The modules section: the pages in this section contain the detailed documentation of the API offered by Skitter. Various pages in the manual will link to the pages in this section of the documentation. We recommend to browse these pages on an as-needed basis.

  • The mix tasks section: the pages in this section document the mix tasks defined by Skitter. Mix is the build tool used by Elixir. Mix tasks are small command line programs which are used to extend the functionality of mix. We recommend browsing these pages only when needed.

The remainder of this manual is, itself, divided into several parts:

  • The getting started pages include this page and the installation instructions. They are intended to help you install Skitter, create your first Skitter application and execute it.

  • The concepts pages explain the various language constructs introduced by Skitter and how they are used to define a distributed stream processing application. These pages form the main part of this manual.

  • The deployment pages document how Skitter applications are deployed over a cluster and how they are configured. These pages can be skipped until you are ready to run your application in a distributed setting.

  • The guides pages document various niche aspects of Skitter. These should only need be read when needed.

Throughout this manual, some knowledge of Elixir is assumed. The official guide and the official recommended resources are great places to familiarise yourself with Elixir if needed.