0
|
1 |
1i\
|
|
2 |
'\\" t\
|
|
3 |
\.\\"\
|
|
4 |
\.\\" Modified for Solaris to to add the Solaris stability classification,\
|
|
5 |
\.\\" and to add a note about source availability.\
|
|
6 |
\.\\"
|
|
7 |
/^\.SH SEE ALSO$/ i\
|
|
8 |
.SH SMF PROPERTIES\
|
|
9 |
Configuration of properties for the /usr/bin/pen program is managed by\
|
|
10 |
the service management facility, \\fBsmf\\fR(5), under the service identifier:\
|
|
11 |
.sp\
|
|
12 |
.in +4\
|
|
13 |
.nf\
|
|
14 |
svc:/network/loadbalancer/pen\
|
|
15 |
.fi\
|
|
16 |
.in -4\
|
|
17 |
.sp\
|
|
18 |
Pen is a multiple instances service. The default instance is:\
|
|
19 |
.in +4\
|
|
20 |
.nf\
|
|
21 |
svc:/network/loadbalancer/pen:default\
|
|
22 |
.fi\
|
|
23 |
.in -4\
|
|
24 |
.sp\
|
|
25 |
Besides, an example of a http load balancer instance is also provided as:\
|
|
26 |
.in +4\
|
|
27 |
.nf\
|
|
28 |
svc:/network/loadbalancer/pen:http\
|
|
29 |
.fi\
|
|
30 |
.in -4\
|
|
31 |
.sp\
|
|
32 |
Users can create their own instances following the smf framework. So multiple\
|
|
33 |
pen processes can be executed separately in one machine at the same time.\
|
|
34 |
.TP\
|
|
35 |
Use \\fBsvccfg\\fR(1M) and \\fBsvcprop\\fR(1M) to change and display the\
|
|
36 |
configuration of this service.\
|
|
37 |
.TP\
|
|
38 |
The following properties must be set before starting the service:\
|
|
39 |
.TP\
|
|
40 |
.B\
|
|
41 |
pen/listenport\
|
|
42 |
(Type astring) The local address and port pen listens on. The value is set\
|
|
43 |
like \\fI[hostname:]port\\fR. If \\fRhostname\\fR is not specified, then\
|
|
44 |
all local address will be listened on.\
|
|
45 |
.TP\
|
|
46 |
.B\
|
|
47 |
pen/servers\
|
|
48 |
(Type astring) The address, the port and the maximum number of simultaneous\
|
|
49 |
connections for remote servers. The value is set like\
|
|
50 |
.nf\
|
|
51 |
\"\\fIhost1[:port1[:sconn1:hconn1]];host2[:port2[:sconn2:hconn2]];...\\fR\"\
|
|
52 |
.fi\
|
|
53 |
\\fIsconn\\fR and \\fIhconn\\fR are soft and hard limit of the number of\
|
|
54 |
connection. The default port value is the same as in\
|
|
55 |
\\fIpen/listenport\\fR.\
|
|
56 |
.TP\
|
|
57 |
The following properties are optional:\
|
|
58 |
.TP\
|
|
59 |
.B\
|
|
60 |
pen/blacklist\
|
|
61 |
(Type count) The blacklist time in seconds, default is 30.\
|
|
62 |
See also option \\fB-b\\fR above.\
|
|
63 |
.TP\
|
|
64 |
.B\
|
|
65 |
pen/timeout\
|
|
66 |
(Type count) The connection timeout in seconds. default is 5.\
|
|
67 |
See also option \\fB-t\\fR above.\
|
|
68 |
.TP\
|
|
69 |
.B\
|
|
70 |
pen/logfile\
|
|
71 |
(Type astring) The location of the log file, default is\
|
|
72 |
\\fB/var/log/pen.log\\fR.\
|
|
73 |
See also option \\fB-l\\fR above.\
|
|
74 |
.TP\
|
|
75 |
.B\
|
|
76 |
pen/cfgfile\
|
|
77 |
(Type astring) The location of the configuration file (penctl style).\
|
|
78 |
See also option \\fB-F\\fR above.\
|
|
79 |
.TP\
|
|
80 |
.B\
|
|
81 |
pen/pidfile\
|
|
82 |
(Type astring) The location of file into which the PID will be written.\
|
|
83 |
See also option \\fB-p\\fR above.\
|
|
84 |
.TP\
|
|
85 |
.B\
|
|
86 |
pen/statusfile\
|
|
87 |
(Type astring) The location of the report file (in html format).\
|
|
88 |
See also option \\fB-w\\fR above.\
|
|
89 |
.TP\
|
|
90 |
.B\
|
|
91 |
pen/tracking\
|
|
92 |
(Type count) The tracking time, default is 0 (never expire).\
|
|
93 |
See also option \\fB-T\\fR above.\
|
|
94 |
.TP\
|
|
95 |
.B\
|
|
96 |
pen/emergency\
|
|
97 |
(Type astring) The emergency server address to contact if all regular\
|
|
98 |
servers become unavailable.\
|
|
99 |
See also option \\fB-e\\fR above.\
|
|
100 |
.TP\
|
|
101 |
.B\
|
|
102 |
pen/maxserver\
|
|
103 |
(Type count) The max number of servers, default is 16.\
|
|
104 |
See also option \\fB-S\\fR above.\
|
|
105 |
.TP\
|
|
106 |
.B\
|
|
107 |
pen/maxclient\
|
|
108 |
(Type count) The max number of clients, default is 2048.\
|
|
109 |
See also option \\fB-c\\fR above.\
|
|
110 |
.TP\
|
|
111 |
.B\
|
|
112 |
pen/chroot\
|
|
113 |
(Type astring) The directory for the chroot environment.\
|
|
114 |
See also option \\fB-j\\fR above.\
|
|
115 |
.TP\
|
|
116 |
.B\
|
|
117 |
pen/user\
|
|
118 |
(Type astring) The different user to run pen.\
|
|
119 |
See also option \\fB-u\\fR above.\
|
|
120 |
.TP\
|
|
121 |
.B\
|
|
122 |
pen/maxconn\
|
|
123 |
(Type count) The max number of simultaneous connections, default is 256.\
|
|
124 |
See also option \\fB-x\\fR above.\
|
|
125 |
.TP\
|
|
126 |
.B\
|
|
127 |
pen/ctrlport\
|
|
128 |
(Type astring) The control port on which pen daemon listens for commands,\
|
|
129 |
in the format [host]:port, default is -1 (not use ctrlport).\
|
|
130 |
See also option \\fB-C\\fR above.\
|
|
131 |
.TP\
|
|
132 |
.B\
|
|
133 |
pen/Xforward\
|
|
134 |
(Type boolean) If X-Forwarded-For header will be added for http requests,\
|
|
135 |
default is false.\
|
|
136 |
See also option \\fB-H\\fR above.\
|
|
137 |
.TP\
|
|
138 |
.B\
|
|
139 |
pen/allowexit\
|
|
140 |
(Type boolean) If an exit command is added for the control interface,\
|
|
141 |
default is false.\
|
|
142 |
See also option \\fB-X\\fR above.\
|
|
143 |
.TP\
|
|
144 |
.B\
|
|
145 |
pen/certfile\
|
|
146 |
(Type astring) The certificate file (in PEM format) used by pen.\
|
|
147 |
See also option \\fB-E\\fR above.\
|
|
148 |
.TP\
|
|
149 |
.B\
|
|
150 |
pen/keyfile\
|
|
151 |
(Type astring) The key file (in PEM format, may be contained in cert)\
|
|
152 |
used by pen.\
|
|
153 |
See also option \\fB-K\\fR above.\
|
|
154 |
.TP\
|
|
155 |
.B\
|
|
156 |
pen/cacertfile\
|
|
157 |
(Type astring) The file containing the CA's certificate.\
|
|
158 |
See also option \\fB-G\\fR above.\
|
|
159 |
.TP\
|
|
160 |
.B\
|
|
161 |
pen/cacertdir\
|
|
162 |
(Type astring) The directory containing CA certificates in hashed format.\
|
|
163 |
See also option \\fB-A\\fR above.\
|
|
164 |
.TP\
|
|
165 |
.B\
|
|
166 |
pen/usessl\
|
|
167 |
(Type boolean) If SSL compatibility mode is used, default is false.\
|
|
168 |
See also option \\fB-Z\\fR above.\
|
|
169 |
.TP\
|
|
170 |
.B\
|
|
171 |
pen/peercert\
|
|
172 |
(Type boolean) If valid peer certificate is required, default is false.\
|
|
173 |
See also option \\fB-R\\fR above.\
|
|
174 |
.TP\
|
|
175 |
.B\
|
|
176 |
pen/protocol\
|
|
177 |
(Type astring) The ssl protocol version, default is ssl23.\
|
|
178 |
See also option \\fB-L\\fR above.\
|
|
179 |
.TP\
|
|
180 |
.B\
|
|
181 |
pen/weight\
|
|
182 |
(Type boolean) If weight way is used for server selection,\
|
|
183 |
default is false.\
|
|
184 |
See also option \\fB-W\\fR above.\
|
|
185 |
.TP\
|
|
186 |
.B\
|
|
187 |
pen/nonblock\
|
|
188 |
(Type boolean) If nonblocking mode is used, default is false.\
|
|
189 |
See also option \\fB-n\\fR above.\
|
|
190 |
.TP\
|
|
191 |
.B\
|
|
192 |
pen/hash\
|
|
193 |
(Type boolean) If hash way is used on client IP addresses for the initial\
|
|
194 |
server selection. Enabling it makes pen more predictable which server will\
|
|
195 |
be used when a client connects. Default is false.\
|
|
196 |
See also option \\fB-h\\fR above.\
|
|
197 |
.TP\
|
|
198 |
.B\
|
|
199 |
pen/roundrobin\
|
|
200 |
(Type boolean) If straight round-robin server selection is used without\
|
|
201 |
looking up which server the client used the last time, default is false.\
|
|
202 |
See also option \\fB-r\\fR above.\
|
|
203 |
.TP\
|
|
204 |
.B\
|
|
205 |
pen/stubborn\
|
|
206 |
(Type boolean) If stubborn server selection is used. If it's enabled,\
|
|
207 |
the client connection will be closed without trying another server if\
|
|
208 |
the first choice is unavailable. Default is false.\
|
|
209 |
See also option \\fB-s\\fR above.\
|
|
210 |
.TP\
|
|
211 |
The other command line options are not supported in SMF property.\
|
|
212 |
.SS \"Example 1: Start pen as a http load balancer\"\
|
|
213 |
.PP\
|
|
214 |
The following commands will start pen as a http load balancer for host\
|
|
215 |
\\fBfoo\\fR and \\fBbar\\fR, using \\fBpen:http\\fR instance:\
|
|
216 |
.sp\
|
|
217 |
.in +2\
|
|
218 |
.nf\
|
|
219 |
svccfg -s pen:http setprop pen/servers = \"foo:80;bar:80\"\
|
|
220 |
svcadm refresh svc:/network/loadbalancer/pen:http\
|
|
221 |
svcadm disable svc:/network/loadbalancer/pen:http\
|
|
222 |
svcadm enable svc:/network/loadbalancer/pen:http\
|
|
223 |
.fi\
|
|
224 |
.in -2\
|
|
225 |
.SS \"Example 2: Start pen with a different log file\"\
|
|
226 |
.PP\
|
|
227 |
The following commands will start pen at current host as a http load\
|
|
228 |
balancer for host \\fBfoo\\fR and \\fBbar\\fR, with log file at the\
|
|
229 |
location \\fB/var/tmp/my.log\\fR, using \\fBpen:default\\fR instance:\
|
|
230 |
.sp\
|
|
231 |
.in +2\
|
|
232 |
.nf\
|
|
233 |
svccfg -s pen:default setprop pen/listenport = 80\
|
|
234 |
svccfg -s pen:default setprop pen/servers = \"foo:80;bar:80\"\
|
|
235 |
svccfg -s pen:default setprop pen/logfile = \"/var/tmp/my.log\"\
|
|
236 |
svcadm refresh svc:/network/loadbalancer/pen:default\
|
|
237 |
svcadm disable svc:/network/loadbalancer/pen:default\
|
|
238 |
svcadm enable svc:/network/loadbalancer/pen:default\
|
|
239 |
.fi\
|
|
240 |
.in -2\
|
|
241 |
.sp
|
|
242 |
$a\
|
|
243 |
\.\\" Begin Sun update\
|
|
244 |
.SH ATTRIBUTES\
|
|
245 |
See\
|
|
246 |
.BR attributes (5)\
|
|
247 |
for descriptions of the following attributes:\
|
|
248 |
.sp\
|
|
249 |
.TS\
|
|
250 |
box;\
|
|
251 |
cbp-1 | cbp-1\
|
|
252 |
l | l .\
|
|
253 |
ATTRIBUTE TYPE ATTRIBUTE VALUE\
|
|
254 |
=\
|
11
|
255 |
Availability service/network/load-balancer/pen\
|
0
|
256 |
=\
|
|
257 |
Interface Stability Uncommitted\
|
|
258 |
.TE \
|
|
259 |
.PP\
|
|
260 |
.SH NOTES\
|
|
261 |
The Pen project is located at http://siag.nu/pen.\
|
|
262 |
.br\
|
|
263 |
Source for Pen is available on http://opensolaris.org.\
|
|
264 |
\.\\" End Sun update
|
|
265 |
s/^\(\.TH [^ ][^ ]* [0-9][a-zA-Z]* \)[^ ][^ ]*$/\1"25 Mar 2008" "SunOS 5.11" "User Commands"/g
|
|
266 |
s/, dwatch(1)/, svcadm(1M), svccfg(1M), svcprop(1M), svcs(1), smf(5), smf_method(5)/g
|
|
267 |
s/, webresolve(1)//g
|