Whamcloud - gitweb
Make ONLY=setup not do cleanup at the end, while we use replay-dual.sh as
[fs/lustre-release.git] / lustre / doc / lwizard.1
1 .TH lwizard 1 "2003 Oct 29" Lustre "Configuration utilities"
2 .SH NAME
3 lwizard \- Lustre configuration wizard
4 .SH SYNOPSIS
5 .br
6 .B lwizard
7 .br
8 .B lwizard [--help]
9 .br
10 .BR lwizard  [-o|--file=CONFIG_FILE][--stripe_size=SIZE][--stripe_cnt=COUNT]
11 .SH DESCRIPTION
12 The configuration files for Lustre installation are generally created through a series of lmc commands, this generates an XML file which describes the complete cluster. The lwizard eliminates the need to learn lmc to generate configuration files, instead it achieves the same through asking some simple questions. The 
13 XML configuration file generated using lwizard will still have to be made accessible to all the cluster nodes either by storing it on an LDAP server, NFS or by copying it over to all the involved nodes and then running lconf on all nodes to start up the various Lustre services, device setups or mounting the filesystem. 
14 So, once invoked, lwizard asks a series of questions about the various pieces of the cluster : 
15 .TP
16 .B MDS hostname 
17 .TP
18 .B MDS device information 
19 .TP
20 .B OST hostname 
21 This will be asked for every new OST added 
22 .TP
23 .B OST device information 
24 This will be asked for every new OST added 
25 .TP
26 .B Lustre mount-point 
27 This is the Lustre mount-point on the client (default - /mnt/lustre) 
28
29 The wizard saves the XML file to the filename specified using the -o or --file option or the default file config.xml. It will also save the lmc commands used to create the XML file in a script config.sh or <specified-file-name>.sh. 
30
31 The lwizard tool currently assumes the following defaults: 
32
33 .TP
34 .B Network type
35 tcp 
36 .TP
37 .B Filesystem type
38 ext3 
39 .TP
40 .B LMC path
41 .I /usr/sbin/lmc 
42
43 .SH EXAMPLES
44 The example below shows a sample session using lwizard.
45 .PP
46 [username@meghna utils]$ ./lwizard --stripe_size=64 --stripe_cnt=2 
47 .br
48 This script will help you create a Lustre configuration file. 
49 .br
50 Creating mds "mds1"...
51 .br 
52 Please enter the hostname(s) for mds1: meghna 
53 .br
54 Please enter the device name or loop file name for meghna: /tmp/mds1 
55 .br
56 Please enter the device size or 0 to use entire device:5000 
57 .br
58 Creating ost "ost1"... 
59 .br
60 Please enter the hostname(s) for ost1: meghna 
61 .br
62 Please enter the device name or loop file name for meghna: /tmp/ost1 
63 .br
64 Please enter the device size or 0 to use entire device:10000 
65 .br
66 Creating ost "ost2"... 
67 .br
68 Please enter the hostname(s) for ost2: 
69 .br
70 Please enter the clients' mountpoint (/mnt/lustre): 
71 .br
72 Creating mds "mds2"... 
73 .br
74 Please enter the hostname(s) for mds2: 
75 .br
76  mds1 lov1 ost1 client 
77 .br
78 Saving configuration to config.xml: 
79 .br
80 Your configuration has been saved to config.xml. 
81 .br
82 Your config command has been save to config.sh. 
83 .SH BUGS
84 None are known.