summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorGiacomo Leidi via Guix-patches via <guix-patches@gnu.org>2024-06-11 22:04:56 +0200
committerZheng Junjie <zhengjunjie@iscas.ac.cn>2024-07-05 15:12:34 +0800
commitf5d0c324b1eb1129a70c04487e5f112cb1838f63 (patch)
tree444540cdb039c3ad3047ddf6211f8b1a46ea372b /doc
parenteeb24a50d2f1f78095bdb16b40ddb93bb51474bc (diff)
downloadguix-f5d0c324b1eb1129a70c04487e5f112cb1838f63.tar.gz
doc: Minor changes to the OCI-backed Services documentation.
* doc/guix.texi: Clarify the example and remove reduntant escapes.

Change-Id: I38f5517ae46b391ba21ae5a94c6dcc272e245036
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi14
1 files changed, 6 insertions, 8 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 6770c9d664..9050888b93 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -40788,6 +40788,7 @@ processes as Shepherd Services.
 (service oci-container-service-type
          (list
           (oci-container-configuration
+           (network "host")
            (image
             (oci-image
              (repository "guile")
@@ -40800,20 +40801,17 @@ processes as Shepherd Services.
             '("-c" "(display \"hello!\n\")")))
           (oci-container-configuration
            (image "prom/prometheus")
-           (network "host")
            (ports
              '(("9000" . "9000")
                ("9090" . "9090"))))
           (oci-container-configuration
            (image "grafana/grafana:10.0.1")
            (network "host")
-           (ports
-             '(("3000" . "3000")))
            (volumes
              '("/var/lib/grafana:/var/lib/grafana")))))
 @end lisp
 
-In this example two different Shepherd services are going be added to the
+In this example three different Shepherd services are going be added to the
 system.  Each @code{oci-container-configuration} record translates to a
 @code{docker run} invocation and its fields directly map to options.  You can
 refer to the
@@ -40821,8 +40819,8 @@ refer to the
 documentation for the semantics of each value.  If the images are not found they
 will be
 @url{https://docs.docker.com/engine/reference/commandline/pull/,pulled}.  The
-spawned services are going to be attached to the host network and are supposed
-to behave like other processes.
+services with @code{(network "host")} are going to be attached to the host network
+and are supposed to behave like native processes with regard to networking.
 
 @end defvar
 
@@ -40854,8 +40852,8 @@ possible to securely set values in the container environment.  This field's
 value can be a list of pairs or strings, even mixed:
 
 @lisp
-(list '(\"LANGUAGE\" . \"eo:ca:eu\")
-      \"JAVA_HOME=/opt/java\")
+(list '("LANGUAGE\" . "eo:ca:eu")
+      "JAVA_HOME=/opt/java")
 @end lisp
 
 Pair members can be strings, gexps or file-like objects. Strings are passed