← Back to branch summary

~ubuntu-branches/ubuntu/raring/mdadm/raring

« back to all changes in this revision

Viewing changes to .pc/spelling-and-manpages.patch/mdadm.conf.5

  • Committer: Package Import Robot
  • Author(s): Michael Tokarev, Sergey B Kirpichev, Michael Tokarev, Dmitrijs Ledkovs
  • Date: 2012-08-25 16:25:37 UTC
  • mto: This revision was merged to the branch mainline in revision 68.
  • Revision ID: package-import@ubuntu.com-20120825162537-3zezwh0cezycilrx
Tags: 3.2.5-2
http://bugs.debian.org/644389
http://bugs.debian.org/678262
http://bugs.debian.org/685161
http://bugs.debian.org/678971
http://bugs.debian.org/678973
[ Sergey B Kirpichev ]
* Fix mdadm.lintian-overrides
* Fix spelling in binaries, fix lintian warnings
  manpage-has-errors-from-man and hyphen-used-as-minus-sign
* Drop unused debconf templates
* Implement status option for mdadm-raid init.d script
* Fix lintian info's conflicts-with-version: Conflicts -> Breaks

[ Michael Tokarev ]
* fix spelling mistakes in previous changelog entry
* some cleanups for checkarray:
 - change --help printing and shorten/simplify the text
 - make --quiet cumulative and stop documenting --real-quiet
 - do not prduce help in case of incorrect usage, and exit with 1
