From a73c94f6adf37f2f7af655b016d8f03209ecdc46 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Wed, 11 Jan 2023 12:36:30 +0000 Subject: Doc fixes Signed-off-by: Laurent Bercot --- doc/instances.html | 10 +++++----- doc/s6-instance-list.html | 2 +- doc/s6-instance-maker.html | 22 +++++++++------------- 3 files changed, 15 insertions(+), 19 deletions(-) diff --git a/doc/instances.html b/doc/instances.html index 53b42e4..de0d0d4 100644 --- a/doc/instances.html +++ b/doc/instances.html @@ -16,7 +16,7 @@ skarnet.org

-

Dynamic instantiation under s6

+

Dynamic instantiation

An instanced service is a parameterized service that you want to @@ -50,8 +50,8 @@ instanced services.

  • Write a template for a service directory that would run under s6-supervise. The run script should take the name of the instance as its -first argument; the finish script should take the name of the -instance as its third argument.
    • +first argument; the finish script, if present, should take the name +of the instance as its third argument.
  • Call the s6-instance-maker program with this template as first argument, and a path dir as second argument. s6-instance-maker will create @@ -101,10 +101,10 @@ or not depending on the given options.
    • around s6-svc on instance/name.
  • s6-instance-status is syntactic sugar around s6-svstat on instance/name.
    • -
  • s6-instance-list is roughly equivalent -to ls -1 instance .
  • s6-instance-delete is syntactic sugar around s6-svunlink on instance/name.
    • +
  • s6-instance-list is roughly equivalent +to ls -1 instance .

    • Notes

    diff --git a/doc/s6-instance-list.html b/doc/s6-instance-list.html index 69cb342..03e5218 100644 --- a/doc/s6-instance-list.html +++ b/doc/s6-instance-list.html @@ -52,7 +52,7 @@ up or down; if they've been created and not deleted, they're printed. diff --git a/doc/s6-instance-maker.html b/doc/s6-instance-maker.html index 906d041..51e0367 100644 --- a/doc/s6-instance-maker.html +++ b/doc/s6-instance-maker.html @@ -59,12 +59,10 @@ each running a copy of the service directory given in template.

    s6-instance-maker is an offline tool: it is run before you need instances. Once the created service directory is live, i.e. there is a -supervisor running on it, then you can create, delete, or control -individual instances via the -s6-instance-create, -s6-instance-delete and -s6-instance-control online -tools, that work with active services. +supervisor running on it, then you can create and delete individual instances via the +s6-instance-create and +s6-instance-delete +online tools, that work with active services.

    Exit codes

    @@ -167,20 +165,18 @@ This argument will be the name of the instance, as provided by the The service is logged: its stderr and stdout are piped to an s6-log process running as loguser and writing to the logdir directory. This logger is the catch-all logger -for the supervision tree owned by user; it is recommended to make -loguser distinct from user, and to have logdir -in a place that is not under the control of user. -If user wants to keep control of their logs, they can declare a -logger for each of their services. +for all the instances and the supervision tree hosting them. If user +and loguser are provided, it is recommended to make them distinct +from each other.

    - If template has a log subdirectory, then each instance + Additionally, if template has a log subdirectory, then each instance will have its own dedicated logger. The run and finish scripts for the logger of an instance named name will be called with an additional argument of name/log. They should make use of this, to ensure loggers are properly differentiated between -instances: for instance, it is not possible to run several +instances: for example, it is not possible to run several s6-log processes on the same log directory, so an instance logger script containing an invocation of s6-log on a fixed logdir will fail as soon as there are 2 instances. -- cgit v1.2.3