source: postlfs/filesystems/lvm2.xml@ a2b672b

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since a2b672b was 0936f56, checked in by Bruce Dubbs <bdubbs@…>, 7 months ago

Update to LVM2.2.03.12

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