12071 clarify implementation of single_instance in SMF services
Reviewed by: Robert Mustacchi <rm@fingolfin.org>

          --- old/usr/src/man/man5/smf_restarter.5.man.txt
          +++ new/usr/src/man/man5/smf_restarter.5.man.txt

   1    1  SMF_RESTARTER(5)      Standards, Environments, and Macros     SMF_RESTARTER(5)
   2    2  
   3    3  
   4    4  
   5    5  NAME
   6    6         smf_restarter - service management facility conventions for restarters
   7    7  
   8    8  DESCRIPTION
   9    9         All service instances in the service management facility must be
  10   10         managed by a restarter. This manual page describes configuration,
  11   11         functionality, and reporting characteristics that are common to all
  12   12         restarters in the framework.  Characteristics specific to a particular
  13   13         restarter are described in the restarter's man page.
  14   14  
  15   15  
  16   16         For each managed service, a restarter relies on retrieving properties
  17   17         on the service instance to determine configuration. The restarter
  18   18         manages a set of property groups to communicate the current disposition
  19   19         of a service with display tools such as svcs(1).
  20   20  
  21   21     Service Configuration
  22   22         The common restarter configuration for all services is captured in the
  23   23         general property group. This group includes the following required and
  24   24         optional property settings.
  25   25  
  26   26         enabled
  27   27                            This is a required property. If set, the restarter
  28   28                            of an instance attempts to maintain availability of
  29   29                            the service.
  30   30  
  31   31  
  32   32         restarter

  33   33                            This is an optional property that allows the
  34   34                            specification of an alternate restarter to manage
  35   35                            the service instance. If the restarter property is
  36   36                            empty or absent, the restarter defaults to
  37   37                            svc.startd(1M).
  38   38  
  39   39  
  40   40         single_instance
  41   41                            This is an optional property. When set, only one
  42   42                            instance of the service is allowed to transition to
  43      -                          an online or degraded status at any time.
       43 +                          an online or degraded status at any time. Note that
       44 +                          no known implementation honours this setting, and it
       45 +                          should be considered obsolete.
  44   46  
  45   47  
  46   48     Service Reporting
  47   49         All restarters report status using the restarter property group, which
  48   50         includes the following properties:
  49   51  
  50   52         next_state
  51   53                            The current state and next state, if currently in
  52   54                            transition, for instances stored in these
  53   55                            properties. See smf(5) for a description of the

  54   56                            potential states.
  55   57  
  56   58  
  57   59         auxiliary_state
  58   60                            An astring with no spaces that contains a precise
  59   61                            term to describe the full restarter-specific state
  60   62                            in combination with the restarter state property.
  61   63                            The auxiliary state cannot always be set and is
  62   64                            always cleared during transition out of any state.
  63   65                            Each restarter must define the precise list of
  64   66                            auxiliary states it uses.
  65   67  
  66   68  
  67   69         state_timestamp
  68   70                            The time when the current state was reached.
  69   71  
  70   72  

  71   73         contract
  72   74                            The primary process contract ID, if any, under which
  73   75                            the service instance is executing.
  74   76  
  75   77  
  76   78  SEE ALSO
  77   79         svcs(1), svc.startd(1M), service_bundle(4), smf(5), smf_method(5)
  78   80  
  79   81  
  80   82  
  81      -                                 May 23, 2008                 SMF_RESTARTER(5)
       83 +                               December 11, 2019              SMF_RESTARTER(5)
    

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX