Cromtit

Crontab (and more) for your Tomtit scenarios

"What's in a name?"

Cromtit = Cro(ntab) + Tomtit

Features

• Run Tomtit jobs as cron jobs

• Job dependencies

• Asynchronous jobs queue

• Throttling to protect a system from overload (TBD)

• View job logs and reports via cro app web interface

Install

Cromtit uses Sparky as job runner engine, so please install and configure Sparky first:

1. Install Sparky

Now, all you need is to starts Cromtit web api:

1. Install Cromtit

git clone https://github.com/melezhik/Cromtit.git
cd Cromtit
zef install . --/test

Configure

Create ~/cromtit.yaml file, see Projects configuration section.

Once a configuration file is created, apply changes:

cromt

~/cromtit.yaml specification

~/cromtit.yaml should contain a list of Tomtit projects:

# list of Tomtit projects
projects:
  rakudo:
    path: ~/projects/rakudo
    crontab: '30 * * * *'
    action: install
    options: --dump_task --env=dev
    vars:
      foo: 1
      bar: 2
  r3:
    path: ~/projects/r3tool
    crontab: '30 * * * *'
    action: install

Project specific configuration

Every project item has a specific configuration:

rakudo:
  # run `tom install`
  # every one hour
  crontab: '30 * * * *'
  action: install
  options: --no_index_update

Key

Key should define a unique project name.

Crontab

Should represents crontab entry (how often and when to run a project), should follow Sparky crontab format. Optional. If not set, implies manual run.

Action

Should define name of tomtit scenario that will be run. Required.

Multiple actions could be set as a space separated string:

# will trigger `tom pull` && `tom build` && `tom install`
action: pull build install

options

Tomtit cli options. Optional

vars

Additional environment variables get passed to a job. Optional

Job Dependencies

Projects might have dependencies, so that some jobs might be run before or after a project's job:

projects:
  database:
    path: ~/projects/database

  web-test:
    path: ~/projects/web-test
    action: run
    before:
      - name: database
        action: spinoff
        vars:
          db_name: test
          db_user: test
          db_password: pass
    after:
      - name: database
        action: remove
        vars:
          db_name: test

So before and after are list of objects that accept following parameters:

name

Project name. Required

action

See project action job. Optional

vars

See project job vars. Optional

Nested Dependencies

Nested dependencies are allowed, so a dependency might another dependency, so on.

Just be cautious about cycles. This should be directed acycling dependency graph.

Configuration file example

You can find a configuration file example at examples/ directory

Web console

Sparky exposes a web UI to track projects, cron jobs and reports:

http://127.0.0.1:4000

Thanks to

God and Christ as "For the LORD gives wisdom; from his mouth come knowledge and understanding."