You had one job, or more then one, which can be done in steps

Overview

Leprechaun

Codacy Badge Go Report Card Build Status codecov

Leprechaun is tool where you can schedule your recurring tasks to be performed over and over.

In Leprechaun tasks are recipes, lets observe simple recipe file which is written using YAML syntax.

File is located in recipes directory which can be specified in configs.ini configurational file. For all possible settings take a look here

By definition there are 3 types of recipes, the ones that can be scheduled, the others that can be hooked and last ones that use cron pattern for scheduling jobs, they are similiar regarding steps but have some difference in definition

First we will talk about scheduled recipes and they are defined like this:

name: job1 // name of recipe
definition: schedule // definition of which type is recipe
schedule:
	min: 0 // every min
	hour: 0 // every hour
	day: 0 // every day
steps: // steps are done from first to last
	- touch ./test.txt
	- echo "Is this working?" > ./test.txt
	- mv ./test.txt ./imwondering.txt

If we set something like this

schedule:
	min: 10 // every min
	hour: 2 // every hour
	day: 2 // every day

Task will run every 2 days 2 hours and 10 mins, if we put just days to 0 then it will run every 2 hours and 10 mins

name: job2 // name of recipe
definition: hook // definition of which type is recipe
id: 45DE2239F // id which we use to find recipe
steps:
	- echo "Hooked!" > ./hook.txt

Hooked recipe can be run by sending request to {host}:{port}/hook?id={id_of_recipe} on which Leprechaun server is listening, for example localhost:11400/hook?id=45DE2239F.

Recipes that use cron pattern to schedule tasks are used like this:

name: job3 // name of recipe
definition: cron // definition of which type is recipe
pattern: * * * * *
steps: // steps are done from first to last
	- touch ./test.txt
	- echo "Is this working?" > ./test.txt
	- mv ./test.txt ./imwondering.txt

Steps also support variables which syntax is $variable, and those are environment variables ex: $LOGNAME and in our steps it will be available as $LOGNAME. We can now rewrite our job file and it will look like something like this:

name: job1 // name of recipe
definition: schedule
schedule:
	min: 0 // every min
	hour: 0 // every hour
	day: 0 // every day
steps: // steps are done from first to last
	- echo "Is this working?" > $LOGNAME

Usage is very straightforward, you just need to start client and it will run recipes you defined previously.

Steps also can be defined as sync/async tasks which is defined by ->, but keep in mind that steps in recipes are performed by linear path because one that is not async can block other from performing, lets take this one as example

steps:
- -> ping google.com
- echo "I will not wait above task to perform, he is async so i will start immidiatelly"

but in this case for example first task will block performing on any task and all others will hang waiting it to finish

steps:
- ping google.com
- -> echo "I need to wait above step to finish, then i can do my stuff"

Step Pipe

Output from one step can be passed to input of next step:

name: job1 // name of recipe
definition: schedule
schedule:
	min: 0 // every min
	hour: 0 // every hour
	day: 0 // every day
steps: // steps are done from first to last
	- echo "Pipe this to next step" }>
	- cat > piped.txt

As you see, first step is using syntax }> at the end, which tells that this command output will be passed to next command input, you can chain like this how much you want.

Step Failure

Since steps are executed linear workers doesn't care if some of the commands fail, they continue with execution, but you get notifications if you did setup those configurations. If you want that workers stop execution of next steps if some command failes you can specifify it with ! like in example:

name: job1 // name of recipe
definition: schedule
schedule:
	min: 0 // every min
	hour: 0 // every hour
	day: 0 // every day
steps: // steps are done from first to last
	- ! echo "Pipe this to next step" }>
	- cat > piped.txt

If first step fails, recipe will fail and all other steps wont be executed

Remote step execution

Steps can be handled by your local machine using regular syntax, if there is any need that you want specific step to be executed by some remote machine you can spoecify that in step provided in example under, syntax is rmt:some_host, leprechaun will try to communicate with remote service that is configured on provided host and will run this command at that host.

name: job1 // name of recipe
definition: schedule
schedule:
	min: 0 // every min
	hour: 0 // every hour
	day: 0 // every day
steps: // steps are done from first to last
	- rmt:some_host echo "Pipe this to next step"

Note that also as regular step this step also can pipe output to next step, so something like this is possible also:

steps: // steps are done from first to last
	- rmt:some_host echo "Pipe this to next step" }>
	- rmt:some_other_host grep -a "Pipe" }>
	- cat > stored.txt

