42-taskmaster

42 - Taskmaster

Services management and monitoring tool

About The Project

Taskmaster is a job control manager project for 42 school. It allows its users to control a number of processes on operating systems.

Inspired by the Supervisor

Prerequisites

Create a virtual environment using the following command:

• venv

  python3 -m venv venv && source venv/bin/activate
  

• pip

  pip install -r requirements.txt
  

or use the devcontainer provided in the repository.

Dependencies

• Python
• Cerberus # Provides data validation
• PyYAML # Provides YAML parsing and dumping

Installation

• From pypi

  pip install 42-taskmaster
  

• From source

  pip install .
  

Usage

• Without arguments (load taskmaster.yml from current directory)

  taskmaster
  

• With arguments

  taskmaster -f /path/to/config.yml
  

• Without install

  python -m taskmaster.taskmaster
  

Configuration file

email:  # Optionnal
 to: ""
 smtp_email: ""
 smtp_password: ""
 smtp_server: "smtp.gmail.com"
 smtp_port: 465

services:
  - name: sleep
    cmd: "sleep 100"
    numprocs: 8 # min 1 max 32
    umask: 077
    workingdir: /tmp
    autostart: true
    autorestart: unexpected # always, never unexpected
    exitcodes:
      - 0
      - 2
    startretries: 3
    starttime: 5
    stopsignal: USR1
    stoptime: 10
    env: # Optionnal
      test: "test"
    stdout: ./taskmaster.yml # Optionnal (if not present don't log)
    stderr: /workspaces/42-taskmaster/logs/taskmaster.log # Optionnal
    # user: aaaaa # Optionnal (Downgrade privileges)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

Nard Théo - GUI / Configuration

Lafay Timothée - Services management