* fixes for initramfs integration (Closes: #644389, #678262, #685161):
 - check INITRDSTART=none early
 - do not explicitly load raid level modules (modprobe/kmod does this)
 - do not collect needed raid levels (we include all modules anyway)
 - load md_mod explicitly since we need to change global parameter

[ Dmitrijs Ledkovs ]
* Use dh_installinit with --no-restart-on-upgrade, which will start
  arrays, but will not stop them during upgrade. (Closes: 678971)
* Copy local administrator's modified udev rules as well as the system
  one. (Closes: #678973)

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/spelling-and-manpages.patch/mdadm.conf.5
 
1
.\" Copyright Neil Brown and others.
 
2
.\"   This program is free software; you can redistribute it and/or modify
 
3
.\"   it under the terms of the GNU General Public License as published by
 
4
.\"   the Free Software Foundation; either version 2 of the License, or
 
5
.\"   (at your option) any later version.
 
6
.\" See file COPYING in distribution for details.
 
7
.TH MDADM.CONF 5
 
8
.SH NAME
 
9
mdadm.conf \- configuration for management of Software RAID with mdadm
 
10
.SH SYNOPSIS
 
11
/etc/mdadm/mdadm.conf
 
12
.SH DESCRIPTION
 
13
.PP
 
14
.I mdadm
 
15
is a tool for creating, managing, and monitoring RAID devices using the
 
16
.B md
 
17
driver in Linux.
 
18
.PP
 
19
Some common tasks, such as assembling all arrays, can be simplified
 
20
by describing the devices and arrays in this configuration file.
 
21
 
 
22
.SS SYNTAX
 
23
The file should be seen as a collection of words separated by white
 
24
space (space, tab, or newline).
 
25
Any word that beings with a hash sign (#) starts a comment and that
 
26
word together with the remainder of the line is ignored.
 
27
 
 
28
Any line that starts with white space (space or tab) is treated as
 
29
though it were a continuation of the previous line.
 
30
 
 
31
Empty lines are ignored, but otherwise each (non continuation) line
 
32
must start with a keyword as listed below.  The keywords are case
 
33
insensitive and can be abbreviated to 3 characters.
 
34
 
 
35
The keywords are:
 
36
.TP
 
37
.B DEVICE
 
38
A
 
39
.B device
 
40
line lists the devices (whole devices or partitions) that might contain
 
41
a component of an MD array.  When looking for the components of an
 
42
array,
 
43
.I mdadm
 
44
will scan these devices (or any devices listed on the command line).
 
45
 
 
46
The
 
47
.B device
 
48
line may contain a number of different devices (separated by spaces)
 
49
and each device name can contain wild cards as defined by
 
50
.BR glob (7).
 
51
 
 
52
Also, there may be several device lines present in the file.
 
53
 
 
54
Alternatively, a
 
55
.B device
 
56
line can contain either or both of the  words
 
57
.B containers
 
58
and
 
59
.BR partitions .
 
60
The word
 
61
.B containers
 
62
will cause
 
63
.I mdadm
 
64
to look for assembled CONTAINER arrays and included them as a source
 
65
for assembling further arrays.
 
66
 
 
67
The word
 
68
.I partitions
 
69
will cause
 
70
.I mdadm
 
71
to read
 
72
.I /proc/partitions
 
73
and include all devices and partitions found therein.
 
74
.I mdadm
 
75
does not use the names from
 
76
.I /proc/partitions
 
77
but only the major and minor device numbers.  It scans
 
78
.I /dev
 
79
to find the name that matches the numbers.
 
80
 
 
81
If no DEVICE line is present, then "DEVICE partitions containers" is assumed.
 
82
 
 
83
For example:
 
84
.IP
 
85
DEVICE /dev/hda* /dev/hdc*
 
86
.br
 
87
DEV    /dev/sd*
 
88
.br
 
89
DEVICE /dev/disk/by-path/pci*
 
90
.br
 
91
DEVICE partitions
 
92
 
 
93
.TP
 
94
.B ARRAY
 
95
The ARRAY lines identify actual arrays.  The second word on the line
 
96
may be the name of the device where the array is normally
 
97
assembled, such as
 
98
.B /dev/md1
 
99
or
 
100
.BR /dev/md/backup .
 
101
If the name does not start with a slash
 
102
.RB (' / '),
 
103
it is treated as being in
 
104
.BR /dev/md/ .
 
105
Alternately the word
 
106
.B <ignore>
 
107
(complete with angle brackets) can be given in which case any array
 
108
which matches the rest of the line will never be automatically assembled.
 
109
If no device name is given,
 
110
.I mdadm
 
111
will use various heuristics to determine an appropriate name.
 
112
 
 
113
Subsequent words identify the array, or identify the array as a member
 
114
of a group. If multiple identities are given,
 
115
then a component device must match ALL identities to be considered a
 
116
match.  Each identity word has a tag, and equals sign, and some value.
 
117
The tags are:
 
118
.RS 4
 
119
.TP
 
120
.B uuid=
 
121
The value should be a 128 bit uuid in hexadecimal, with punctuation
 
122
interspersed if desired.  This must match the uuid stored in the
 
123
superblock.
 
124
.TP
 
125
.B name=
 
126
The value should be a simple textual name as was given to
 
127
.I mdadm
 
128
when the array was created.  This must match the name stored in the
 
129
superblock on a device for that device to be included in the array.
 
130
Not all superblock formats support names.
 
131
.TP
 
132
.B super\-minor=
 
133
The value is an integer which indicates the minor number that was
 
134
stored in the superblock when the array was created. When an array is
 
135
created as /dev/mdX, then the minor number X is stored.
 
136
.TP
 
137
.B devices=
 
138
The value is a comma separated list of device names or device name
 
139
patterns.
 
140
Only devices with names which match one entry in the list will be used
 
141
to assemble the array.  Note that the devices 
 
142
listed there must also be listed on a DEVICE line.
 
143
.TP
 
144
.B level=
 
145
The value is a raid level.  This is not normally used to
 
146
identify an array, but is supported so that the output of
 
147
 
 
148
.B "mdadm \-\-examine \-\-scan"
 
149
 
 
150
can be use directly in the configuration file.
 
151
.TP
 
152
.B num\-devices=
 
153
The value is the number of devices in a complete active array.  As with
 
154
.B level=
 
155
this is mainly for compatibility with the output of
 
156
 
 
157
.BR "mdadm \-\-examine \-\-scan" .
 
158
 
 
159
.TP
 
160
.B spares=
 
161
The value is a number of spare devices to expect the array to have.
 
162
The sole use of this keyword and value is as follows:
 
163
.B mdadm \-\-monitor
 
164
will report an array if it is found to have fewer than this number of
 
165
spares when
 
166
.B \-\-monitor
 
167
starts or when
 
168
.B \-\-oneshot
 
169
is used.
 
170
 
 
171
.TP
 
172
.B spare\-group=
 
173
The value is a textual name for a group of arrays.  All arrays with
 
174
the same
 
175
.B spare\-group
 
176
name are considered to be part of the same group.  The significance of
 
177
a group of arrays is that
 
178
.I mdadm
 
179
will, when monitoring the arrays, move a spare drive from one array in
 
180
a group to another array in that group if the first array had a failed
 
181
or missing drive but no spare.
 
182
 
 
183
.TP
 
184
.B auto=
 
185
This option is rarely needed with mdadm-3.0, particularly if use with
 
186
the Linux kernel v2.6.28 or later.
 
187
It tells
 
188
.I mdadm
 
189
whether to use partitionable array or non-partitionable arrays and,
 
190
in the absence of
 
191
.IR udev ,
 
192
how many partition devices to create.  From 2.6.28 all md array
 
193
devices are partitionable, hence this option is not needed.
 
194
 
 
195
The value of this option can be "yes" or "md" to indicate that a
 
196
traditional, non-partitionable md array should be created, or "mdp",
 
197
"part" or "partition" to indicate that a partitionable md array (only
 
198
available in linux 2.6 and later) should be used.  This later set can
 
199
also have a number appended to indicate how many partitions to create
 
200
device files for, e.g.
 
201
.BR auto=mdp5 .
 
202
The default is 4.
 
203
 
 
204
.TP
 
205
.B bitmap=
 
206
The option specifies a file in which a write-intent bitmap should be
 
207
found.  When assembling the array,
 
208
.I mdadm
 
209
will provide this file to the
 
210
.B md
 
211
driver as the bitmap file.  This has the same function as the
 
212
.B \-\-bitmap\-file
 
213
option to
 
214
.BR \-\-assemble .
 
215
 
 
216
.TP
 
217
.B metadata=
 
218
Specify the metadata format that the array has.  This is mainly
 
219
recognised for comparability with the output of
 
220
.BR "mdadm \-Es" .
 
221
 
 
222
.TP
 
223
.B container=
 
224
Specify that this array is a member array of some container.  The
 
225
value given can be either a path name in /dev, or a UUID of the
 
226
container array.
 
227
 
 
228
.TP
 
229
.B member=
 
230
Specify that this array is a member array of some container.  Each
 
231
type of container has some way to enumerate member arrays, often a
 
232
simple sequence number.  The value identifies which member of a
 
233
container the array is.  It will usually accompany a "container=" word.
 
234
.RE
 
235
 
 
236
.TP
 
237
.B MAILADDR
 
238
The
 
239
.B mailaddr
 
240
line gives an E-mail address that alerts should be
 
241
sent to when
 
242
.I mdadm
 
243
is running in
 
244
.B \-\-monitor
 
245
mode (and was given the
 
246
.B \-\-scan
 
247
option).  There should only be one
 
248
.B MAILADDR
 
249
line and it should have only one address.
 
250
 
 
251
 
 
252
.TP
 
253
.B MAILFROM
 
254
The
 
255
.B mailfrom
 
256
line (which can only be abbreviated to at least 5 characters) gives an
 
257
address to appear in the "From" address for alert mails.  This can be
 
258
useful if you want to explicitly set a domain, as the default from
 
259
address is "root" with no domain.  All words on this line are
 
260
catenated with spaces to form the address.
 
261
 
 
262
Note that this value cannot be set via the
 
263
.I mdadm
 
264
commandline.  It is only settable via the config file.
 
265
 
 
266
.TP
 
267
.B PROGRAM
 
268
The
 
269
.B program
 
270
line gives the name of a program to be run when
 
271
.B "mdadm \-\-monitor"
 
272
detects potentially interesting events on any of the arrays that it
 
273
is monitoring.  This program gets run with two or three arguments, they
 
274
being the Event, the md device, and possibly the related component
 
275
device.
 
276
 
 
277
There should only be one
 
278
.B program
 
279
line and it should be give only one program.
 
280
 
 
281
 
 
282
.TP
 
283
.B CREATE
 
284
The
 
285
.B create
 
286
line gives default values to be used when creating arrays and device entries for
 
287
arrays.
 
288
These include:
 
289
 
 
290
.RS 4
 
291
.TP
 
292
.B owner=
 
293
.TP
 
294
.B group=
 
295
These can give user/group ids or names to use instead of system
 
296
defaults (root/wheel or root/disk).
 
297
.TP
 
298
.B mode=
 
299
An octal file mode such as 0660 can be given to override the default
 
300
of 0600.
 
301
.TP
 
302
.B auto=
 
303
This corresponds to the
 
304
.B \-\-auto
 
305
flag to mdadm.  Give
 
306
.BR yes ,
 
307
.BR md ,
 
308
.BR mdp ,
 
309
.B part
 
310
\(em possibly followed by a number of partitions \(em to indicate how
 
311
missing device entries should be created.
 
312
 
 
313
.TP
 
314
.B metadata=
 
315
The name of the metadata format to use if none is explicitly given.
 
316
This can be useful to impose a system-wide default of version-1 superblocks.
 
317
 
 
318
.TP
 
319
.B symlinks=no
 
320
Normally when creating devices in
 
321
.B /dev/md/
 
322
.I mdadm
 
323
will create a matching symlink from
 
324
.B /dev/
 
325
with a name starting
 
326
.B md
 
327
or
 
328
.BR md_ .
 
329
Give
 
330
.B symlinks=no
 
331
to suppress this symlink creation.
 
332
.RE
 
333
 
 
334
.TP
 
335
.B HOMEHOST
 
336
The
 
337
.B homehost
 
338
line gives a default value for the
 
339
.B \-\-homehost=
 
340
option to mdadm.  There should normally be only one other word on the line.
 
341
It should either be a host name, or one of the special words
 
342
.BR <system>,
 
343
.B <none>
 
344
and
 
345
.BR <ignore> .
 
346
If
 
347
.B <system>
 
348
is given, then the
 
349
.BR gethostname ( 2 )
 
350
systemcall is used to get the host name.  This is the default.
 
351
 
 
352
If
 
353
.B <ignore>
 
354
is given, then a flag is set so that when arrays are being
 
355
auto-assembled the checking of the recorded
 
356
.I homehost
 
357
is disabled.
 
358
If
 
359
.B <ignore>
 
360
is given it is also possible to give an explicit name which will be
 
361
used when creating arrays.  This is the only case when there can be
 
362
more that one other word on the
 
363
.B HOMEHOST
 
364
line.
 
365
 
 
366
If
 
367
.B <none>
 
368
is given, then the default of using
 
369
.BR gethostname ( 2 )
 
370
is over-ridden and no homehost name is assumed.
 
371
 
 
372
When arrays are created, this host name will be stored in the
 
373
metadata.  When arrays are assembled using auto-assembly, arrays which
 
374
do not record the correct homehost name in their metadata will be
 
375
assembled using a "foreign" name.  A "foreign" name alway ends with a
 
376
digit string preceded by an underscore to differentiate it
 
377
from any possible local name. e.g.
 
378
.B /dev/md/1_1
 
379
or
 
380
.BR /dev/md/home_0 .
 
381
.TP
 
382
.B AUTO
 
383
A list of names of metadata format can be given, each preceded by a
 
384
plus or minus sign.  Also the word
 
385
.I homehost
 
386
is allowed as is
 
387
.I all
 
388
preceded by plus or minus sign.
 
389
.I all
 
390
is usually last.
 
391
 
 
392
When
 
393
.I mdadm
 
394
is auto-assembling an array, either via
 
395
.I \-\-assemble
 
396
or
 
397
.I \-\-incremental
 
398
and it finds metadata of a given type, it checks that metadata type
 
399
against those listed in this line.  The first match wins, where
 
400
.I all
 
401
matches anything.
 
402
If a match is found that was preceded by a plus sign, the auto
 
403
assembly is allowed.  If the match was preceded by a minus sign, the
 
404
auto assembly is disallowed.  If no match is found, the auto assembly
 
405
is allowed.
 
406
 
 
407
If the metadata indicates that the array was created for
 
408
.I this
 
409
host, and the word
 
410
.I homehost
 
411
appears before any other match, then the array is treated as a valid
 
412
candidate for auto-assembly.
 
413
 
 
414
This can be used to disable all auto-assembly (so that only arrays
 
415
explicitly listed in mdadm.conf or on the command line are assembled),
 
416
or to disable assembly of certain metadata types which might be
 
417
handled by other software.  It can also be used to disable assembly of
 
418
all foreign arrays - normally such arrays are assembled but given a
 
419
non-deterministic name in
 
420
.BR /dev/md/ .
 
421
 
 
422
The known metadata types are
 
423
.BR 0.90 ,
 
424
.BR 1.x ,
 
425
.BR ddf ,
 
426
.BR imsm .
 
427
 
 
428
.TP
 
429
.B POLICY
 
430
This is used to specify what automatic behavior is allowed on devices 
 
431
newly appearing in the system and provides a way of marking spares that can
 
432
be moved to other arrays as well as the migration domains.
 
433
.I Domain
 
434
can be defined through
 
435
.I policy
 
436
line by specifying a domain name for a number of paths from
 
437
.BR /dev/disk/by-path/ .
 
438
A device may belong to several domains. The domain of an array is a union
 
439
of domains of all devices in that array.  A spare can be automatically
 
440
moved from one array to another if the set of the destination array's
 
441
.I domains
 
442
ppcontains all the
 
443
.I domains
 
444
of the new disk or if both arrays have the same
 
445
.IR spare-group .
 
446
 
 
447
To update hot plug configuration it is necessary to execute
 
448
.B mdadm \-\-udev\-rules
 
449
command after changing the config file
 
450
 
 
451
Key words used in the
 
452
.I POLICY
 
453
line and supported values are:
 
454
 
 
455
.RS 7
 
456
.TP
 
457
.B domain=
 
458
any arbitrary string
 
459
.TP
 
460
.B metadata=
 
461
0.9 1.x ddf or imsm
 
462
.TP
 
463
.B path=
 
464
file glob matching anything from
 
465
.B /dev/disk/by-path
 
466
.TP
 
467
.B type=
 
468
either 
 
469
.B disk
 
470
or
 
471
.BR part .
 
472
.TP
 
473
.B action=
 
474
include, re-add, spare, spare-same-slot, or force-spare
 
475
.B auto=
 
476
yes, no, or homehost.
 
477
 
 
478
.P
 
479
The
 
480
.I action
 
481
item determines the automatic behavior allowed for devices matching the
 
482
.I path
 
483
and
 
484
.I type
 
485
in the same line.  If a device matches several lines with different
 
486
.I  actions
 
487
then the most permissive will apply. The ordering of policy lines
 
488
is irrelevant to the end result.
 
489
.TP
 
490
.B include
 
491
allows adding a disk to an array if metadata on that disk matches that array
 
492
.TP
 
493
.B re-add
 
494
will include the device in the array if it appears to be a current member
 
495
or a member that was recently removed
 
496
.TP
 
497
.B spare
 
498
as above and additionally: if the device is bare it can
 
499
become a spare if there is any array that it is a candidate for based
 
500
on domains and metadata.
 
501
.TP
 
502
.B spare\-same\-slot
 
503
as above and additionally if given slot was used by an array that went
 
504
degraded recently and the device plugged in has no metadata then it will
 
505
be automatically added to that array (or it's container)
 
506
.TP
 
507
.B force-spare
 
508
as above and the disk will become a spare in remaining cases
 
509
.RE
 
510
 
 
511
.SH EXAMPLE
 
512
DEVICE /dev/sd[bcdjkl]1
 
513
.br
 
514
DEVICE /dev/hda1 /dev/hdb1
 
515
 
 
516
# /dev/md0 is known by its UUID.
 
517
.br
 
518
ARRAY /dev/md0 UUID=3aaa0122:29827cfa:5331ad66:ca767371
 
519
.br
 
520
# /dev/md1 contains all devices with a minor number of
 
521
.br
 
522
#   1 in the superblock.
 
523
.br
 
524
ARRAY /dev/md1 superminor=1
 
525
.br
 
526
# /dev/md2 is made from precisely these two devices
 
527
.br
 
528
ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
 
529
 
 
530
# /dev/md4 and /dev/md5 are a spare-group and spares
 
531
.br
 
532
#  can be moved between them
 
533
.br
 
534
ARRAY /dev/md4 uuid=b23f3c6d:aec43a9f:fd65db85:369432df
 
535
.br
 
536
           spare\-group=group1
 
537
.br
 
538
ARRAY /dev/md5 uuid=19464854:03f71b1b:e0df2edd:246cc977
 
539
.br
 
540
           spare\-group=group1
 
541
.br
 
542
# /dev/md/home is created if need to be a partitionable md array
 
543
.br
 
544
# any spare device number is allocated.
 
545
.br
 
546
ARRAY /dev/md/home UUID=9187a482:5dde19d9:eea3cc4a:d646ab8b
 
547
.br
 
548
           auto=part
 
549
.br
 
550
POLICY domain=domain1 metadata=imsm path=pci-0000:00:1f.2-scsi-*
 
551
.br
 
552
           action=spare
 
553
.br
 
554
POLICY domain=domain1 metadata=imsm path=pci-0000:04:00.0-scsi-[01]*
 
555
.br
 
556
           action=include
 
557
.br
 
558
# One domain comprising of devices attached to specified paths is defined.
 
559
.br
 
560
# Bare device matching first path will be made an imsm spare on hot plug.
 
561
.br
 
562
# If more than one array is created on devices belonging to domain1 and
 
563
.br
 
564
# one of them becomes degraded, then any imsm spare matching any path for
 
565
.br
 
566
# given domain name can be migrated.
 
567
.br
 
568
MAILADDR root@mydomain.tld
 
569
.br
 
570
PROGRAM /usr/sbin/handle\-mdadm\-events
 
571
.br
 
572
CREATE group=system mode=0640 auto=part\-8
 
573
.br
 
574
HOMEHOST <system>
 
575
.br
 
576
AUTO +1.x homehost -all
 
577
 
 
578
.SH SEE ALSO
 
579
.BR mdadm (8),
 
580
.BR md (4).
 
581