[ec9b2d7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[78bfd941] | 7 | <!ENTITY mdadm-download-http "&kernel;linux/utils/raid/mdadm/mdadm-&mdadm-version;.tar.xz">
|
---|
[ec9b2d7] | 8 | <!ENTITY mdadm-download-ftp " ">
|
---|
[b15359cd] | 9 | <!ENTITY mdadm-md5sum "2cb4feffea9167ba71b5f346a0c0a40d">
|
---|
| 10 | <!ENTITY mdadm-size "424 KB">
|
---|
| 11 | <!ENTITY mdadm-buildsize "6.7 MB (10 MB with tests)">
|
---|
| 12 | <!ENTITY mdadm-time "less than 0.1 SBU (tests take about an hour, only partially processor dependent)">
|
---|
[ec9b2d7] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="mdadm" xreflabel="mdadm-&mdadm-version;">
|
---|
| 16 | <?dbhtml filename="mdadm.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>mdadm-&mdadm-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="mdadm">
|
---|
| 26 | <primary sortas="a-mdadm">mdadm</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to mdadm</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>mdadm</application> package contains administration
|
---|
[6fcb1b9] | 33 | tools for software RAID.</para>
|
---|
[ec9b2d7] | 34 |
|
---|
[995a461b] | 35 | &lfs80_checked;
|
---|
[ec9b2d7] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>Download (HTTP): <ulink url="&mdadm-download-http;"/></para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (FTP): <ulink url="&mdadm-download-ftp;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download MD5 sum: &mdadm-md5sum;</para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download size: &mdadm-size;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Estimated disk space required: &mdadm-buildsize;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated build time: &mdadm-time;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | </itemizedlist>
|
---|
| 58 |
|
---|
| 59 | <para condition="html" role="usernotes">User Notes:
|
---|
[0ec71e95] | 60 | <ulink url="&blfs-wiki;/mdadm"/></para>
|
---|
[4b92d8d] | 61 | <caution>
|
---|
[09765cf] | 62 | <para>
|
---|
[4b92d8d] | 63 | Kernel versions in series 4.1 through 4.4.1 have a broken RAID
|
---|
| 64 | implementation. Use a kernel with version at or above 4.4.2.
|
---|
[09765cf] | 65 | </para>
|
---|
[4b92d8d] | 66 | </caution>
|
---|
[ec9b2d7] | 67 |
|
---|
| 68 | </sect2>
|
---|
| 69 |
|
---|
| 70 | <sect2 role="kernel" id='mdadm-kernel'>
|
---|
| 71 | <title>Kernel Configuration</title>
|
---|
| 72 |
|
---|
| 73 | <para>Enable the following options in the kernel configuration
|
---|
| 74 | and recompile the kernel, if necessary. Only the RAID types desired
|
---|
[ee42033] | 75 | are required.</para>
|
---|
[ec9b2d7] | 76 |
|
---|
[ee42033] | 77 | <screen><literal>Device Drivers --->
|
---|
| 78 | [*] Multiple devices driver support (RAID and LVM) ---> [CONFIG_MD]
|
---|
| 79 | <*> RAID support [CONFIG_BLK_DEV_MD]
|
---|
| 80 | [*] Autodetect RAID arrays during kernel boot [CONFIG_MD_AUTODETECT]
|
---|
| 81 | <*/M> Linear (append) mode [CONFIG_MD_LINEAR]
|
---|
| 82 | <*/M> RAID-0 (striping) mode [CONFIG_MD_RAID0]
|
---|
| 83 | <*/M> RAID-1 (mirroring) mode [CONFIG_MD_RAID1]
|
---|
| 84 | <*/M> RAID-10 (mirrored striping) mode [CONFIG_MD_RAID10]
|
---|
| 85 | <*/M> RAID-4/RAID-5/RAID-6 mode [CONFIG_MD_RAID456]</literal></screen>
|
---|
[ec9b2d7] | 86 |
|
---|
| 87 | <indexterm zone="mdadm mdadm-kernel">
|
---|
| 88 | <primary sortas="d-mdadm">mdadm</primary>
|
---|
| 89 | </indexterm>
|
---|
| 90 |
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2 role="installation">
|
---|
| 94 | <title>Installation of mdadm</title>
|
---|
| 95 |
|
---|
| 96 | <para>Install <application>mdadm</application> by running the following
|
---|
| 97 | commands:</para>
|
---|
| 98 |
|
---|
[b15359cd] | 99 | <screen><userinput>make</userinput></screen>
|
---|
[ec9b2d7] | 100 |
|
---|
[b6d51d20] | 101 | <para>If you wish to run the tests, ensure that your kernel supports
|
---|
[b15359cd] | 102 | RAID and that a version of mdadm is not already running. As many as 9 out
|
---|
| 103 | of 124 tests may fail.</para>
|
---|
[4b92d8d] | 104 |
|
---|
| 105 | <para>First fix the test script to avoid a bogus error message when
|
---|
| 106 | tests fail and build the supporting programs:</para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput>sed -i 's# if.* == "1"#& -a -e $targetdir/log#' test &&
|
---|
| 109 | make test</userinput></screen>
|
---|
| 110 |
|
---|
| 111 | <para>Run the tests as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 112 |
|
---|
[487bdfe6] | 113 | <screen role="root"><userinput>./test --keep-going --logdir=test-logs --save-logs</userinput></screen>
|
---|
[ec9b2d7] | 114 |
|
---|
| 115 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 116 |
|
---|
| 117 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 118 |
|
---|
| 119 | </sect2>
|
---|
| 120 |
|
---|
[b6d51d20] | 121 | <sect2 role="commands">
|
---|
| 122 | <title>Command Explanations</title>
|
---|
| 123 |
|
---|
[a0e6e8dd] | 124 | <para>
|
---|
| 125 | <command>make everything</command>: This optional target creates extra
|
---|
| 126 | programs, particularly a statically-linked version of
|
---|
| 127 | <command>mdadm</command> and also versions of
|
---|
| 128 | <command>mdassemble</command>. These all need to be manually installed.
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <para>
|
---|
| 132 | <parameter>--keep-going</parameter>: Run the tests to the end, even if one
|
---|
| 133 | or more tests fail.
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
| 136 | <para>
|
---|
[4b92d8d] | 137 | <parameter>--logdir=test-logs</parameter>: Defines that the directory
|
---|
| 138 | where test logs are saved.
|
---|
[a0e6e8dd] | 139 | </para>
|
---|
| 140 |
|
---|
| 141 | <para>
|
---|
| 142 | <parameter>--save-logs</parameter>:
|
---|
| 143 | Instructs the test suite to save the logs.
|
---|
| 144 | </para>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
| 147 | <option>--tests=<replaceable><test1,test2,...></replaceable></option>:
|
---|
| 148 | Optional comma separated list of tests to be executed
|
---|
| 149 | (all tests, if this option is not passed).
|
---|
[b6d51d20] | 150 | </para>
|
---|
| 151 |
|
---|
| 152 | </sect2>
|
---|
| 153 |
|
---|
| 154 |
|
---|
[ec9b2d7] | 155 | <sect2 role="content">
|
---|
| 156 | <title>Contents</title>
|
---|
| 157 |
|
---|
| 158 | <segmentedlist>
|
---|
| 159 | <segtitle>Installed Programs</segtitle>
|
---|
| 160 | <segtitle>Installed Libraries</segtitle>
|
---|
| 161 | <segtitle>Installed Directory</segtitle>
|
---|
| 162 |
|
---|
| 163 | <seglistitem>
|
---|
[b6d51d20] | 164 | <seg>mdadm, mdmon and optionally mdassemble</seg>
|
---|
[ec9b2d7] | 165 | <seg>None</seg>
|
---|
| 166 | <seg>None</seg>
|
---|
| 167 | </seglistitem>
|
---|
| 168 | </segmentedlist>
|
---|
| 169 |
|
---|
| 170 | <variablelist>
|
---|
| 171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 172 | <?dbfo list-presentation="list"?>
|
---|
| 173 | <?dbhtml list-presentation="table"?>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="mdadm-prog">
|
---|
| 176 | <term><command>mdadm</command></term>
|
---|
| 177 | <listitem>
|
---|
| 178 | <para>manages MD devices aka Linux Software RAID.</para>
|
---|
| 179 | <indexterm zone="mdadm mdadm-prog">
|
---|
| 180 | <primary sortas="b-mdadm-prog">mdadm</primary>
|
---|
| 181 | </indexterm>
|
---|
| 182 | </listitem>
|
---|
| 183 | </varlistentry>
|
---|
| 184 |
|
---|
| 185 | <varlistentry id="mdmon">
|
---|
| 186 | <term><command>mdmon</command></term>
|
---|
| 187 | <listitem>
|
---|
| 188 | <para>monitors MD external metadata arrays.</para>
|
---|
| 189 | <indexterm zone="mdadm mdmon">
|
---|
| 190 | <primary sortas="b-mdmon">mdmon</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
[b6d51d20] | 195 | <varlistentry id="mdassemble">
|
---|
| 196 | <term><command>mdassemble</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>is a tiny program that can be used to assemble MD devices
|
---|
| 199 | inside an initial ramdisk (initrd) or initramfs.</para>
|
---|
| 200 | <indexterm zone="mdadm mdassemble">
|
---|
| 201 | <primary sortas="b-mdassemble">mdassemble</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
| 205 |
|
---|
[ec9b2d7] | 206 | </variablelist>
|
---|
| 207 |
|
---|
| 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | </sect1>
|
---|