orderly 0.2.0

A program for ordered re(start),stop and cleanup of processes.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# Orderly

**orderly** is a tool that provides ordered and controlled start, stop,
restart and cleanup of a group of processes. It aims to be a building
block for reliable servers/services/containers.

orderly draws inspiration from erlang supervisor trees, It provides
mechanisms to build a tree of supervised processes, and failure can
propagrate when process restarts rate exceeds a specified limit.

If this interests you, you can read the manual [here](man/orderly.1.md).

## Rationale

**orderly** was originally made to support reliable recovery of
inter-dependant services after failure on a runit based linux system. In
this configuration orderly runs beneath runit, providing grouping, left
to right start and right to left cleanup that runit lacks. This allows
for things like crashed fuse file systems to be cleanly unmounted and
recreated, where the unordered restarts of runit cause problems.

**orderly** also addresses some quality of life problems when developing
a group of servers. Generally when developing 'microservice' style
projects you are stopping and starting many processes that depend on
eachother. **orderly** makes this work easier, as a single terminal
window + ctrl+c is all that is needed to reliably kill/restart all your
services.

More complicated init systems like systemd support some of this
functionality, but not for these use cases, and only for systems that go
'all-in' with systemd. The project author is a fan of the openbsd
operating system for example, which does not even support systemd.

## Example

``` 
$ orderly -max-restart-tokens 2 -restart-tokens-per-second 0.1 -- \
  -name redis   -run ./run-redis -wait-started ./wait-redis  -- \
  -name website -run ./run-website -check ./health-check-website -cleanup ./website-cleanup 
```

For a full featured example with code, check the example directory.

## Building from source

[![builds.sr.ht
status](https://builds.sr.ht/~ach/orderly.svg)](https://builds.sr.ht/~ach/orderly?)

Orderly is a rust project, so running `cargo build` is sufficient for
most people after cloning the git repository.

## Installation

Binary packages are not yet provided.

The program can be installed from cargo with `cargo install orderly`

## Contact

Try the [mailing list](https://lists.sr.ht/~ach/orderly-dev)

Or create a [github
issue](https://github.com/andrewchambers/orderly/issues)

## Sponsors

This project was sponsored by [backupbox.io](https://backupbox.io)