Reindent to more 'pure' Markdown and remove fixed event lib TODO.

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
Joachim Nilsson committed 2015-01-19 21:24:06 +01:00
1 parent c2ea2c1193
commit 7aa687bad9
1 file changed
+42 -50
+42 -50
View File
@@ -3,13 +3,13 @@ Goals of Finit
The intent of finit is to monitor not just processes, but to supervise The intent of finit is to monitor not just processes, but to supervise
an entire system and the behavior of certain processes that declare an entire system and the behavior of certain processes that declare
themselves to be finit compliant. Similiar to launchd, the goal of themselves to be finit compliant. Similar to launchd, the goal of
finit is to be a replacement for: finit is to be a replacement for:
* init * init
* inetd * inetd
* crond * crond
* watchdogd * watchdogd
A small and simple replacement, primarily for embedded systems, with a A small and simple replacement, primarily for embedded systems, with a
very low dependency on external packages. very low dependency on external packages.
@@ -17,26 +17,18 @@ very low dependency on external packages.
General General
------- -------
* Integrate libev, or libuEv, to handle events: signals, I/O, etc. * Add support for `init <q | reload-configuration>` and `SIGHUP` to
have finit reload its `finit.conf`, but also
"Event driven software improves concurrency" -- Dave Zarzycki, Apple * Add support for inotify to automatically reload `finit.conf`
* Implement `initctl stop|start|restart|reload|status <SVC>` and
See the [launchd video](http://www.youtube.com/watch?v=cD_s6Fjdri8) `service <SVC> stop|start|restart|reload|status` on top
for more info! * Add PRE and POST hooks for when switching between runlevels
* Add support for `init -v,--version | version`
See uftpd for how libuEv can be easily integrated as a submodule. * Cleanup move sources from top-level directory to `src/` and `include/`
* Add support for `init <q | reload-configuration>` and `SIGHUP` to * Make sure to install `queue.h` to `$(PREFIX)/include/finit/queue.h`
have finit reload its `finit.conf`, but also * Move `finit.conf` "check" command to plugin which checks `/etc/fstab`
* Add support for inotify to automatically reload `finit.conf` instead. This is the de-facto practice. But keep the check command
* Implement `initctl stop|start|restart|reload|status <SVC>` and for really low-end systems w/o `/etc/fstab`.
`service <SVC> stop|start|restart|reload|status` on top
* Add PRE and POST hooks for when switching between runlevels
* Add support for `init -v,--version | version`
* Cleanup move sources from top-level directory to `src/` and `include/`
* Make sure to install `queue.h` to `$(PREFIX)/include/finit/queue.h`
* Move `finit.conf` "check" command to plugin which checks `/etc/fstab`
instead. This is the de-facto practice. But keep the check command
for really low-end systems w/o `/etc/fstab`.
Init Init
@@ -45,7 +37,7 @@ Init
Finit in itself is not SysV Init compatible, it doesn't use `/etc/rc.d` Finit in itself is not SysV Init compatible, it doesn't use `/etc/rc.d`
and `/etc/inet.d` scripts to boot the system. However, a plausible way and `/etc/inet.d` scripts to boot the system. However, a plausible way
to achieve compatibility would be to add a plugin to finit which reads to achieve compatibility would be to add a plugin to finit which reads
`/etc/inittab` and starts standard Linux systems. `/etc/inittab` to be able to start standard Linux systems.
Inetd Inetd
@@ -65,7 +57,7 @@ to each inetd service. When a client connects the finit will call the
callback with a `struct in_pktinfo` argument which the callback then can callback with a `struct in_pktinfo` argument which the callback then can
allowed or deny. allowed or deny.
Alternatively, borrowing from TCP wrappers by Wietse Wenema, a set of Alternatively, borrowing from TCP wrappers by Wietse Venema, a set of
`allow` and `deny` directives can be added to `finit.conf` to control `allow` and `deny` directives can be added to `finit.conf` to control
inetd services. It could be what IP addreses, networks or interfaces inetd services. It could be what IP addreses, networks or interfaces
are allowed to connect to the given inetd services. To start with the are allowed to connect to the given inetd services. To start with the
@@ -109,8 +101,8 @@ Crond
Requirements are quite rudimentary, basic cron functionality, mainly Requirements are quite rudimentary, basic cron functionality, mainly
system-level timed periodic tasks: system-level timed periodic tasks:
* Periodically run a task, in a matching runlevel * Periodically run a task, in a matching runlevel
* Optionally run as non-root (`crontab -e` as operator) * Optionally run as non-root (`crontab -e` as operator)
Proposed syntax: Proposed syntax:
@@ -139,35 +131,35 @@ Watchdog
Support for monitoring the health of the system and its processes. Support for monitoring the health of the system and its processes.
* Add support for a `/dev/watchdog` plugin to replace `watchdogd` * Add support for a `/dev/watchdog` plugin to replace `watchdogd`
* Integrate system supervisor to optionally reboot the system when a * Integrate system supervisor to optionally reboot the system when a
process stops responding, or when a respawn limit has been reached, process stops responding, or when a respawn limit has been reached,
as well as when system load gets too high. as well as when system load gets too high.
* API for processes to register with the watchdog. * API for processes to register with the watchdog.
- Deeper monitoring of a process main loop - Deeper monitoring of a process main loop
- If a process is not heard from within its subscribed period time - If a process is not heard from within its subscribed period time
reboot system or restart process. reboot system or restart process.
* Separate `/etc/watchdog.conf` configuration file, or a perhaps * Separate `/etc/watchdog.conf` configuration file, or a perhaps
support for `/etc/finit.d/PLUGIN.conf`? support for `/etc/finit.d/PLUGIN.conf`?
* Support enable/disable watchdog features: * Support enable/disable watchdog features:
- Supervise processes, - Supervise processes,
- CPU loadavg, - CPU loadavg,
- Watch for file descriptor leaks, - Watch for file descriptor leaks,
- etc. - etc.
Documentation Documentation
------------- -------------
* Write man pages for finit and `finit.conf`, steal from the excellent * Write man pages for finit and `finit.conf`, steal from the excellent
`pimd` man pages ... `pimd` man pages ...
* Update Debian `finit.conf` example with runlevels, `tty/console` and * Update Debian `finit.conf` example with runlevels, `tty/console` and
dependency handling for Debian 8 (the dreaded systemd release). dependency handling for Debian 8 (the dreaded systemd release).
Investigation Investigation
------------- -------------
* [FHS changes](http://askubuntu.com/questions/57297/why-has-var-run-been-migrated-to-run) * [FHS changes](http://askubuntu.com/questions/57297/why-has-var-run-been-migrated-to-run)
affecting runtime status, plugins, etc. affecting runtime status, plugins, etc.