Installation

Go to leprechaun directory and run make install, you will need sudo privileges for this. This will install scheduler, cron, and webhook services.

To install remote service run make install-remote-service, this will create leprechaunrmt binary.

Build

Go to leprechaun directory and run make build. This will build scheduler, cron, and webhook services.

To build remote service run make build-remote-service, this will create leprechaunrmt binary.

Starting/Stopping services

To start leprechaun just simply run it in background like this : leprechaun &

For more available commands run leprechaun --help

Lepretools

For cli tools take a look here

Testing

To run tests with covarage make test, to run tests and generate reports run make test-with-report files will be generated in coverprofile dir. To test specific package run make test-package package=[name]

Issues
  • very good design ,but can give us more detail document to explain?

    very good design ,but can give us more detail document to explain?

    @kilgaloon has any detail document for quick start ?,i think why so few person stars is that the leprechaun is not friendly to users to teach them how to build schedule system with it. your readme is far from enough. I expect see the document as soon as possible.because i like the leprechaun.

    opened by zppro 5
  • Create help command to return available leprechaun commands and explanations

    Create help command to return available leprechaun commands and explanations

    socket.Registrator now has method Command where we specify commands for our app, extend command defining to provide description on how to use specific command.

    This will be used to display each command and description for it when command help is passed

    1.0.0-alpha client/cli enhancement good first issue help wanted 
    opened by kilgaloon 2
  • CreateWorkers should handle mutex lock/unlock

    CreateWorkers should handle mutex lock/unlock

    core good first issue hacktoberfest 
    opened by kilgaloon 2
  • Remove no need space & lines

    Remove no need space & lines

    What

    • Remove no need lines and spaces

    Why

    • Document will be greater
    opened by KeisukeYamashita 2
  • Development

    Development

    Embed logs to agent struct

    opened by kilgaloon 1
  • Recipe lock file should hold information about that recipe

    Recipe lock file should hold information about that recipe

    Use yml format inside *.lock file.

    Informations in file:

    • [ ] Started
    • [ ] Current step
    • [ ] Errors
    • [ ] ErrorMessage (empty if Errors != true)
    • [ ] Finished (If finished properly)

    If we implement this, we will know did recipe finished properly, next time we can know which recipes to push to queue and which not.

    This can take a Locking recipe functionality into considiration for change.

    Issues that can be affected: #30 #31

    client/recipes enhancement not backwards compatible 
    opened by kilgaloon 1
  • Decouple queue from client/server

    Decouple queue from client/server

    1.0.0-alpha core 
    opened by kilgaloon 1
  • Development

    Development

    opened by kilgaloon 1
  • Replace context package with golang context

    Replace context package with golang context

    2.0.0 
    opened by kilgaloon 2
  • Using Cobra/Viper

    Using Cobra/Viper

    Hi... i was reading the project and realized that parsing command line and configuration codes are in daemon/main.go file. How you think about separating daemon and project bootstrapping logic and use some packages like github.com/spf13/{cobra,viper}? thanks

    2.0.0 enhancement 
    opened by Hu13er 1
  • Command to read error log and tail error log

    Command to read error log and tail error log

    Introduce new command that read/tail error/info log

    Possible read commands:

    • leprechaun error-log
    • leprechaun info-log

    Possible tail commands:

    • leprechaun tail-error-log
    • leprechaun tail-info-log

    These commands will try to read global error and info logs if they are specified as global. Every service can have it's own error and info log so we should include default commands in agent for this:

    • leprechaun --cmd="{agent} error-log"
    • leprechaun --cmd="{agent} info-log"
    • leprechaun --cmd="{agent} tail-error-log"
    • leprechaun --cmd="{agent} tail-info-log"
    enhancement good first issue hacktoberfest help wanted 
    opened by kilgaloon 3
  • Refactor getters and omit

    Refactor getters and omit "Get" from methods

    2.0.0 good first issue help wanted 
    opened by kilgaloon 0
  • Terminal interface

    Terminal interface

    Terminal interface should provide all informations that are available also available through CLI.

    enhancement good first issue hacktoberfest help wanted 
    opened by kilgaloon 0
  • Creating homebrew formulae

    Creating homebrew formulae

    hacktoberfest help wanted 
    opened by kilgaloon 0
  • Web Interface

    Web Interface

    Web interface for managing:

    • [ ] Recipes
    • [ ] Status of agents
    core enhancement good first issue hacktoberfest 
    opened by kilgaloon 0
  • [TESTS] Benchmark

    [TESTS] Benchmark

    core nice to have 
    opened by kilgaloon 0
  • add systemd unit file

    add systemd unit file

    I have added very simple systemd unit file, please provide info where would you like it to be located in source tree as i put it now directly into root.

    pc:~ # systemctl start leprechaun.service 
    pc:~ # systemctl status leprechaun.service 
    ● leprechaun.service - Leprechaun service
       Loaded: loaded (/etc/systemd/system/leprechaun.service; disabled; vendor preset: disabled)
       Active: active (running) since Tue 2018-10-30 19:16:02 CET; 1s ago
     Main PID: 21163 (leprechaun)
        Tasks: 11 (limit: 4915)
       CGroup: /system.slice/leprechaun.service
               └─21163 /usr/bin/leprechaun
    
    Oct 30 19:16:02 pc.djule.org systemd[1]: Started Leprechaun service.
    pc:~ # 
    pc:~ # 
    
    opened by bmanojlovic 5
