source: postlfs/filesystems/lvm2.xml@ d7bee48

systemd-13485
Last change on this file since d7bee48 was d7bee48, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Sync to trunk r17332

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17335 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 14.3 KB
Line 
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
7 <!ENTITY lvm2-download-http " ">
8 <!ENTITY lvm2-download-ftp "ftp://sources.redhat.com/pub/lvm2/releases/LVM2.&lvm2-version;.tgz">
9 <!ENTITY lvm2-md5sum "3b1be9a67d8000040931f3e88ec10557">
10 <!ENTITY lvm2-size "1.9 MB">
11 <!ENTITY lvm2-buildsize "27 MB (add 13 MB for tests, however transient files can grow up to around 500 MB)">
12 <!ENTITY lvm2-time "0.4 SBU (additional 5.4 SBU for tests)">
13]>
14
15<sect1 id="lvm2" xreflabel="LVM2-&lvm2-version;">
16 <?dbhtml filename="lvm2.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>LVM2-&lvm2-version;</title>
24
25 <indexterm zone="lvm2">
26 <primary sortas="a-LVM2">LVM2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to LVM2</title>
31
32 <para>
33 The <application>LVM2</application> package is a set of utilities that manages
34 logical partitions. It allows spanning of file systems across multiple
35 physical disks and disk partitions and provides for dynamic growing or
36 shrinking of logical partitions, mirroring and low storage footprint snapshots.
37 </para>
38
39 &lfs77_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&lvm2-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&lvm2-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &lvm2-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &lvm2-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &lvm2-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &lvm2-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">LVM2 Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend='mdadm'/> (for checks),
80 <xref linkend='reiserfs'/>,
81 <xref linkend='valgrind'/>,
82 <xref linkend='which'/>,
83 <xref linkend='xfsprogs'/> (all five may be used, but are not required,
84 for tests), and
85 <ulink url='https://github.com/jthornber/thin-provisioning-tools'>
86 thin-provisioning-tools</ulink>
87 </para>
88
89 <para condition="html" role="usernotes">User Notes:
90 <ulink url="&blfs-wiki;/lvm2"/>
91 </para>
92
93 <caution>
94 <para>
95 Kernel versions between 4.1 and 4.4.1 have a broken RAID
96 implementation. If you want to use RAID type LV's, you should install
97 kernel version 4.4.2 or above. Note that several tests use RAID logical
98 volumes, and can generate a <quote>kernel oops</quote> with the faulty
99 kernel version, which usually renders the system unusable.
100 </para>
101 </caution>
102 </sect2>
103
104 <sect2 role="kernel" id="lvm2-kernel">
105 <title>Kernel Configuration</title>
106
107 <para>
108 Enable the following options in the kernel configuration
109 and recompile the kernel:
110 </para>
111
112 <note><para>
113 There are several other Device Mapper options in the kernel beyond those
114 listed below. In order to get reasonable results if running the
115 regression tests, all must be enabled either internally or as a module.
116 </para></note>
117
118<screen><literal>Device Drivers ---&gt;
119 [*] Multiple devices driver support (RAID and LVM) ---&gt; [CONFIG_MD]
120 &lt;*/M&gt; Device mapper support [CONFIG_BLK_DEV_DM]
121 &lt;*/M/ &gt; Crypt target support [CONFIG_DM_CRYPT]
122 &lt;*/M/ &gt; Snapshot target [CONFIG_DM_SNAPSHOT]
123 &lt;*/M/ &gt; Thin provisioning target [CONFIG_DM_THIN_PROVISIONING]
124 &lt;*/M/ &gt; Mirror target [CONFIG_DM_MIRROR]</literal></screen>
125
126 <indexterm zone="lvm2 lvm2-kernel">
127 <primary sortas="d-lvm2">lvm2</primary>
128 </indexterm>
129
130 </sect2>
131
132 <sect2 role="installation">
133 <title>Installation of LVM2</title>
134
135 <para>
136 Install <application>LVM2</application> by running the following
137 commands:
138 </para>
139
140<screen><userinput>SAVEPATH=$PATH &amp;&amp;
141PATH=$PATH:/sbin:/usr/sbin &amp;&amp;
142./configure --prefix=/usr \
143 --exec-prefix= \
144 --with-confdir=/etc \
145 --enable-applib \
146 --enable-cmdlib \
147 --enable-pkgconfig \
148 --enable-udev_sync &amp;&amp;
149make &amp;&amp;
150PATH=$SAVEPATH &amp;&amp;
151unset SAVEPATH</userinput></screen>
152
153 <para>
154 The tests use <application>udev</application> for logical volume
155 synchronization, so the LVM udev rules and some utilities need to
156 be installed before running the tests. If you are installing
157 <application>LVM2</application> for the first time, and do not
158 want to install the full package before running the tests, the minimal
159 set of utilities can be installed by running the following commands
160 as the <systemitem class="username">root</systemitem> user:
161 </para>
162
163<screen role="root"><userinput>make -C tools install_dmsetup_dynamic &amp;&amp;
164make -C udev install &amp;&amp;
165make -C libdm install</userinput></screen>
166
167 <para>
168 To test the results, issue: <command>make check_local</command> as the
169 <systemitem class="username">root</systemitem> user. Other targets are
170 available and can be listed with <command>make -C test help</command>.
171 The test timings are very dependent on the speed of the disk(s), and on
172 the number of enabled kernel options.
173 </para>
174 <para>
175 Those tests do not implement the <quote>expected fail</quote> possibility,
176 and a small number of test failures is expected by upstream. More
177 failures may happen because some kernel options are missing. For example,
178 the lack of the <emphasis>dm-delay</emphasis> device mapper target may
179 explain some failures. Some tests are flagged
180 <quote>warned</quote> if
181 <ulink url='https://github.com/jthornber/thin-provisioning-tools'>
182 thin-provisioning-tools</ulink> are not installed. A workaround is to
183 add the following flags to <command>configure</command>:
184 </para>
185
186<screen role="nodump"><userinput> --with-thin-check= \
187 --with-thin-dump= \
188 --with-thin-repair= \
189 --with-thin-restore= \
190 --with-cache-check= \
191 --with-cache-dump= \
192 --with-cache-repair= \
193 --with-cache-restore= \</userinput></screen>
194
195 <para>
196 Some tests may hang with kernel versions within the 4.1 and 4.2 series (see
197 above). They can be removed if necessary, for example: <command>rm
198 test/shell/lvcreate-large-raid.sh</command>. The tests generate a lot
199 of kernel messages, which may clutter your terminal. You can disable them
200 by issuing <command>dmesg -D</command> before running the tests (do not
201 forget to issue <command>dmesg -E</command> when the tests are done).
202 </para>
203
204 <para>
205 Now, as the <systemitem class="username">root</systemitem> user:
206 </para>
207
208<screen role="root"><userinput>make install</userinput></screen>
209
210 </sect2>
211
212 <sect2 role="commands">
213 <title>Command Explanations</title>
214
215 <para>
216 <command>PATH=$PATH:/sbin:/usr/sbin</command>: The path
217 must contain <filename class="directory">/sbin</filename> and
218 <filename class="directory">/usr/sbin</filename> for proper system tool
219 detection by the <command>configure</command> script. This command
220 ensures that PATH is properly set if you are building as an unprivileged
221 user.
222 </para>
223
224 <para>
225 <parameter>--enable-applib</parameter>: This switch enables
226 building of the shared application library.
227 </para>
228
229 <para>
230 <parameter>--enable-cmdlib</parameter>: This switch enables
231 building of the shared command library. It is required
232 when building the event daemon.
233 </para>
234
235 <para>
236 <option>--enable-lvmetad</option>: This switch enables
237 building of the <application>LVM</application> metadata daemon,
238 which avoids scanning all the filesystems when an LVM command is
239 run.
240 </para>
241
242 <para>
243 <parameter>--enable-pkgconfig</parameter>: This switch enables
244 installation of <command>pkg-config</command> support files.
245 </para>
246
247 <para>
248 <parameter>--enable-udev_sync</parameter>: This switch enables
249 synchronisation with <application>Udev</application> processing.
250 </para>
251
252 <para>
253 <option>--enable-dmeventd</option>: This switch enables
254 building of the <application>Device Mapper</application>
255 event daemon.
256 </para>
257
258 </sect2>
259
260 <sect2 role="content">
261 <title>Contents</title>
262
263 <segmentedlist>
264 <segtitle>Installed Programs</segtitle>
265 <segtitle>Installed Libraries</segtitle>
266 <segtitle>Installed Directories</segtitle>
267
268 <seglistitem>
269 <seg>
270 blkdeactivate,
271 dmeventd (optional),
272 dmsetup,
273 fsadm,
274 lvm,
275 lvmconf,
276 lvmdump,
277 lvmetad (optional),
278 and vgimportclone.
279 There are also numerous symbolic links to
280 lvm that implement specific functionalities
281 </seg>
282 <seg>
283 libdevmapper.so,
284 liblvm2app.so,
285 and liblvm2cmd.so;
286 optional: libdevmapper-event.so,
287 libdevmapper-event-lvm2.so,
288 libdevmapper-event-lvm2mirror.so,
289 libdevmapper-event-lvm2snapshot.so,
290 libdevmapper-event-lvm2raid.so,
291 and libdevmapper-event-lvm2thin.so
292 </seg>
293 <seg>
294 /etc/lvm and
295 /lib/device-mapper (optional)
296 </seg>
297 </seglistitem>
298 </segmentedlist>
299
300 <variablelist>
301 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
302 <?dbfo list-presentation="list"?>
303
304 <?dbhtml list-presentation="table"?>
305
306 <varlistentry id="blkdeactivate">
307 <term><command>blkdeactivate</command></term>
308 <listitem>
309 <para>
310 is a utility to deactivate block device.
311 </para>
312 <indexterm zone="lvm2 blkdeactivate">
313 <primary sortas="b-blkdeactivate">blkdeactivate</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="dmeventd">
319 <term><command>dmeventd</command></term>
320 <listitem>
321 <para>
322 (optional) is the Device Mapper event daemon.
323 </para>
324 <indexterm zone="lvm2 dmeventd">
325 <primary sortas="b-dmeventd">dmeventd</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="dmsetup">
331 <term><command>dmsetup</command></term>
332 <listitem>
333 <para>
334 is a low level logical volume management tool.
335 </para>
336 <indexterm zone="lvm2 dmsetup">
337 <primary sortas="b-dmsetup">dmsetup</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="fsadm">
343 <term><command>fsadm</command></term>
344 <listitem>
345 <para>
346 is a utility used to resize or check filesystem on a device.
347 </para>
348 <indexterm zone="lvm2 fsadm">
349 <primary sortas="b-fsadm">fsadm</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="lvm">
355 <term><command>lvm</command></term>
356 <listitem>
357 <para>
358 provides the command-line tools for <application>LVM2</application>.
359 Commands are implemented via sympolic links to this program to
360 manage physical devices (pv*), volume groups (vg*) and logical
361 volumes (lv*).
362 </para>
363 <indexterm zone="lvm2 lvm">
364 <primary sortas="b-lvm">lvm</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="lvmconf">
370 <term><command>lvmconf</command></term>
371 <listitem>
372 <para>
373 is a script that modifies the locking configuration in
374 the <application>LVM2</application> configuration file.
375 </para>
376 <indexterm zone="lvm2 lvmconf">
377 <primary sortas="b-lvmconf">lvmconf</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="lvmdump">
383 <term><command>lvmdump</command></term>
384 <listitem>
385 <para>
386 is a tool used to dump various information concerning
387 <application>LVM2</application>.
388 </para>
389 <indexterm zone="lvm2 lvmdump">
390 <primary sortas="b-lvmdump">lvmdump</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="lvmetad">
396 <term><command>lvmetad</command></term>
397 <listitem>
398 <para>
399 (optional) is the LVM metadata daemon.
400 </para>
401 <indexterm zone="lvm2 lvmetad">
402 <primary sortas="b-lvmetad">lvmetad</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="vgimportclone">
408 <term><command>vgimportclone</command></term>
409 <listitem>
410 <para>
411 is used to import a duplicated VG (e.g. hardware snapshot).
412 </para>
413 <indexterm zone="lvm2 vgimportclone">
414 <primary sortas="b-vgimportclone">vgimportclone</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="libdevmapper">
420 <term><filename class='libraryfile'>libdevmapper.so</filename></term>
421 <listitem>
422 <para>
423 contains the <application>Device Mapper</application> API
424 functions.
425 </para>
426 <indexterm zone="lvm2 libdevmapper">
427 <primary sortas="c-libdevmapper">libdevmapper.so</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 </variablelist>
433
434 </sect2>
435
436</sect1>
Note: See TracBrowser for help on using the repository browser.