Note

The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.

Runit

From Funtoo
Revision as of 20:21, June 8, 2017 by Chry (talk | contribs)
Jump to navigation Jump to search

runit is a cross-platform Unix init scheme with service supervision, a replacement for sysvinit, and other init schemes. It can be used together with OpenRC as an alternative to sysvinit or replace OpenRC completely.

Installation

root # emerge -av sys-process/runit

Configuration over OpenRC

runit can be used as the system init. To do this, simply add init=/sbin/runit-init to the bootloader's kernel command-line and reboot. OpenRC (sysvinit) will remain installed and you go back to it at any time by reverting the change.

At this point, we are still somewhat relying on OpenRC. Because runit is very minimal, and unless you have all the boot/init scripts required, you should prefer this combo.

runit performs the system's booting, running and shutting down in 3 stages:

  • Stage 1:

runit starts /etc/runit/1 and waits for it to terminate. The system's one time initialization tasks are done here. /etc/runit/1 has full control over /dev/console to be able to start an emergency shell in case the one time initialization tasks fail.

  • Stage 2:

runit starts /etc/runit/2 which should not return until the system is going to halt or reboot; if it crashes, it will be restarted. Normally, /etc/runit/2 runs runsvdir.

  • Stage 3:

If runit is told to halt or reboot the system, or Stage 2 returns without errors, it terminates Stage 2 if it is running, and runs /etc/runit/3. The systems tasks to shutdown and halt or reboot are done here.

Now, let's configure Stage 1

   /etc/runit/1 - Stage 1 script file
#!/bin/sh
# system one time tasks

PATH=/sbin:/usr/sbin:/bin:/usr/bin

RUNLEVEL=S /sbin/rc sysinit
RUNLEVEL=S /sbin/rc boot
# We will add default runlevel here as well
RUNLEVEL=S /sbin/rc default

touch /etc/runit/stopit
chmod 0 /etc/runit/stopit

Now it's time to reboot...

It might look like OpenRC is running the whole thing during boot time, but once you log in and issue pstree you will see which init has started.

Let's check if our runit works. We will create a new service for it, and then write a script to run something.

user $  ls /etc/sv
   Tip

Feel free to study /etc/sv directory. This is where runit's services are.

By default, you should see only the list of getty-tty{1..6} If you run ls on either one of those, you will notice three items:

  1. run script - just a shell script that starts our service
  2. finish script - another shell script to end our service
  3. supervise directory - this directory contains access control settings for services

Now, let's make a service of our own...

root # mkdir /etc/sv/gpm
root # touch /etc/sv/gpm/run
   /etc/sv/gpm/run - An example of a run script for a gpm service
#!/bin/sh

exec 2>&1
source /etc/conf.d/gpm
exec gpm -D -m ${MOUSEDEV} -t ${MOUSE}

We have written the script, now let's make it +x (executable):

root # chmod a+x /etc/sv/gpm/run

And there is one more thing we must do... Even though our /etc/sv/ directory now contains an executable script to start a gpm service, runit will not be aware of this service until it's soft-linked to /etc/service/. Remember, the services can be present in the /etc/sv directory, runit will not be aware of them until they are linked. Now let's do this...

root # ln -sv /etc/sv/gpm /etc/service/
   Note

If you don't have the /etc/service/ directory, create one. This directory should only contain symbolic links to services in /etc/sv/. Since sys-process/runit installs getty-tty{1..6} services by default, up and running, you probably have this directory.