Whamcloud - gitweb
LU-9087 build: add support for DKMS debs
[fs/lustre-release.git] / debian / README.Debian
1 Here is an short explanation what to install on your Servers to set up
2 Lustre quickly.  Be aware that this doesn't replace the Documentation
3 and Installation Howtos from Lustre.
4
5
6 #1. Building the kernel and the modules
7     You've to download the linux-source package for your kernel and
8     the linux-patch-lustre package.
9
10     Then patch your kernel with the correct patch file. Build and install
11     it.  (Use make-kpkg) To patch the kernel automatically use
12     --added-patches=lustre as build option.
13
14     Here is the full line how I build my kernel (for those who are not
15     familiar with make-kpkg):
16     make-kpkg --added-patches=lustre --initrd --append-to-version "-my-version" --revision 1 kernel_image
17
18     Now reboot into this new kernel and install the Lustre modules with:
19      - m-a auto-install lustre
20
21     Then the kernel and the modules should be there.
22
23 #2. Preparing the system
24     In the next step install:
25      - lustre-utils
26
27     This have to be done on every server system.
28
29 #3. Creating partitions on the OST/MDT/MGS Servers
30     Now you'll have to differentiate between the OST and MDT and MGS Systems
31     We'll assume here that MDT and MGS are on the same system:
32
33      - Create partitions:
34         - MGS/MDT: mkfs.lustre --fsname spfs --mdt --mgs $device
35         - OST: mkfs.lustre --fsname spfs --ost --mgsnode=$mgsnode@tcp0 $device
36
37         Additional options are:
38             --reformat                       - this partition was previously formatted with lustre, reformat it
39             --param="failover.mode=failout"  - don't hang the entire fs if an ost isn't available.
40
41      - Now mount the partitons on the servers:
42         - first the MDT/MGS Server:
43           - mount -t lustre /dev/sda /srv/mdt
44         - now the OST's
45           - mount -t lustre /dev/sda /srv/ost
46
47
48 #4. Using the filesystem
49     In order to use the FS, you'll have to mount it on a client. Please note
50     that this client also needs the lustre-modules to be installed. (You can
51     install lustre-source and build the module as described in 1.)
52      - mount -t lustre mgsnode@tcp0:/spfs /mnt
53
54 #5. Building client modules with DKMS
55
56     Lustre client-only kernel modules can built against non-patched, vanilla
57         kernels. This may be more convenient than installing the patched kernel
58         and server modules.
59
60     Installing the lustre-client-modules-dkms package will automatically
61         build modules for all currently installed kernels using DKMS
62         (http://linux.dell.com/dkms/) for which you will need to have the relevant
63         linux-headers packages installed. When a new kernel is installed on the
64         machine, DKMS will automatically build a new set of Lustre client modules.
65
66     You can also use DKMS to create a new deb containing the pre-built kernel
67         modules, suitable for installing on other machines which may not have a
68         full build environment.
69
70     - dkms build -m lustre-client-modules -v <version> -k <kernel-version>
71       (repeat the above step for all required kernel versions)
72     - dkms mkdeb -m lustre-client-modules -v <version>
73     - dkms mkdsc -m lustre-client-modules -v <version>
74
75
76 ###########
77 Please have also a look into the official documentation for Lustre available at:
78
79 https://wiki.hpdd.intel.com/display/PUB/Documentation
80
81  -- Patrick Winnertz <winnie@debian.org>  Thu, 28 Dec 2007 14:53:25 +0200