Foreman

It is a foreman implementation in GO.

Description

Foreman is a manager for Procfile-based applications. Its aim is to abstract away the details of the Procfile format, and allow you to run your services directly.

Features

• Run procfile-backed apps.
• Able to run with dependency resolution.

Procfile

Procfile is simply key: value format like:

app:
  cmd: ping -c 5 google.com 
  checks:
    cmd: sleep 1
  deps: 
      - redis
redis:
  cmd: redis-server --port 6010
  run_once: true
  checks:
    cmd: redis-cli -p 6010 ping

Here we defined two services app and redis with check commands and dependency matrix

How to use the package

• Get the package:

go get github.com/IslamWalid/foreman

• Package API:

Function	Description
func New(procfilePath string) (*Foreman, error)	Parses the given procfile in the procfilePath, builds and return a new foreman object.
func (f *Foreman) Start() error	Starts the services parsed from the procfile.
func (f *Foreman) Exit(exitStatus int)	Kill all the running services and their checkers, then exits the program with the given exit status.

Usage and Installation

• Install foreman

go install github.com/IslamWalid/foreman/cmd/foreman@latest

• Create the procfile with processes or services you want to run.

• Run ./Procfile in the current directory.

foreman

• Or pass a custom procfile path.

foreman -f <path_to_procfile>

• Use -v flag to run the program verbosely.