Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms


lvm (78) Versions 1.3.1

Installs and manages Logical Volume Manager

cookbook 'lvm', '= 1.3.1'
cookbook 'lvm', '= 1.3.1', :supermarket
knife supermarket install lvm
knife supermarket download lvm
Quality 0%

lvm Cookbook

Build Status

Installs lvm2 package and includes resources for managing LVM. The default recipe simply installs LVM and the supporting Ruby gem. The cookbook includes providers for managing LVMs.


  • Chef 10 or higher



Manages LVM physical volumes.


<table> <tr> <th>Action</th> <th>Description</th> </tr> <tr> <td>:create</td> <td>(default) Creates a new physical volume</td> </tr> <tr> <td>:resize</td> <td>Resize an existing physical volume</td> </tr> </table>


<table> <tr> <th>Parameter</th> <th>Description</th> <th>Example</th> <th>Default</th> </tr> <tr> <td>name</td> <td>(required) The device to create the new physical volume on</td> <td><tt>'/dev/sda'</tt></td> <td></td> </tr> </table>

lvm_physical_volume '/dev/sda'


Manages LVM logical volumes.


<table> <tr> <th>Action</th> <th>Description</th> </tr> <tr> <td>:create</td> <td>(default) Creates a new logical volume</td> </tr> <tr> <td>:resize</td> <td>Resize an existing logical volume</td> </tr> </table>


<table> <tr> <th>Attribute</th> <th>Description</th> <th>Example</th> <th>Default</th> </tr> <tr> <td>name</td> <td>(name attribute) Name of the logical volume</td> <td><tt>bacon</tt></td> <td></td> </tr> <tr> <td>group</td> <td>(required) Volume group in which to create the new volume (not required if the volume is declared inside of an lvm_volume_group block)</td> <td><tt>bits</tt></td> <td></td> </tr> <tr> <td>size</td> <td>(required) Size of the volume. <ul> <li>It can be the size of the volume with units (k, K, m, M, g, G, t, T)</li> <li>It can be specified as the percentage of the size of the volume group</li> </ul> </td> <td> <ul> <li><tt>10G</tt></li> <li><tt>25%VG</tt></li> </ul> </td> <td></td> </tr> <tr> <td>filesystem</td> <td>The format for the file system</td> <td><tt>'ext4'</tt></td> <td></td> </tr> <tr> <td>filesystem_params</td> <td>Optional parameters to use when formatting the file system</td> <td><tt>'-j -L log -m 2 -i 10240 -J size=400 -b 4096'</tt></td> <td></td> </tr> <tr> <td>mount_point</td> <td> Either a String containing the path to the mount point, or a Hash with the following keys: <ul> <li><tt>location<tt> - (required) the directory to mount the volume on</li> <li><tt>options</tt> - the mount options for the volume</li> <li><tt>dump</tt> - the <tt>dump</tt> field for the fstab entry</li> <li><tt>pass</tt> - the <tt>pass</tt> field for the fstab entry</li> </ul> </td> <td><tt>'/var/my/mount'</tt></td> <td></td> </tr> <tr> <td>physical_volumes</td> <td>Array of physical volumes that the volume will be restricted to</td> <td><tt>['/dev/sda', '/dev/sdb']</tt></td> <td></td> </tr> <tr> <td>stripes</td> <td>Number of stripes for the volume</td> <td><tt>5</tt></td> <td></td> </tr> <tr> <td>stripe_size</td> <td>Number of kilobytes per stripe segment (must be a power of 2 less than or equal to the physical extent size for the volume group)</td> <td><tt>24</tt></td> <td></td> </tr> <tr> <td>mirrors</td> <td>Number of mirrors for the volume</td> <td><tt>5</tt></td> <td></td> </tr> <tr> <td>contiguous</td> <td>Whether or not volume should use the contiguous allocation policy</td> <td><tt>true</tt></td> <td><tt>false</tt></td> </tr> <tr> <td>readahead</td> <td>The readahead sector count for the volume (can be a value between 2 and 120, 'auto', or 'none')</td> <td><tt>'auto'</tt></td> <td></td> </tr> <td>take_up_free_space</td> <td>whether to have the LV take up the remainder of free space on the VG. Only valid for resize action</td> <td><tt>true</tt></td> <td>false</td> </tr> </table>

lvm_logical_volume 'home' do
  group       'vg00'
  size        '25%VG'
  filesystem  'ext4'
  mount_point '/home'
  stripes     3
  mirrors     2


Manages LVM volume groups.


<table> <tr> <th>Action</th> <th>Description</th> </tr> <tr> <td>:create</td> <td>(default) Creates a new volume group</td> </tr> <tr> <td>:extend</td> <td>Extend an existing volume group to include new physical volumes</td> </tr> </table>


