Print this page
12071 clarify implementation of single_instance in SMF services
Reviewed by: Robert Mustacchi <rm@fingolfin.org>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man5/smf_restarter.5
+++ new/usr/src/man/man5/smf_restarter.5
1 1 '\" te
2 2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 +.\" Copyright 2019 Joyent, Inc.
3 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 -.TH SMF_RESTARTER 5 "May 23, 2008"
7 +.TH SMF_RESTARTER 5 "Dec 11, 2019"
7 8 .SH NAME
8 9 smf_restarter \- service management facility conventions for restarters
9 10 .SH DESCRIPTION
10 -.sp
11 -.LP
12 11 All service instances in the service management facility must be managed by a
13 12 restarter. This manual page describes configuration, functionality, and
14 13 reporting characteristics that are common to all restarters in the framework.
15 14 Characteristics specific to a particular restarter are described in the
16 15 restarter's man page.
17 16 .sp
18 17 .LP
19 18 For each managed service, a restarter relies on retrieving properties on the
20 19 service instance to determine configuration. The restarter manages a set of
21 20 property groups to communicate the current disposition of a service with
22 21 display tools such as \fBsvcs\fR(1).
23 22 .SS "Service Configuration"
24 -.sp
25 -.LP
26 23 The common restarter configuration for all services is captured in the
27 24 \fBgeneral\fR property group. This group includes the following required and
28 25 optional property settings.
29 26 .sp
30 27 .ne 2
31 28 .na
32 29 \fB\fBenabled\fR\fR
33 30 .ad
34 31 .RS 19n
35 32 This is a required property. If set, the restarter of an instance attempts to
36 33 maintain availability of the service.
37 34 .RE
38 35
39 36 .sp
40 37 .ne 2
41 38 .na
42 39 \fB\fBrestarter\fR\fR
43 40 .ad
44 41 .RS 19n
45 42 This is an optional property that allows the specification of an alternate
46 43 restarter to manage the service instance. If the restarter property is empty or
|
↓ open down ↓ |
11 lines elided |
↑ open up ↑ |
47 44 absent, the restarter defaults to \fBsvc.startd\fR(1M).
48 45 .RE
49 46
50 47 .sp
51 48 .ne 2
52 49 .na
53 50 \fB\fBsingle_instance\fR\fR
54 51 .ad
55 52 .RS 19n
56 53 This is an optional property. When set, only one instance of the service is
57 -allowed to transition to an online or degraded status at any time.
54 +allowed to transition to an online or degraded status at any time. Note that no
55 +known implementation honours this setting, and it should be considered obsolete.
58 56 .RE
59 57
60 58 .SS "Service Reporting"
61 -.sp
62 -.LP
63 59 All restarters report status using the \fBrestarter\fR property group, which
64 60 includes the following properties:
65 61 .sp
66 62 .ne 2
67 63 .na
68 64 \fB\fBnext_state\fR\fR
69 65 .ad
70 66 .RS 19n
71 67 The current state and next state, if currently in transition, for instances
72 68 stored in these properties. See \fBsmf\fR(5) for a description of the potential
73 69 states.
74 70 .RE
75 71
76 72 .sp
77 73 .ne 2
78 74 .na
79 75 \fB\fBauxiliary_state\fR\fR
80 76 .ad
81 77 .RS 19n
82 78 An astring with no spaces that contains a precise term to describe the full
83 79 restarter-specific state in combination with the restarter state property. The
84 80 auxiliary state cannot always be set and is always cleared during transition
85 81 out of any state. Each restarter must define the precise list of auxiliary
86 82 states it uses.
87 83 .RE
88 84
89 85 .sp
90 86 .ne 2
91 87 .na
92 88 \fB\fBstate_timestamp\fR\fR
93 89 .ad
94 90 .RS 19n
95 91 The time when the current state was reached.
96 92 .RE
97 93
98 94 .sp
|
↓ open down ↓ |
26 lines elided |
↑ open up ↑ |
99 95 .ne 2
100 96 .na
101 97 \fB\fBcontract\fR\fR
102 98 .ad
103 99 .RS 19n
104 100 The primary process contract ID, if any, under which the service instance is
105 101 executing.
106 102 .RE
107 103
108 104 .SH SEE ALSO
109 -.sp
110 -.LP
111 105 \fBsvcs\fR(1), \fBsvc.startd\fR(1M), \fBservice_bundle\fR(4), \fBsmf\fR(5),
112 106 \fBsmf_method\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX