mirror of
https://git.in.rschanz.org/ryan77627/guix.git
synced 2024-12-23 21:17:11 -05:00
services: shepherd: Define 'shepherd-configuration-action' helper.
* gnu/services/shepherd.scm (shepherd-configuration-action): New * doc/guix.texi (Shepherd Services): Document it.
This commit is contained in:
parent
ff00cdcd92
commit
ebc7de6a1e
2 changed files with 45 additions and 0 deletions
|
@ -39999,6 +39999,39 @@ This, as you can see, is a fairly sophisticated way to say hello.
|
|||
info on actions.
|
||||
@end deftp
|
||||
|
||||
@cindex configuration file, of Shepherd services
|
||||
@deffn {Scheme Procedure} shepherd-configuration-action
|
||||
Return a @code{configuration} action to display @var{file}, which should
|
||||
be the name of the service's configuration file.
|
||||
|
||||
It can be useful to equip services with that action. For example, the
|
||||
service for the Tor anonymous router (@pxref{Networking Services,
|
||||
@code{tor-service-type}}) is defined roughly like this:
|
||||
|
||||
@lisp
|
||||
(let ((torrc (plain-file "torrc" @dots{})))
|
||||
(shepherd-service
|
||||
(provision '(tor))
|
||||
(requirement '(user-processes loopback syslogd))
|
||||
|
||||
(start #~(make-forkexec-constructor
|
||||
(list #$(file-append tor "/bin/tor") "-f" #$torrc)
|
||||
#:user "tor" #:group "tor"))
|
||||
(stop #~(make-kill-destructor))
|
||||
(actions (list (shepherd-configuration-action torrc)))
|
||||
(documentation "Run the Tor anonymous network overlay.")))
|
||||
@end lisp
|
||||
|
||||
Thanks to this action, administrators can inspect the configuration file
|
||||
passed to @command{tor} with this shell command:
|
||||
|
||||
@example
|
||||
cat $(herd configuration tor)
|
||||
@end example
|
||||
|
||||
This can come in as a handy debugging tool!
|
||||
@end deffn
|
||||
|
||||
@defvr {Scheme Variable} shepherd-root-service-type
|
||||
The service type for the Shepherd ``root service''---i.e., PID@tie{}1.
|
||||
|
||||
|
|
|
@ -66,6 +66,8 @@ (define-module (gnu services shepherd)
|
|||
shepherd-action-documentation
|
||||
shepherd-action-procedure
|
||||
|
||||
shepherd-configuration-action
|
||||
|
||||
%default-modules
|
||||
|
||||
shepherd-service-file
|
||||
|
@ -333,6 +335,16 @@ (define shepherd&co
|
|||
#:options '(#:local-build? #t
|
||||
#:substitutable? #f)))))
|
||||
|
||||
(define (shepherd-configuration-action file)
|
||||
"Return a 'configuration' action to display FILE, which should be the name
|
||||
of the service's configuration file."
|
||||
(shepherd-action
|
||||
(name 'configuration)
|
||||
(documentation "Display the name of this service's configuration file.")
|
||||
(procedure #~(lambda (_)
|
||||
(format #t "~a~%" #$file)
|
||||
#$file))))
|
||||
|
||||
(define (shepherd-configuration-file services shepherd)
|
||||
"Return the shepherd configuration file for SERVICES. SHEPHERD is used
|
||||
as shepherd package."
|
||||
|
|
Loading…
Reference in a new issue