Puppet LVM Module

Provides Logical Resource Management (LVM) features for Puppet.

History

2012-08-14 : rcoleman

• Version 0.1.1 : More style-guide compliant, fixed a closing } bug and updated README

2011-08-30 : matthaus

• Version 0.1.0 : Refactor tests, update readme, repackage for module forge

2011-08-02 : zyv

• Make it possible to omit the file system type for lmv::volume

2011-07-12 : frimik

• Allow filesystem type to accept parameters [:options]

2011-06-30 : windowsrefund

• lvm::volume now uses defined() in order to avoid declaring duplicate physical_volume and/or volume_group resources.

• logical_volume provider now calls dmsetup when removing a volume.

Usage

This module provides four resource types (and associated providers): volume_group, logical_volume, physical_volume, and filesystem.

The basic dependency graph needed to define a working logical volume looks something like:

filesystem -> logical_volume -> volume_group -> physical_volume(s)

Here's a simple working example:

physical_volume { '/dev/hdc':
  ensure => present,
}

volume_group { 'myvg':
  ensure           => present,
  physical_volumes => '/dev/hdc',
}

logical_volume { 'mylv':
  ensure       => present,
  volume_group => 'myvg',
  size         => '20G',
}

filesystem { '/dev/myvg/mylv':
  ensure  => present,
  fs_type => 'ext3',
  options => '-b 4096 -E stride=32,stripe-width=64',
}

This simple 1 physical volume, 1 volume group, 1 logical volume case is provided as a simple volume definition, as well. The above could be shortened to be:

lvm::volume { 'mylv':
  ensure => present,
  vg     => 'myvg',
  pv     => '/dev/hdc',
  fstype => 'ext3',
  size   => '20G',
}

You can also describe your Volume Group like this:

class { 'lvm':
  volume_groups    => {
    'myvg' => {
      physical_volumes => [ '/dev/sda2', '/dev/sda3', ],
      logical_volumes  => {
        'opt'    => {'size' => '20G'},
        'tmp'    => {'size' => '1G' },
        'usr'    => {'size' => '3G' },
        'var'    => {'size' => '15G'},
        'home'   => {'size' => '5G' },
        'backup' => {
          'size'              => '5G',
          'mountpath'         => '/var/backups',
          'mountpath_require' => true,
        },
      },
    },
  },
}

This could be really convenient when used with hiera:

include ::lvm

and

---
lvm::volume_groups:
  myvg:
    physical_volumes:
      - /dev/sda2
      - /dev/sda3
    logical_volumes:
      opt:
        size: 20G
      tmp:
        size: 1G
      usr:
        size: 3G
      var:
        size: 15G
      home:
        size: 5G
      backup:
        size: 5G
        mountpath: /var/backups
        mountpath_require: true

Except that in the latter case you cannot specify create options.

If you want to omit the file system type, but still specify the size of the logical volume, i.e. in the case if you are planning on using this logical volume as a swap partition or a block device for a virtual machine image, you need to use a hash to pass the parameters to the definition.

If you need a more complex configuration, you'll need to build the resources out yourself.

Optional Values

The unless_vg (physical_volume) and createonly (volume_group) will check to see if "myvg" exists. If "myvg" does exist then they will not modify the physical volume or volume_group. This is usefull if you environment is build with certain disks but they change while the server grows, shrinks or moves.

Example:

physical_volume { "/dev/hdc":
    ensure => present,
    unless_vg => "myvg"
}
volume_group { "myvg":
    ensure => present,
    physical_volumes => "/dev/hdc",
    createonly => true
}

Limitations

Namespacing

Due to puppet's lack of composite keys for resources, you currently cannot define two logical_volume resources with the same name but a different volume_group.

Removing Physical Volumes

You should not remove a physical_volume from a volume_group without ensuring the physical volume is no longer in use by a logical volume (and possibly doing a data migration with the pvmove executable).

Removing a physical_volume from a volume_group resource will cause the pvreduce to be executed -- no attempt is made to ensure pvreduce does not attempt to remove a physical volume in-use.

Resizing Logical Volumes

Logical volume size can be extended, but not reduced -- this is for safety, as manual intervention is probably required for data migration, etc.

Contributors

Bruce Williams [email protected]

Daniel Kerwin [email protected]

Luke Kanies [email protected]

Matthaus Litteken [email protected]

Michael Stahnke [email protected]

Mikael Fridh [email protected]

Tim Hawes [email protected]

Yury V. Zaytsev [email protected]

csschwe [email protected]

windowsrefund [email protected]

Adam Gibbins [email protected]

Steffen Zieger [email protected]

Jason A. Smith [email protected]

Mathieu Bornoz [email protected]

Cédric Jeanneret [email protected]

Raphaël Pinson [email protected]

Garrett Honeycutt [email protected]

More Contributers