mirror of
https://git.in.rschanz.org/ryan77627/guix.git
synced 2024-12-24 21:38:07 -05:00
services: shepherd: Support custom actions.
* gnu/services/shepherd.scm (<shepherd-service>)[actions]: New field. (<shepherd-action>): New record type. (shepherd-service-file): Pass #:actions to 'make'. * doc/guix.texi (Shepherd Services): Document custom actions.
This commit is contained in:
parent
814bb81668
commit
701383081a
2 changed files with 81 additions and 1 deletions
|
@ -21969,6 +21969,17 @@ Constructors,,, shepherd, The GNU Shepherd Manual}). They are given as
|
|||
G-expressions that get expanded in the Shepherd configuration file
|
||||
(@pxref{G-Expressions}).
|
||||
|
||||
@item @code{actions} (default: @code{'()})
|
||||
@cindex actions, of Shepherd services
|
||||
This is a list of @code{shepherd-action} objects (see below) defining
|
||||
@dfn{actions} supported by the service, in addition to the standard
|
||||
@code{start} and @code{stop} actions. Actions listed here become available as
|
||||
@command{herd} sub-commands:
|
||||
|
||||
@example
|
||||
herd @var{action} @var{service} [@var{arguments}@dots{}]
|
||||
@end example
|
||||
|
||||
@item @code{documentation}
|
||||
A documentation string, as shown when running:
|
||||
|
||||
|
@ -21986,6 +21997,54 @@ This is the list of modules that must be in scope when @code{start} and
|
|||
@end table
|
||||
@end deftp
|
||||
|
||||
@deftp {Data Type} shepherd-action
|
||||
This is the data type that defines additional actions implemented by a
|
||||
Shepherd service (see above).
|
||||
|
||||
@table @code
|
||||
@item name
|
||||
Symbol naming the action.
|
||||
|
||||
@item documentation
|
||||
This is a documentation string for the action. It can be viewed by running:
|
||||
|
||||
@example
|
||||
herd doc @var{service} action @var{action}
|
||||
@end example
|
||||
|
||||
@item procedure
|
||||
This should be a gexp that evaluates to a procedure of at least one argument,
|
||||
which is the ``running value'' of the service (@pxref{Slots of services,,,
|
||||
shepherd, The GNU Shepherd Manual}).
|
||||
@end table
|
||||
|
||||
The following example defines an action called @code{say-hello} that kindly
|
||||
greets the user:
|
||||
|
||||
@example
|
||||
(shepherd-action
|
||||
(name 'say-hello)
|
||||
(documentation "Say hi!")
|
||||
(procedure #~(lambda (running . args)
|
||||
(format #t "Hello, friend! arguments: ~s\n"
|
||||
args)
|
||||
#t)))
|
||||
@end example
|
||||
|
||||
Assuming this action is added to the @code{example} service, then you can do:
|
||||
|
||||
@example
|
||||
# herd say-hello example
|
||||
Hello, friend! arguments: ()
|
||||
# herd say-hello example a b c
|
||||
Hello, friend! arguments: ("a" "b" "c")
|
||||
@end example
|
||||
|
||||
This, as you can see, is a fairly sophisticated way to say hello.
|
||||
@xref{Service Convenience,,, shepherd, The GNU Shepherd Manual}, for more
|
||||
info on actions.
|
||||
@end deftp
|
||||
|
||||
@defvr {Scheme Variable} shepherd-root-service-type
|
||||
The service type for the Shepherd ``root service''---i.e., PID@tie{}1.
|
||||
|
||||
|
|
|
@ -49,6 +49,12 @@ (define-module (gnu services shepherd)
|
|||
shepherd-service-auto-start?
|
||||
shepherd-service-modules
|
||||
|
||||
shepherd-action
|
||||
shepherd-action?
|
||||
shepherd-action-name
|
||||
shepherd-action-documentation
|
||||
shepherd-action-procedure
|
||||
|
||||
%default-modules
|
||||
|
||||
shepherd-service-file
|
||||
|
@ -146,11 +152,20 @@ (define-record-type* <shepherd-service>
|
|||
(start shepherd-service-start) ;g-expression (procedure)
|
||||
(stop shepherd-service-stop ;g-expression (procedure)
|
||||
(default #~(const #f)))
|
||||
(actions shepherd-service-actions ;list of <shepherd-action>
|
||||
(default '()))
|
||||
(auto-start? shepherd-service-auto-start? ;Boolean
|
||||
(default #t))
|
||||
(modules shepherd-service-modules ;list of module names
|
||||
(default %default-modules)))
|
||||
|
||||
(define-record-type* <shepherd-action>
|
||||
shepherd-action make-shepherd-action
|
||||
shepherd-action?
|
||||
(name shepherd-action-name) ;symbol
|
||||
(procedure shepherd-action-procedure) ;gexp
|
||||
(documentation shepherd-action-documentation)) ;string
|
||||
|
||||
(define (shepherd-service-canonical-name service)
|
||||
"Return the 'canonical name' of SERVICE."
|
||||
(first (shepherd-service-provision service)))
|
||||
|
@ -223,7 +238,13 @@ (define (shepherd-service-file service)
|
|||
#:requires '#$(shepherd-service-requirement service)
|
||||
#:respawn? '#$(shepherd-service-respawn? service)
|
||||
#:start #$(shepherd-service-start service)
|
||||
#:stop #$(shepherd-service-stop service))))))
|
||||
#:stop #$(shepherd-service-stop service)
|
||||
#:actions
|
||||
(make-actions
|
||||
#$@(map (match-lambda
|
||||
(($ <shepherd-action> name proc doc)
|
||||
#~(#$name #$doc #$proc)))
|
||||
(shepherd-service-actions service))))))))
|
||||
|
||||
(define (shepherd-configuration-file services)
|
||||
"Return the shepherd configuration file for SERVICES."
|
||||
|
|
Loading…
Reference in a new issue