<table> <tr> <th>Attribute</th> <th>Description</th> <th>Example</th> <th>Default</th> </tr> <tr> <td>name</td> <td>(required) Name of the volume group</td> <td><tt>'bacon'</tt></td> <td></td> </tr> <tr> <td>physical_volumes</td> <td>(required) The device or list of devices to use as physical volumes (if they haven't already been initialized as physical volumes, they will be initialized automatically)</td> <td><tt>['/dev/sda', '/dev/sdb']</tt></td> <td></td> </tr> <tr> <td>physical_extent_size</td> <td>The physical extent size for the volume group</td> <td></td> <td></td> </tr> <tr> <td>logical_volume</td> <td>Shortcut for creating a new lvm_logical_volume definition (the logical volumes will be created in the order they are declared)</td> <td></td> <td></td> </tr> </table>

lvm_volume_group 'vg00' do
  physical_volumes ['/dev/sda', '/dev/sdb', '/dev/sdc']

  logical_volume 'logs' do
    size        '1G'
    filesystem  'xfs'
    mount_point location: '/var/log', options: 'noatime,nodiratime'
    stripes     3

  logical_volume 'home' do
    size        '25%VG'
    filesystem  'ext4'
    mount_point '/home'
    stripes     3
    mirrors     2


If you're using Berkshelf, just add this cookbook to your Berksfile:

cookbook 'lvm'

You can also install it from the community site:

knife cookbook site install lvm

Include the default recipe in your run list on a node, in a role, or in another recipe:


Depend on lvm in any cookbook that uses its Resources/Providers:

# other_cookbook/metadata.rb
depends 'lvm'


This cookbook depends on the di-ruby-lvm and di-ruby-lvm-attrib gems. The di-ruby-lvm-attrib gem in particular is a common cause of failures when using the providers. If you get a failure with an error message similar to

No such file or directory - /opt/chef/.../di-ruby-lvm-attrib-0.0.3/lib/lvm/attributes/2.02.86(2)/lvs.yaml

then you are running a version of lvm that the gems do not support. However, getting support added is usually pretty easy. Just follow the instructions on "Adding Attributes" in the di-ruby-lvm-attrib README.


This section details "quick development" steps. For a detailed explanation, see [[]].

  1. Clone this repository from GitHub:

    $ git clone
  2. Create a git branch

    $ git checkout -b my_bug_fix
  3. Install dependencies:

    $ bundle install
  4. Make your changes/patches/fixes, committing appropiately

  5. Write tests

  6. Run the tests:

    • bundle exec foodcritic -f any .
    • bundle exec rspec
    • bundle exec rubocop
    • bundle exec kitchen test

In detail: - Foodcritic will catch any Chef-specific style errors - RSpec will run the unit tests - Rubocop will check for Ruby-specific style errors - Test Kitchen will run and converge the recipes

License and Authors

Copyright:: 2011, Opscode, Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

bigdata Applicable Versions
chef-provisioning-aws-helper Applicable Versions
drbd Applicable Versions
ephemeral_lvm Applicable Versions
filesystem Applicable Versions
ganeti Applicable Versions
gluster Applicable Versions
maxdb Applicable Versions
open-build-service Applicable Versions
openstack-block-storage Applicable Versions
sbuild Applicable Versions
server_utils Applicable Versions
zabbix_lwrp Applicable Versions

lvm Cookbook CHANGELOG

This file is used to list changes made in each version of the lvm cookbook.

v1.3.1 (2015-02-09)

  • #46 - Unbreak cookbook on Chef Client 12
  • #34 - Add ability to specify optional filesystem parameters when formatting

v1.3.0 (2014-07-09)

  • #32 - add support for resizing logical and physical volumes
  • #33 - [COOK-4701]: add ability to extend volume groups

v1.2.2 (2014-07-02)

No changes. Bumping for toolchain

v1.2.0 (2014-07-02)

COOK-2992: add support for resizing logical and physical volumes

v1.1.2 (2014-05-15)

  • [COOK-4609] Enable the logical volume if it is disabled

v1.1.0 (2014-04-10)

  • [COOK-4539] - Change default mount mode to 0755

v1.0.8 (2014-03-27)

No change. Bumping version for toolchain

v1.0.6 (2014-03-27)

  • [COOK-4486] - Add ChefSpec matchers for LVM resources
  • [COOK-4481] - The lvm_volume_group resource is not convergent

v1.0.4 (2013-12-28)


  • COOK-3987 - Volumes are created with the wrong # of extents. Size = '2%VG' is treated as a size of 2 extents.



  • COOK-3935 - fix minor typo
  • Fixing up style
  • Updating test harness



  • COOK-3357 - Complete refactor into a heavy-weight provider with tests




  • COOK-2348 - Fix lvm_logical_volume when mount_point parameter is a String



  • [COOK-3031]: ruby_block to create logical volume is improperly named, causing collisions


  • [COOK-2283] - lvm version mismatch on fresh amazon linux install
  • [COOK-2733] - Fix invalid only_if command in lvm cookbook
  • [COOK-2822] - install, don't upgrade, lvm2 package


  • [COOK-2348] - lvm logical_volume doesn't work with mount_point parameter as String


  • [COOK-1977] - Typo "stripesize" in LVM cookbook
  • [COOK-1994] - Cannot create a logical volume if fstype is not given


  • [COOK-1857] - lvm_logical_volume resource callback conflicts with code in provider.


  • Added providers for managing the creation of LVM physical volumes, volume groups, and logical volumes.


  • Current public release

Foodcritic Metric

1.3.1 failed this metric

FC031: Cookbook without metadata file: /tmp/cook/8bc5c7b52e238db165a60991/lvm/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/8bc5c7b52e238db165a60991/lvm/metadata.rb:1