Blame view

Documentation/device-mapper/dm-raid.txt 3.99 KB
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
1
2
  dm-raid
  -------
9d09e663d   NeilBrown   dm: raid456 basic...
3

c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
4
5
6
  The device-mapper RAID (dm-raid) target provides a bridge from DM to MD.
  It allows the MD RAID drivers to be accessed using a device-mapper
  interface.
9d09e663d   NeilBrown   dm: raid456 basic...
7

c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
8
9
10
11
12
13
  The target is named "raid" and it accepts the following parameters:
  
    <raid_type> <#raid_params> <raid_params> \
      <#raid_devs> <metadata_dev0> <dev0> [.. <metadata_devN> <devN>]
  
  <raid_type>:
b12d437b7   Jonathan Brassow   dm raid: support ...
14
    raid1		RAID1 mirroring
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    raid4		RAID4 dedicated parity disk
    raid5_la	RAID5 left asymmetric
  		- rotating parity 0 with data continuation
    raid5_ra	RAID5 right asymmetric
  		- rotating parity N with data continuation
    raid5_ls	RAID5 left symmetric
  		- rotating parity 0 with data restart
    raid5_rs 	RAID5 right symmetric
  		- rotating parity N with data restart
    raid6_zr	RAID6 zero restart
  		- rotating parity zero (left-to-right) with data restart
    raid6_nr	RAID6 N restart
  		- rotating parity N (right-to-left) with data restart
    raid6_nc	RAID6 N continue
  		- rotating parity N (right-to-left) with data continuation
  
    Refererence: Chapter 4 of
    http://www.snia.org/sites/default/files/SNIA_DDF_Technical_Position_v2.0.pdf
  
  <#raid_params>: The number of parameters that follow.
  
  <raid_params> consists of
      Mandatory parameters:
          <chunk_size>: Chunk size in sectors.  This parameter is often known as
  		      "stripe size".  It is the only mandatory parameter and
  		      is placed first.
  
      followed by optional parameters (in any order):
  	[sync|nosync]   Force or prevent RAID initialization.
  
  	[rebuild <idx>]	Rebuild drive number idx (first drive is 0).
  
  	[daemon_sleep <ms>]
  		Interval between runs of the bitmap daemon that
  		clear bits.  A longer interval means less bitmap I/O but
  		resyncing after a failure is likely to take longer.
  
  	[min_recovery_rate <kB/sec/disk>]  Throttle RAID initialization
  	[max_recovery_rate <kB/sec/disk>]  Throttle RAID initialization
46bed2b5c   Jonathan Brassow   dm raid: add writ...
54
  	[write_mostly <idx>]		   Drive index is write-mostly
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
55
56
  	[max_write_behind <sectors>]       See '-write-behind=' (man mdadm)
  	[stripe_cache <sectors>]           Stripe cache size (higher RAIDs only)
c1084561b   Jonathan Brassow   dm raid: add regi...
57
58
59
60
  	[region_size <sectors>]
  		The region_size multiplied by the number of regions is the
  		logical size of the array.  The bitmap records the device
  		synchronisation state for each region.
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
61
62
63
64
  
  <#raid_devs>: The number of devices composing the array.
  	Each device consists of two entries.  The first is the device
  	containing the metadata (if any); the second is the one containing the
b12d437b7   Jonathan Brassow   dm raid: support ...
65
  	data.
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
66
67
68
69
70
71
72
  
  	If a drive has failed or is missing at creation time, a '-' can be
  	given for both the metadata and data drives for a given position.
  
  
  Example tables
  --------------
b12d437b7   Jonathan Brassow   dm raid: support ...
73
  # RAID4 - 4 data drives, 1 parity (no metadata devices)
9d09e663d   NeilBrown   dm: raid456 basic...
74
75
76
  # No metadata devices specified to hold superblock/bitmap info
  # Chunk size of 1MiB
  # (Lines separated for easy reading)
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
77

9d09e663d   NeilBrown   dm: raid456 basic...
78
79
80
  0 1960893648 raid \
          raid4 1 2048 \
          5 - 8:17 - 8:33 - 8:49 - 8:65 - 8:81
b12d437b7   Jonathan Brassow   dm raid: support ...
81
  # RAID4 - 4 data drives, 1 parity (with metadata devices)
9d09e663d   NeilBrown   dm: raid456 basic...
82
83
  # Chunk size of 1MiB, force RAID initialization,
  #       min recovery rate at 20 kiB/sec/disk
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
84

9d09e663d   NeilBrown   dm: raid456 basic...
85
  0 1960893648 raid \
b12d437b7   Jonathan Brassow   dm raid: support ...
86
87
          raid4 4 2048 sync min_recovery_rate 20 \
          5 8:17 8:18 8:33 8:34 8:49 8:50 8:65 8:66 8:81 8:82
9d09e663d   NeilBrown   dm: raid456 basic...
88

c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
89
  'dmsetup table' displays the table used to construct the mapping.
46bed2b5c   Jonathan Brassow   dm raid: add writ...
90
  The optional parameters are always printed in the order listed
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
91
92
  above with "sync" or "nosync" always output ahead of the other
  arguments, regardless of the order used when originally loading the table.
46bed2b5c   Jonathan Brassow   dm raid: add writ...
93
  Arguments that can be repeated are ordered by value.
9d09e663d   NeilBrown   dm: raid456 basic...
94

c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
95
96
97
  'dmsetup status' yields information on the state and health of the
  array.
  The output is as follows:
9d09e663d   NeilBrown   dm: raid456 basic...
98
99
  1: <s> <l> raid \
  2:      <raid_type> <#devices> <1 health char for each dev> <resync_ratio>
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
100
101
  Line 1 is the standard output produced by device-mapper.
  Line 2 is produced by the raid target, and best explained by example:
9d09e663d   NeilBrown   dm: raid456 basic...
102
103
104
          0 1960893648 raid raid4 5 AAAAA 2/490221568
  Here we can see the RAID type is raid4, there are 5 devices - all of
  which are 'A'live, and the array is 2/490221568 complete with recovery.
c0a2fa1ef   Jonathan Brassow   dm raid: improve ...
105
106
  Faulty or missing devices are marked 'D'.  Devices that are out-of-sync
  are marked 'a'.