aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/aoe/aoe.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/aoe/aoe.txt')
-rw-r--r--Documentation/aoe/aoe.txt91
1 files changed, 91 insertions, 0 deletions
diff --git a/Documentation/aoe/aoe.txt b/Documentation/aoe/aoe.txt
new file mode 100644
index 000000000000..43e50108d0e2
--- /dev/null
+++ b/Documentation/aoe/aoe.txt
@@ -0,0 +1,91 @@
1The EtherDrive (R) HOWTO for users of 2.6 kernels is found at ...
2
3 http://www.coraid.com/support/linux/EtherDrive-2.6-HOWTO.html
4
5 It has many tips and hints!
6
7CREATING DEVICE NODES
8
9 Users of udev should find the block device nodes created
10 automatically, but to create all the necessary device nodes, use the
11 udev configuration rules provided in udev.txt (in this directory).
12
13 There is a udev-install.sh script that shows how to install these
14 rules on your system.
15
16 If you are not using udev, two scripts are provided in
17 Documentation/aoe as examples of static device node creation for
18 using the aoe driver.
19
20 rm -rf /dev/etherd
21 sh Documentation/aoe/mkdevs.sh /dev/etherd
22
23 ... or to make just one shelf's worth of block device nodes ...
24
25 sh Documentation/aoe/mkshelf.sh /dev/etherd 0
26
27 There is also an autoload script that shows how to edit
28 /etc/modprobe.conf to ensure that the aoe module is loaded when
29 necessary.
30
31USING DEVICE NODES
32
33 "cat /dev/etherd/err" blocks, waiting for error diagnostic output,
34 like any retransmitted packets.
35
36 "echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to
37 limit ATA over Ethernet traffic to eth2 and eth4. AoE traffic from
38 untrusted networks should be ignored as a matter of security.
39
40 "echo > /dev/etherd/discover" tells the driver to find out what AoE
41 devices are available.
42
43 These character devices may disappear and be replaced by sysfs
44 counterparts, so distribution maintainers are encouraged to create
45 scripts that use these devices.
46
47 The block devices are named like this:
48
49 e{shelf}.{slot}
50 e{shelf}.{slot}p{part}
51
52 ... so that "e0.2" is the third blade from the left (slot 2) in the
53 first shelf (shelf address zero). That's the whole disk. The first
54 partition on that disk would be "e0.2p1".
55
56USING SYSFS
57
58 Each aoe block device in /sys/block has the extra attributes of
59 state, mac, and netif. The state attribute is "up" when the device
60 is ready for I/O and "down" if detected but unusable. The
61 "down,closewait" state shows that the device is still open and
62 cannot come up again until it has been closed.
63
64 The mac attribute is the ethernet address of the remote AoE device.
65 The netif attribute is the network interface on the localhost
66 through which we are communicating with the remote AoE device.
67
68 There is a script in this directory that formats this information
69 in a convenient way.
70
71 root@makki root# sh Documentation/aoe/status.sh
72 e10.0 eth3 up
73 e10.1 eth3 up
74 e10.2 eth3 up
75 e10.3 eth3 up
76 e10.4 eth3 up
77 e10.5 eth3 up
78 e10.6 eth3 up
79 e10.7 eth3 up
80 e10.8 eth3 up
81 e10.9 eth3 up
82 e4.0 eth1 up
83 e4.1 eth1 up
84 e4.2 eth1 up
85 e4.3 eth1 up
86 e4.4 eth1 up
87 e4.5 eth1 up
88 e4.6 eth1 up
89 e4.7 eth1 up
90 e4.8 eth1 up
91 e4.9 eth1 up