source: postlfs/filesystems/lvm2.xml@ bbc76b21

11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since bbc76b21 was bbc76b21, checked in by Pierre Labastie <pierre.labastie@…>, 2 years ago

(sysv): Remove an udev rule specific to systemd
  • Property mode set to 100644
File size: 15.7 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 "5a011a90e580f9e29df360a7c10332a1">
10 <!ENTITY lvm2-size "2.5 MB">
11 <!ENTITY lvm2-buildsize "37 MB (add 18 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 9 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 &lfs110a_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; Cache target (EXPERIMENTAL) [CONFIG_DM_CACHE]
126 &lt;*/M&gt; Mirror target [CONFIG_DM_MIRROR]
127 &lt;*/M&gt; Zero target [CONFIG_DM_ZERO]
128 &lt;*/M&gt; I/O delaying target [CONFIG_DM_DELAY]
129 [*] Block devices ---&gt;
130 &lt;*/M&gt; RAM block device support [CONFIG_BLK_DEV_RAM]
131Kernel hacking ---&gt;
132 Generic Kernel Debugging Instruments ---&gt;
133 [*] Magic SysRq key [CONFIG_MAGIC_SYSRQ]</literal></screen>
134
135 <indexterm zone="lvm2 lvm2-kernel">
136 <primary sortas="d-lvm2">lvm2</primary>
137 </indexterm>
138
139 </sect2>
140
141 <sect2 role="installation">
142 <title>Installation of LVM2</title>
143
144 <para>
145 Install <application>LVM2</application> by running the following
146 commands:
147 </para>
148
149<screen><userinput>PATH+=:/usr/sbin \
150./configure --prefix=/usr \
151 --enable-cmdlib \
152 --enable-pkgconfig \
153 --enable-udev_sync &amp;&amp;
154make</userinput></screen>
155
156 <para>
157 The tests use <application>udev</application> for logical volume
158 synchronization, so the LVM udev rules and some utilities need to
159 be installed before running the tests. If you are installing
160 <application>LVM2</application> for the first time, and do not
161 want to install the full package before running the tests, the minimal
162 set of utilities can be installed by running the following instructions
163 as the <systemitem class="username">root</systemitem> user:
164 </para>
165
166<screen role="root"
167 remap="test"><userinput>make -C tools install_tools_dynamic &amp;&amp;
168make -C udev install &amp;&amp;
169make -C libdm install</userinput></screen>
170
171 <para>
172 To test the results, issue, as the
173 <systemitem class="username">root</systemitem> user:
174 </para>
175
176<screen role="root"
177 remap="test"><userinput>LC_ALL=en_US.UTF-8 make S=lvconvert-repair-replace check_local</userinput></screen>
178
179 <para>
180 The <command>S=...</command> option allows to skip tests. The
181 <command>lvconvert-repair-replace</command> test has been reported
182 to hang.
183 Other targets are available and can be listed with
184 <command>make -C test help</command>. The test timings are very dependent
185 on the speed of the disk(s), and on the number of enabled kernel options.
186 </para>
187
188 <!-- Results for LVM2.2.02.176:
189 ### 292 tests: 177 passed, 46 skipped, 0 timed out, 60 warned, 9 failed
190
191 Results for LVM2.2.03.01:
192 ### 302 tests: 182 passed, 43 skipped, 0 timed out, 62 warned, 15 failed
193
194 Results for LVM2.2.03.05:
195 ### 326 tests: 255 passed, 58 skipped, 0 timed out, 2 warned, 11 failed
196
197 Results for LVM2.2.03.09:
198 ### 338 tests: 212 passed, 41 skipped, 0 timed out, 70 warned, 15 failed
199
200 Results for LVM2.2.03.11:
201 ### 357 tests: 231 passed, 32 skipped, 0 timed out, 77 warned, 17 failed
202
203 Results for LVM2.2.03.14:
204 ### 389 tests: 304 passed, 73 skipped, 0 timed out, 2 warned, 10 failed
205 -->
206
207 <para>
208 The tests do not implement the <quote>expected fail</quote> possibility,
209 and a small number of test failures is expected by upstream.
210 <!-- 1 -->More failures may happen because some kernel options are missing.
211 For example, the lack of the <emphasis>dm-delay</emphasis> device
212 mapper target explains some failures.
213 <!-- 2 -->Some tests may fail if there is insufficient free space available
214 in the partition with the /tmp directory. At least one test fails if 16 TB
215 is not available.
216 <!-- 3 -->Some tests are flagged <quote>warned</quote> if
217 <ulink url='https://github.com/jthornber/thin-provisioning-tools'>
218 thin-provisioning-tools</ulink> are not installed. A workaround is to
219 add the following flags to <command>configure</command>:
220 </para>
221
222<screen role="nodump"><userinput> --with-thin-check= \
223 --with-thin-dump= \
224 --with-thin-repair= \
225 --with-thin-restore= \
226 --with-cache-check= \
227 --with-cache-dump= \
228 --with-cache-repair= \
229 --with-cache-restore= \</userinput></screen>
230
231 <para>
232 Some tests may hang. They can be removed if necessary, for example:
233 <command>rm test/shell/lvconvert-raid-reshape.sh</command>. The tests
234 generate a lot of kernel messages, which may clutter your terminal. You
235 can disable them by issuing <command>dmesg -D</command> before running
236 the tests (do not forget to issue <command>dmesg -E</command> when tests
237 are done).
238
239 <note><simpara>The checks create device nodes in the /tmp directory. The
240 tests will fail if /tmp is mounted with the nodev option.
241 </simpara></note>
242 </para>
243
244 <para>
245 Now, as the <systemitem class="username">root</systemitem> user:
246 </para>
247
248<screen role="root" revision="sysv"><userinput>make install
249rm /usr/lib/udev/rules.d/69-dm-lvm.rules</userinput></screen>
250
251<screen role="root" revision="systemd"><userinput>make install
252make install_systemd_units</userinput></screen>
253
254 </sect2>
255
256 <sect2 role="commands">
257 <title>Command Explanations</title>
258
259 <para>
260 <command>PATH+=:/usr/sbin</command>: The path
261 must contain
262 <filename class='directory'>/usr/sbin</filename> for proper system tool
263 detection by the <command>configure</command> script. This instruction
264 ensures that PATH is properly set even if you build as an unprivileged user.
265 </para>
266
267 <para>
268 <parameter>--enable-cmdlib</parameter>: This switch enables
269 building of the shared command library. It is required
270 when building the event daemon.
271 </para>
272
273 <para>
274 <parameter>--enable-pkgconfig</parameter>: This switch enables
275 installation of <command>pkg-config</command> support files.
276 </para>
277
278 <para>
279 <parameter>--enable-udev_sync</parameter>: This switch enables
280 synchronisation with <application>Udev</application> processing.
281 </para>
282
283 <para>
284 <option>--enable-dmeventd</option>: This switch enables
285 building of the <application>Device Mapper</application>
286 event daemon.
287 </para>
288
289 <para revision="sysv">
290 <command>rm .../69-dm-lvm.rules</command>: Under certain circumstances,
291 this udev rule calls <command>systemd-run</command>, which is not
292 available on sysv. It performs actions that are done by another boot
293 script anyway, so it is not needed.
294 </para>
295
296 <para revision="systemd">
297 <command>make install_systemd_units</command>: This is needed to install
298 a unit that activates logical volumes at boot. It is not installed
299 by default.
300 </para>
301
302 </sect2>
303
304 <sect2 role="content">
305 <title>Contents</title>
306
307 <segmentedlist>
308 <segtitle>Installed Programs</segtitle>
309 <segtitle>Installed Libraries</segtitle>
310 <segtitle>Installed Directories</segtitle>
311
312 <seglistitem>
313 <seg>
314 blkdeactivate, dmeventd (optional), dmsetup, fsadm, lvm, lvmdump,
315 and lvm_import_vdo.
316 There are also numerous symbolic links to lvm that implement specific
317 functionalities
318 </seg>
319 <seg>
320 libdevmapper.so and liblvm2cmd.so; optional:
321 libdevmapper-event.so, libdevmapper-event-lvm2.so,
322 libdevmapper-event-lvm2mirror.so, libdevmapper-event-lvm2raid.so,
323 libdevmapper-event-lvm2snapshot.so, libdevmapper-event-lvm2thin.so,
324 and libdevmapper-event-lvm2vdo.so
325 </seg>
326 <seg>
327 /etc/lvm and
328 /usr/lib/device-mapper (optional)
329 </seg>
330 </seglistitem>
331 </segmentedlist>
332
333 <variablelist>
334 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
335 <?dbfo list-presentation="list"?>
336
337 <?dbhtml list-presentation="table"?>
338
339 <varlistentry id="blkdeactivate">
340 <term><command>blkdeactivate</command></term>
341 <listitem>
342 <para>
343 is a utility to deactivate block devices
344 </para>
345 <indexterm zone="lvm2 blkdeactivate">
346 <primary sortas="b-blkdeactivate">blkdeactivate</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="dmeventd">
352 <term><command>dmeventd</command></term>
353 <listitem>
354 <para>
355 (optional) is the Device Mapper event daemon
356 </para>
357 <indexterm zone="lvm2 dmeventd">
358 <primary sortas="b-dmeventd">dmeventd</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="dmsetup">
364 <term><command>dmsetup</command></term>
365 <listitem>
366 <para>
367 is a low level logical volume management tool
368 </para>
369 <indexterm zone="lvm2 dmsetup">
370 <primary sortas="b-dmsetup">dmsetup</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="fsadm">
376 <term><command>fsadm</command></term>
377 <listitem>
378 <para>
379 is a utility used to resize or check filesystem on a device
380 </para>
381 <indexterm zone="lvm2 fsadm">
382 <primary sortas="b-fsadm">fsadm</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="lvm">
388 <term><command>lvm</command></term>
389 <listitem>
390 <para>
391 provides the command-line tools for <application>LVM2</application>.
392 Commands are implemented via sympolic links to this program to
393 manage physical devices (pv*), volume groups (vg*) and logical
394 volumes (lv*)
395 </para>
396 <indexterm zone="lvm2 lvm">
397 <primary sortas="b-lvm">lvm</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <!--
403 <varlistentry id="lvmconf">
404 <term><command>lvmconf</command></term>
405 <listitem>
406 <para>
407 is a script that modifies the locking configuration in
408 the <application>LVM2</application> configuration file.
409 </para>
410 <indexterm zone="lvm2 lvmconf">
411 <primary sortas="b-lvmconf">lvmconf</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415 -->
416
417 <varlistentry id="lvmdump">
418 <term><command>lvmdump</command></term>
419 <listitem>
420 <para>
421 is a tool used to dump various information concerning
422 <application>LVM2</application>
423 </para>
424 <indexterm zone="lvm2 lvmdump">
425 <primary sortas="b-lvmdump">lvmdump</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="vgimportclone">
431 <term><command>vgimportclone</command></term>
432 <listitem>
433 <para>
434 is used to import a duplicated VG (e.g. hardware snapshot)
435 </para>
436 <indexterm zone="lvm2 vgimportclone">
437 <primary sortas="b-vgimportclone">vgimportclone</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="libdevmapper">
443 <term><filename class="libraryfile">libdevmapper.so</filename></term>
444 <listitem>
445 <para>
446 contains the <application>Device Mapper</application> API
447 functions
448 </para>
449 <indexterm zone="lvm2 libdevmapper">
450 <primary sortas="c-libdevmapper">libdevmapper.so</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 </variablelist>
456
457 </sect2>
458
459</sect1>
Note: See TracBrowser for help on using the repository browser.