source: postlfs/filesystems/lvm2.xml@ 64cb61a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY lvm2-download-http " ">
  <!ENTITY lvm2-download-ftp  "ftp://sources.redhat.com/pub/lvm2/LVM2.&LVM2-version;.tgz">
  <!ENTITY lvm2-md5sum        "321429cd1b1526a29cf6d75018b1e4bb">
  <!ENTITY lvm2-size          "1 MB">
  <!ENTITY lvm2-buildsize     "15 MB">
  <!ENTITY lvm2-time          "0.3 SBU">
]>

<sect1 id="lvm2" xreflabel="lvm-&lvm2-version;">
  <?dbhtml filename="lvm2.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>lvm2-&lvm2-version;</title>

  <indexterm zone="lvm2">
    <primary sortas="a-lvm2">lvm2</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to lvm2</title>

    <para>The <application>lvm2</application> package is a package that manages
    logical partitions.  It allows spanning of file systems across multiple
    physical disks and disk partitions and provides for dynamic growing or shrinking
    of logical partitions.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <!--<listitem>
        <para>Download (HTTP): <ulink url="&lvm2-download-http;"/></para>
      </listitem>-->
      <listitem>
        <para>Download (FTP): <ulink url="&lvm2-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &lvm2-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &lvm2-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &lvm2-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &lvm2-time;</para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/lvm2"/></para>

  </sect2>

  <sect2 role="kernel" id='lvm2-kernel'>
    <title>Kernel Configuration</title>

    <para>Enable the following option in the kernel configuration
    and recompile the kernel:</para>

<screen><literal>Device Drivers ---&gt;
  Multiple devices driver support (RAID and LVM): Y
    Device mapper support: Y or M
    Crypt target support: (optional)
    Snapshot target: (optional)
    Mirror target: (optional) </literal></screen>

    <indexterm zone="lvm2 lvm2-kernel">
      <primary sortas="d-lvm2">lvm2</primary>
    </indexterm>

  </sect2>

  <sect2 role="installation">
    <title>Installation of lvm2</title>

    <para>Install <application>lvm2</application> by running the following
    commands:</para>

<screen><userinput>./configure --sbindir=/sbin --libdir=/lib --enable-pkgconfig &amp;&amp;
make</userinput></screen>

    <!-- Note, there is a test suite (make check), but it is for LVM2 -->

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--enable-pkgconfig</parameter>: This parameter installs
    pkgconfig support.</para>

    <para><option>--enable-dmeventd</option>: This option builds the
    device-mapper event daemon.</para>

    <para><option>--enable-cmdlib</option>: This option builds the shared
    command library. It is required when building the daemon.</para>

  </sect2>

  <!-- TODO  FIXME Need to create a boot script for dmeventd (devmapper-event)
  According to CBLFS, only needed in very specific situations.

  <sect2 role="configuration">
    <title>Configuring device-mapper</title>

    <sect3  id="device-mapper-init">
      <title>Boot Script</title>

      <para>To automatically start the <command>device-mapper</command> daemon
      when the system is rebooted, install the
      <filename>/etc/rc.d/init.d/device-mapper</filename>
      bootscript from the
      <xref linkend="bootscripts"/> package.</para>

      <indexterm zone="device-mapper device-mapper-init">
        <primary sortas="f-device-mapper">device-mapper</primary>
      </indexterm>

<screen role="root"><userinput>make install-device-mapper</userinput></screen>

    </sect3>

  </sect2>

  -->

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>dmsetup, fsadm, lvm, lvmconf, lvndump, vgimportclone.  There
        are also numerous symbolic links to lvm to impement specific 
        functionality.</seg>
        <seg>libdevmapper.so</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="dmsetup">
        <term><command>dmsetup</command></term>
        <listitem>
          <para>is a low level logical volume management tool.</para>
          <indexterm zone="lvm2 dmsetup">
            <primary sortas="b-dmsetup">dmsetup</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fsadm">
        <term><command>fsadm</command></term>
        <listitem>
          <para>is a utility to resize or check filesystem on a device.</para>
          <indexterm zone="lvm2 fsadm">
            <primary sortas="b-fsadm">fsadm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lvm">
        <term><command>lvm</command></term>
        <listitem>
          <para>provides the command-line tools for lvm2.  Commands are
          implemented via sympolic links to this program to manage physical 
          devices (pv*), volume groups (vg*), and logical volumes (lv*).</para>
          <indexterm zone="lvm2 lvm">
            <primary sortas="b-lvm">lvm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lvmconf">
        <term><command>lvmconf</command></term>
        <listitem>
          <para>is a script that modifies the locking configuration in 
          an lvm configuration file.</para>
          <indexterm zone="lvm2 lvmconf">
            <primary sortas="b-lvmconf">lvmconf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lvmdump">
        <term><command>lvmdump</command></term>
        <listitem>
          <para>is a tool to dump various information concerning lvm2.</para>
          <indexterm zone="lvm2 lvmdump">
            <primary sortas="b-lvmdump">lvmdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vgimportclone">
        <term><command>vgimportclone</command></term>
        <listitem>
          <para>is used to import a duplicated VG (e.g. hardware snapshot).</para>
          <indexterm zone="lvm2 vgimportclone">
            <primary sortas="b-vgimportclone">vgimportclone</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libdevmapper">
        <term><filename class='libraryfile'>libdevmapper.so</filename></term>
        <listitem>
          <para>contains the <application>device-mapper</application> API
          functions.</para>
          <indexterm zone="lvm2 libdevmapper">
            <primary sortas="c-libdevmapper">libdevmapper.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>