Releases(1.5.1)
Owner
Strahinja
Strahinja
Job worker service that provides an API to run arbitrary Linux processes.

Job Scheduler Summary Prototype job worker service that provides an API to run arbitrary Linux processes. Overview Library The library (Worker) is a r

Renato Guimarães 5 Jun 2, 2021
A persistent and flexible background jobs library for go.

Jobs Development Status Jobs is no longer being actively developed. I will still try my best to respond to issues and pull requests, but in general yo

Alex Browne 482 May 31, 2021
Efficient and reliable background processing for Go

CurlyQ CurlyQ provides a simple, easy-to-use interface for performing background processing in Go. It supports scheduled jobs, job deduplication, and

James McMath 112 Apr 25, 2021
You had one job, or more then one, which can be done in steps

Leprechaun Leprechaun is tool where you can schedule your recurring tasks to be performed over and over. In Leprechaun tasks are recipes, lets observe

Strahinja 83 Jul 10, 2021
A lightweight job scheduler based on priority queue with timeout, retry, replica, context cancellation and easy semantics for job chaining. Build for golang web apps.

Table of Contents Introduction What is RIO? Concern An asynchronous job processor Easy management of these goroutines and chaining them Introduction W

Supratim Samanta 36 Jul 7, 2021
Job scheduling made easy.

scheduler Job scheduling made easy. Scheduler allows you to schedule recurrent jobs with an easy-to-read syntax. Inspired by the article Rethinking Cr

Carles Cerezo Guzmán 368 Jul 10, 2021
Easy and fluent Go cron scheduling

goCron: A Golang Job Scheduling Package. goCron is a Golang job scheduling package which lets you run Go functions periodically at pre-determined inte

Go Co Op 952 Jul 22, 2021
goCron: A Golang Job Scheduling Package.

goCron: A Golang Job Scheduling Package.

辣椒面 2.6k Jul 22, 2021
gron, Cron Jobs in Go.

gron Gron provides a clear syntax for writing and deploying cron jobs. Goals Minimalist APIs for scheduling jobs. Thread safety. Customizable Job Type

roylee0704 863 Jul 20, 2021
Framework for performing work asynchronously, outside of the request flow

JobRunner JobRunner is framework for performing work asynchronously, outside of the request flow. It comes with cron to schedule and queue job functio

Bam Azizi 861 Jul 27, 2021
Simple, zero-dependency scheduling library for Go

go-quartz Simple, zero-dependency scheduling library for Go. About Inspired by the Quartz Java scheduler. Library building blocks Job interface. Any t

Eugene R. 145 Jul 10, 2021
A simple job scheduler backed by Postgres.

A simple job scheduler backed by Postgres used in production at https://operand.ai. Setup needs two environment variables, SECRET and ENDPOINT. The se

Morgan Gallant 6 May 31, 2021
Machinery is an asynchronous task queue/job queue based on distributed message passing.

Machinery Machinery is an asynchronous task queue/job queue based on distributed message passing. V2 Experiment First Steps Configuration Lock Broker

Richard Knop 5.4k Jul 20, 2021
cpuworker - A Customized Goroutine Scheduler over Golang Runtime

cpuworker Status Working in process. Run the Demo Make sure the GOMAXPROCS is bigger than 1 and there is at least GOMAXPROCS physical OS threads avail

Sen Han 15 Jul 14, 2021