Browse Source

README: Document modular services

Efraim Flashner 2 years ago
committed by Shepherd
  1. 11


@ -3,3 +3,14 @@ This repo contains the files used to run shepherd services.
The `shepherd` and `cron` directories go in `.config`
The shell scripts sit in the home directory.
Working with Shepherd Services
Each service is stored in a separate file. This allows us to reload individual services without needing to restart all of the services in one go. In order to see which services are available run the command `herd status`. 'Started' services are currently running, 'Stopped' services are not running but are still loaded, and 'One-shot' are services which are not running but run a one-off script or service.
The services are setup so that they have code that is run when it is started and continues to run until it is stopped. Sometimes that code can call other shell scripts in the home directory. If the primary code in the service needs to be changed then the service needs to be reloaded in accordance to a process that will allow it to be reloaded without stopping all the other services. In our example the service is `foo` and it is located in a file `bar.scm`.
$ herd stop foo
$ herd load root .config/shepherd/init.d/bar.scm
The second command will load the code in `bar.scm` into `shepherd`, and if the service is configured to start automatically at startup it will start immediately. This process should not affect the other running services.