haksell / taskmaster

Rustmaster

Description

Project is a simple implementation of taskmaster in Rust. It is a daemon that runs and monitors other programs. It is a simple copy of supervisor. The project is done using Vagrant virtual machine to be able to run it with sudo on school's PC.

Menu

• Run
• Client Commands
• Stop
• Config file

Run

---

Launch Virtual Machine

using Makefile

make vagrant

---

Run server

Daemonized server should be run with sudo

sudo make daemon

Debug server can be run without sudo:

make nodaemon

---

Run client

make client

List of possible client commands:

• help

• status - returns a list of programs with their statuses

• start - starts task by its name

• stop - stops task by its name

• restart - restarts task by its name

• config - returns a task configuration in json.

• tail can read last N lines of stdout and stderr of log files or stream them to the console

• shutdown - Shut the remote taskmasterd down
• exit && quit - Closes the CLI
• http - transfer logs via http
• update - Reloads the configuration tracking changes

• maintail - tail daemon logs

• signal - send signal to task process

---

Stop server

Stop daemonized server should be run with sudo

sudo make stop

Debug server can be stopped without sudo:

make stop

---

Clean

make clean

---

Config

Only cmd field is mandatory for config, for other they are default values

• cmd:

  • Type: string
  • Default value: No default value
  • Description: The command to use to launch the program

• num_procs:

  • Type: positive integer (not zero)
  • Default value: 1
  • Description: The number of processes to start and keep running

• umask:

  • Type: positive integer
  • Default value: 0o022
  • Description: An umask to set before launching the program

• working_dir:

  • Type: string
  • Default value: current dir
  • Description: A working directory to set before launching the program

• auto_start:

  • Type: boolean
  • Default value: true
  • Description: Whether to start this program at launch or not

• auto_restart:

  • Type: Autorestart enum
  • Default value: unexpected
  • Description: Specifies if taskmaster should automatically restart a process if it exits when it is in the RUNNING state.
  • Values: false, unexpected, or true

• exit_codes:

  • Type: Vector of positive integers (maybe change to set in the future)
  • Default value: [0]
  • Description: Defines which return codes represent an "expected" exit status

• start_retries:

  • Type: positive integer
  • Default value: 3
  • Description: How many times a restart should be attempted before aborting

• start_time:

  • Type: positive integer
  • Default value: 1
  • Description: How long the program should be running after it’s started for it to be considered "successfully started"

• stop_signal:

  • Type: Signal (e.g., integer or enum)
  • Default value: TERM
  • Description: Specifies which signal should be used to stop (i.e., exit gracefully) the program

• stop_time:

  • Type: positive integer
  • Default value: 10
  • Description: How long to wait after a graceful stop before killing the program

• stdout:

  • Type: string
  • Default value: None (need to decide, maybe /tmp/taskname.stdout)
  • Description: Options to discard the program’s standard output (stdout) or to redirect it to a file

• stderr:

  • Type: string
  • Default value: None (need to decide, maybe /tmp/taskname.stderr)
  • Description: Options to discard the program’s standard error (stderr) or to redirect it to a file

• env:

  • Type: Map of key-value pairs (String, String)
  • Default value: Empty
  • Description: Environment variables to set before launching the program