Hello Stellar

In this getting started doc, we’ll show working examples of using Stellar to execute a group of Repeatr and Rio processes.

Stellar lets you build pipelines of computations, connecting a series of steps by giving names to the Wares that should be passed between them; these steps get templated out into Repeatr Formulas and each run in dependency order.

Prerequisites

  • a linux kernel (we’re about to use linux containers).
  • either the timeless stack tool binaries, OR a go compiler to build them.

The host system requirements for running the core Timeless Stack tools is intentionally very, very small.

Demo Repo

https://github.com/polydawn/stellar-demo

The following sequence of commands should demonstrate some action:

git clone https://github.com/polydawn/stellar-demo
cd stellar-demo
git submodule update --init
stellar emerge

The result should be a quick run of a stellar demo.

  • This demo just runs one step,
  • getting some inputs from a stellar Catalog,
  • gets another input from “ingesting” it from the surrounding git repo,
  • and runs a formula.

A few things to note:

  • Since this uses a git ingest this is not a “replayable Module”.
  • The git submodule initialization command is not an inherent part of the system. We happen to be using git submodules to ship a catalog snapshot around for this example; but the Timeless Stack doesn’t know anything about the submodule here. It’s just a convenience, and you could (and should) replace it with something simpler that suits you when using stellar yourself.

Help us Improve

This document is currently a little terse :)

PRs to improve documentation are very welcome :)