logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

perp_intro.8 (3995B)

    

  1. .\" perp_intro.8
  2. .\" wcm, 2009.12.04 - 2013.01.09
  3. .\" ===
  4. .TH perp_intro 8 "January 2013" "perp-2.07" "persistent process supervision"
  5. .SH NAME
  6. perp_intro \- introduction to the perp service management framework
  7. .SH SYNOPSIS
  8. .I /etc/perp
  9. .SH DESCRIPTION
  10. .SS Purpose
  11. The
  12. .B perp
  13. service management framework provides a set of daemons and utilities to
  14. start, monitor, log, and control a collection of persistent processes.
  15. This document provides a basic overview of the system.
  16. Further details may be found in the manual pages as referenced.
  17. .SS Terms
  18. .TP
  19. ``persistent process''
  20. Any long-running program,
  21. normally intended to start at system boot
  22. and continue running until system shutdown.
  23. Also known and often described as a ``service''.
  24. A persistent process will normally provide some essential system service
  25. on-demand.
  26. Programs that service email, domain name queries, and http requests
  27. are examples of services that are normally run as persistent processes.
  28. .TP
  29. ``service definition''
  30. A service definition is
  31. the set of
  32. .BR perpetrate (5)
  33. runscripts and associated files that tell the
  34. .BR perpd (8)
  35. program how to start, run, and optionally log a service.
  36. The base directory for a collection of service definitions is normally
  37. .IR /etc/perp .
  38. The service definition for a particular service ``foo''
  39. will then be installed in the service definition directory
  40. .IR /etc/perp/foo .
  41. .TP
  42. ``service activation''
  43. A service definition may be installed and configured as summarized above,
  44. but does not become operative until it is specifically activated.
  45. An activated service is then recognized by the
  46. .BR perpd (8)
  47. scanner.
  48. Service activation is controlled by setting the
  49. .BR sticky (7)
  50. bit on the service definition directory.
  51. Setting the sticky bit activates the service,
  52. unsetting the sticky bit deactivates the service.
  53. The sticky bit is manipulated on the command line with the
  54. .BR chmod (1)
  55. utility,
  56. or with the
  57. .B A
  58. and
  59. .B X
  60. commands to the
  61. .BR perpctl (8)
  62. utility.
  63. .TP
  64. ``process supervisor''
  65. Some program, itself a persistent process,
  66. that starts and monitors another program to ensure its persistency.
  67. .SS Daemon Programs
  68. .TP
  69. .BR perpd (8)
  70. the principal daemon of a perp installation:
  71. service directory scanner, process supervisor, and service controller;
  72. normally operating on the service installation directory
  73. .I /etc/perp
  74. .TP
  75. .BR perpboot (8)
  76. recommended utility for starting
  77. .BR perpd (8)
  78. .SS Control Programs
  79. .TP
  80. .BR perp-setup (8)
  81. one-time post-installation configurator for initializing a
  82. .B perp
  83. system
  84. .TP
  85. .BR perpctl (8)
  86. administrative utility for runtime control of
  87. .BR perpd (8)
  88. .TP
  89. .BR perphup (8)
  90. rescan trigger utility for
  91. .BR perpd (8)
  92. .SS Query Programs
  93. .TP
  94. .BR perpls (8)
  95. perp service lister 
  96. .TP
  97. .BR perpstat (8)
  98. perp status reporter
  99. .TP
  100. .BR perpok (8)
  101. perp service checker
  102. .SS Logging Programs
  103. .TP
  104. .BR sissylog (8)
  105. log stdin to
  106. .BR syslog (3)
  107. .TP
  108. .BR tinylog (8)
  109. log stdin to directory of rotated logfiles
  110. .SH FILES
  111. The service installation directory
  112. .I /etc/perp
  113. will have the following layout:
  114. .TP
  115. .I /etc/perp
  116. base directory for service installation, monitored by
  117. .BR perpd (8)
  118. .TP
  119. .I /etc/perp/.boot
  120. configuration directory used by
  121. .BR perpboot (8)
  122. to start
  123. .BR perpd (8)
  124. .TP
  125. .IR /etc/perp/.control " [--> " /var/run/perp " ]"
  126. runtime control directory for the
  127. .I /etc/perp
  128. installation directory;
  129. normally a symlink to
  130. .I /var/run/perp
  131. .TP
  132. .I /etc/perp/foo
  133. .BR perpetrate (5)
  134. definition directory for some service ``foo'' under supervision of
  135. .BR perpd (8)
  136. .TP
  137. .I /etc/perp/foo/rc.log
  138. .BR perpetrate (5)
  139. optional runscript for starting/resetting a logger for service ``foo''
  140. .TP
  141. .I /etc/perp/foo/rc.main
  142. .BR perpetrate (5)
  143. required runscript for starting/resetting the service ``foo''
  144. .SH AUTHOR
  145. Wayne Marshall, http://b0llix.net/perp/
  146. .SH SEE ALSO
  147. .nh
  148. .BR perp-setup (8),
  149. .BR perpboot (8),
  150. .BR perpctl (8),
  151. .BR perpd (8),
  152. .BR perpetrate (5),
  153. .BR perphup (8),
  154. .BR perpls (8),
  155. .BR perpok (8),
  156. .BR perpstat (8),
  157. .BR sissylog (8),
  158. .BR tinylog (8)
  159. .\" EOF perp_intro.8