README
1 #
2 # CDDL HEADER START
3 #
4 # The contents of this file are subject to the terms of the
5 # Common Development and Distribution License (the License).
6 # You may not use this file except in compliance with the License.
7 #
8 # You can obtain a copy of the license at src/CDDL.txt
9 # or http://www.opensolaris.org/os/licensing.
10 # See the License for the specific language governing permissions
11 # and limitations under the License.
12 #
13 # When distributing Covered Code, include this CDDL HEADER in each
14 # file and include the License file at src/CDDL.txt.
15 # If applicable, add the following below this CDDL HEADER, with the
16 # fields enclosed by brackets [] replaced with your own identifying
17 # information: Portions Copyright [yyyy] [name of copyright owner]
18 #
19 # CDDL HEADER END
20 #
21
22 #
23 # Copyright 2007 Sun Microsystems, Inc. All rights reserved.
24 # Use is subject to license terms.
25 #
26 # ident "@(#)README 1.10 07/06/26 SMI"
27 #
28
29 This file contains a list of configuration variables which are set in
30 the beginning of run_dats and prior to any test case run. The
31 configuration variable values are based on the contents of the
32 dataservice information file provided by the user. The actual values
33 used by the test can be found in the testlog file under test result
34 directory when test is complete.
35
36 1) NUM_RGS
37
38 This is the total number of resource groups for a given data service
39
40 2) RG_x_NAME
41
42 This is the name of the RG x.
43
44 Ex : If NUM_RGS is 2, there will be 2 variables, RG_1_NAME and RG_2_NAME
45
46 3) RG_x_NODELIST
47
48 This is the comma separated list of node names for RG x.
49
50 Ex : RG_1_NODELIST=phys-node-1, phys-node-2
51
52 If NUM_RGS is 2, there will be 2 variables. RG_1_NODELIST and
53 RG_2_NODELIST
54
55 4) RG_x_NUM_PROPERTIES
56
57 This is the total number of properties for the resource group x.
58
59 Ex : If NUM_RGS is 2, there will be 2 variables. RG_1_NUM_PROPERTIES
60 and RG_2_NUM_PROPERTIES.
61
62 5) RG_x_PROPERTY_y
63
64 This is the property 'y' for RG 'x'. The value of this variable will
65 be of the form "a=b".
66
67 Ex : If NUM_RGS is 1 and RG_1_NUM_PROPERTIES=2, there will be 2 values,
68 RG_1_PROPERTY_1 and RG_1_PROPERTY_2.
69
70 RG_1_PROPERTY_1="a1=b1"
71 RG_1_PROPERTY_2="a2=b2"
72
73 6) RG_x_NUM_RESOURCES
74
75 This is the number of resources in RG x.
76
77 Ex: If NUM_RGS is 1 and RG_1_NUM_RESOURCES is 2, this would mean that
78 there are 2 resources in the RG.
79
80 7) RG_x_R_y_NAME
81
82 This is the name of the resource 'y' in RG 'x'.
83
84 Ex : If NUM_RGS is 1 and RG_1_NUM_RESOURCES is 2, there would be 2
85 variables.
86
87 RG_1_R_1_NAME=test-1-r
88 RG_1_R_2_NAME=test-2-r
89
90 i.e. Name of the first resource is test-1-r and the name of
91 the second resource is test-2-r.
92
93 8) RG_x_R_y_RT_TYPE
94
95 This is resource type of Resource 'y' in RG 'x'.
96
97 Ex : If NUM_RGS is 1 and RG_1_NUM_RESOURCES is 2, there would be 2
98 variables.
99
100 RG_1_R_1_TYPE=SUNW.nfs
101 RG_1_R_2_TYPE=SUNW.oracle
102
103 i.e. the resource type of the first resource in the RG is SUNW.nfs
104 and the resource type of the second resource in the RG is
105 SUNW.oracle
106
107 9) RG_x_R_y_NUM_SYS_PROPERTIES
108
109 This is the number of system properties for Resource 'y' in RG 'x'.
110
111 10) RG_x_R_y_NUM_EXT_PROPERTIES
112
113 This is the number of extension properties for Resource 'y' in RG 'x'.
114
115 11) RG_x_R_y_SYS_PROPERTY_z
116
117 This is the system property 'z' for Resource 'y' in RG 'x'.
118 The value of this variable will be of the form "a=b"
119
120 Ex : Assume :
121
122 NUM_RGS is 1
123 RG_1_NUM_RESOURCES is 1
124 RG_1_R_1_NUM_SYS_PROPERTIES is 2
125
126 there would be 2 variables.
127
128 RG_1_R_1_SYS_PROPERTY_1
129 RG_1_R_1_SYS_PROPERTY_2
130
131 and there values would be of the form :
132
133 RG_1_R_1_SYS_PROPERTY_1="a1=b1"
134 RG_1_R_1_SYS_PROPERTY_2="a2=b2"
135
136 12) RG_x_R_y_EXT_PROPERTY_z
137
138 This is the extension property 'z' for Resource 'y' in RG 'x'.
139 The value of this variable will be of the form "a=b"
140
141 Ex : Assume :
142
143 NUM_RGS is 1
144 RG_1_NUM_RESOURCES is 1
145 RG_1_R_1_NUM_EXT_PROPERTIES is 2
146
147 there would be 2 variables.
148
149 RG_1_R_1_EXT_PROPERTY_1
150 RG_1_R_1_EXT_PROPERTY_2
151
152 and there values would be of the form :
153
154 RG_1_R_1_EXT_PROPERTY_1="a1=b1"
155 RG_1_R_1_EXT_PROPERTY_2="a2=b2"
156
157 13) RG_x_R_y_ADAPTER_GROUP
158
159 This is the list of public network adapter group for Resource 'y'
160 in RG 'x'.
161
162 Value of this variable is a string.
163
164 Please note that this property is optional. So some resources may
165 not have a value for this.
166
167 14) RG_x_R_y_AUX_NODELIST
168
169 This is the comma separated list of nodenames used as auxiliary
170 nodelist.
171
172 Value of this variable is a string.
173
174 Please note that this property is optional. So some resources may
175 not have a value for this.
176
177 15) RG_x_R_y_NUM_DAEMONS
178
179 This is the number of daemon processes for Resource 'y' in RG 'x'.
180
181 16) RG_x_R_y_DAEMON_z
182
183 This is the name of the daemon process z for Resource 'y' in RG 'x'.
184
185 Ex : If RG_1_R_1_NUM_DAEMONS is 2, there will be 2 variables.
186
187 RG_1_R_1_DAEMON_1 and RG_1_R_1_DAEMON_2
188
189 17) RG_x_R_y_NUM_FM_DAEMONS
190
191 This is the the number of fault monitor daemons for Resource 'y' in
192 RG 'x.
193
194 18) RG_x_R_y_FM_DAEMON_z
195
196 This is the name of the fault monitor daemon process z for
197 Resource 'y' in RG 'x'.
198
199 Ex : If RG_1_R_1_NUM_FM_DAEMONS is 2, there will be 2 variables.
200
201 RG_1_R_1_FM_DAEMON_1 and RG_1_R_1_FM_DAEMON_2
202
203 19) RG_x_R_y_SETUP_PROG
204
205 This is the name of the setup program for Resource 'y' in RG 'x'.
206 This program is invoked on any one of the cluster nodes as user
207 root.
208
209 This is an optional argument. i.e. Some of the resources may not
210 have any setup program.
211
212 Example :
213 -------
214
215 Please look at tp4() in ha_nfs test suite. In that test, we needed
216 to do 'mkdir' and create a dfstab file which has 'share' commands.
217
218 Things like that will get done in the Setup Program.
219
220 20) RG_x_R_y_SETUP_PROG_ARGS
221
222 These are the arguments to be passed to the setup program
223
224 Argument list may be NULL.
225
226 21) RG_x_SETUP_PROG
227
228 This is the name of the client program that sets up the required
229 stuff for RG x. This program is invoked on one of the cluster
230 nodes.
231
232 This is an optional argument. i.e. Some of the resource groups
233 may not have a setup client program.
234
235 Example :
236 -------
237
238 This program can create a simple Oracle or Sybase database for
239 testing.
240
241 22) RG_x_SETUP_PROG_ARGS
242
243 These are the arguments to be passed to the setup client program
244
245 Argument list may be NULL.
246
247 23) RG_x_SETUP_PROG_NODES
248
249 This has the comma separated list of nodenames on which the
250 setup program will be executed.
251
252 24) RG_x_SETUP_PROG_USER
253
254 This is the 'user name' for invoking the setup client program.
255
256 Ex : RG_1_SETUP_PROG_USER=oracle.
257
258 This means that the setup program needs to be invoked as
259 oracle.
260
261 25) RG_x_CLIENT_PROG
262
263 This is the name of the client program for RG x.
264 This program is invoked on the client machine.
265
266 This is an optional argument. i.e. Some of the resource groups
267 may not have a client program.
268
269 Example :
270 -------
271
272 A Few examples on what the client programs can do.
273
274 a) Program that queries the database created by RG_x_SETUP_CLIENT_PROG
275 b) Program that reads a file in HA-NFS
276 c) Program that talks to Apache Web Server
277
278 26) RG_x_CLIENT_PROG_ARGS
279
280 These are the arguments to be passed to the client program
281
282 Argument list may be NULL.
283
284 27) RG_x_CLIENT_PROG_USER
285
286 This is the 'user name' for invoking the client program.
287
288 Ex : RG_1_CLIENT_PROG_USER=oracle.
289
290 This means that the client program needs to be invoked as
291 oracle.
292
293 28) RG_x_CLEANUP_PROG
294
295 This is the name of the client program that cleans up the required
296 stuff for RG x. This program is invoked on one of the cluster nodes.
297
298 This is an optional argument. i.e. Some of the resource groups
299 may not have a cleanup client program.
300
301 Example :
302 -------
303
304 This program removes Oracle or Sybase database created in the setup.
305
306 29) RG_x_CLEANUP_PROG_ARGS
307
308 These are the arguments to be passed to the cleanup client program
309
310 Argument list may be NULL.
311
312 30) RG_x_CLEANUP_PROG_NODES
313
314 This has the comma separated list of nodenames on which the
315 cleanup program will be executed.
316
317 31) RG_x_CLEANUP_PROG_USER
318
319 This is the 'user name' for invoking the cleanup client program.
320
321 Ex : RG_1_CLEANUP_PROG_USER=oracle.
322
323 This means that the cleanup program needs to be invoked as
324 oracle.
325
326 ==================================================================
327 The following environment variables are used in dataservice_reboot
328 test suite
329 ==================================================================
330
331 32) NUM_OF_SLAVES
332
333 Number of systems under TET. In this case 'NUM_OF_SLAVES' is number
334 of clients + CLUSTER_SIZE.
335
336 34) NUM_OF_SLAVES_REBOOT
337
338 Number of systems under TET. In this case 'NUM_OF_SLAVES' is number
339 of clients.
340
341 35) CLUSTER_SIZE
342
343 Number of nodes in the cluster.
344 Test runs on a cluster and some client machines outside the cluster.
345 The cluster nodes will be rebooted in these test suites. So cluster
346 nodes should not be part of dTET
347
348 36) CLUSTER_NODE_n
349
350 One for each cluster node, the machine name of the n-th node in the
351 cluster under test.
352
353 37) CLUSTER_NODEID_n
354
355 One for each cluster node, the machine ID of the n-th node in the
356 cluster under test.
357
358 38) TET_NODE_n
359
360 One for each node under TET, the machine name of the n-th node.
361
362 39) TET_NODEID_n
363
364 One for each node under TET, the machine ID of the n-th node.
365
366 40) TET_CLCONFID_n
367
368 One for each node, cluster's node id (clconf id).
369
370 41) HOMEDIR_MASTER
371
372 Test suite home directory for master machine.
373
374 42) HOMEDIR_CLUSTER_NODE_n
375
376 Test suite home directory for the n-th cluster machine.
377
378 43) HOMEDIR_CLIENT_n
379
380 Test suite home directory for the n-th client machine.
381
382 44) START_APPLICATION_TIME
383
384 Time in seconds, which is needed for Resource Group(s) to come
385 online(failover, switchover, etc.).
386
387 45) NODE_REBOOT_TIME
388
389 Time in seconds, which is needed for node to reboot.
390
391 46) RG_EXIST
392
393 If TRUE, Resource Group(s) already created and online. Tests, which
394 creates, brings online and removes RG's does not run.
395 Default is FALSE.
396
397 47) RSH
398
399 Secure/non-secure environment (rsh or ssh).
400
401 Default is rsh.
402
403 47) RCP
404
405 Secure/non-secure environment (rcp or scp).
406
407 Default is rcp.
408
409 48) RUN_NEWCLI
410
411 If TRUE, the New Commmand Set will be used for running the tests.
412 If not Old Command Set will be used.
413 Default is FALSE.
414