services: oci-container: Allow setting Shepherd actions in oci-container-configuration.

* gnu/services/docker.scm (oci-container-configuration)
[shepherd-actions]: New field.
(sanitize-shepherd-actions): sanitize it.
(oci-container-shepherd-service): use it.

* doc/guix.texi: Document it.

Change-Id: I0ca9826542be7cb8ca280a07a9bff1a262c2a8a7
Signed-off-by: Zheng Junjie <zhengjunjie@iscas.ac.cn>
This commit is contained in:
Giacomo Leidi via Guix-patches via 2024-06-11 22:05:00 +02:00 committed by Zheng Junjie
parent cb57a3fd9f
commit 5ee2799cab
No known key found for this signature in database
GPG key ID: 3B5AA993E1A2DFF0
2 changed files with 33 additions and 9 deletions

View file

@ -40898,6 +40898,10 @@ is @code{#f} the service has to be started manually with @command{herd start}.
Whether to have Shepherd restart the service when it stops, for instance when
the underlying process dies.
@item @code{shepherd-actions} (default: @code{'()}) (type: list-of-symbols)
This is a list of @code{shepherd-action} records defining actions supported
by the service.
@item @code{network} (default: @code{""}) (type: string)
Set a Docker network for the spawned container.

View file

@ -77,6 +77,7 @@ (define-module (gnu services docker)
oci-container-configuration-log-file
oci-container-configuration-auto-start?
oci-container-configuration-respawn?
oci-container-configuration-shepherd-actions
oci-container-configuration-network
oci-container-configuration-ports
oci-container-configuration-volumes
@ -328,6 +329,17 @@ (define (oci-sanitize-volumes value)
;; '(("/mnt/dir" . "/dir") "/run/current-system/profile:/java")
(oci-sanitize-mixed-list "volumes" value ":"))
(define (oci-sanitize-shepherd-actions value)
(map
(lambda (el)
(if (shepherd-action? el)
el
(raise
(formatted-message
(G_ "shepherd-actions may only be shepherd-action records
but ~a was found") el))))
value))
(define (oci-sanitize-extra-arguments value)
(define (valid? member)
(or (string? member)
@ -477,6 +489,11 @@ (define-configuration/no-serialization oci-container-configuration
(boolean #f)
"Whether to restart the service when it stops, for instance when the
underlying process dies.")
(shepherd-actions
(list '())
"This is a list of @code{shepherd-action} records defining actions supported
by the service."
(sanitizer oci-sanitize-shepherd-actions))
(network
(maybe-string)
"Set a Docker network for the spawned container.")
@ -680,6 +697,7 @@ (define (guess-name name image)
(oci-image-repository image))))))
(let* ((docker (file-append docker-cli "/bin/docker"))
(actions (oci-container-configuration-shepherd-actions config))
(auto-start?
(oci-container-configuration-auto-start? config))
(user (oci-container-configuration-user config))
@ -731,15 +749,17 @@ (define (guess-name name image)
(actions
(if (oci-image? image)
'()
(list
(shepherd-action
(name 'pull)
(documentation
(format #f "Pull ~a's image (~a)."
name image))
(procedure
#~(lambda _
(invoke #$docker "pull" #$image))))))))))
(append
(list
(shepherd-action
(name 'pull)
(documentation
(format #f "Pull ~a's image (~a)."
name image))
(procedure
#~(lambda _
(invoke #$docker "pull" #$image)))))
actions))))))
(define %oci-container-accounts
(list (user-account