Installs lvm2 package and includes custom resources (providers) for managing LVM.
- Debian/Ubuntu
- RHEL/CentOS/Scientific/Amazon/Oracle
- Chef 12+
- none
Manages LVM physical volumes.
Action | Description |
---|---|
:create | (default) Creates a new physical volume |
:resize | Resize an existing physical volume |
Parameter | Description | Example | Default |
---|---|---|---|
name | (required) The device to create the new physical volume on | '/dev/sda' |
lvm_physical_volume '/dev/sda'
Manages LVM logical volumes.
Action | Description |
---|---|
:create | (default) Creates a new logical volume |
:resize | Resize an existing logical volume |
Attribute | Description | Example | Default |
---|---|---|---|
name | (name attribute) Name of the logical volume | bacon | |
group | (required) Volume group in which to create the new volume (not required if the volume is declared inside of an `lvm_volume_group` block) | bits | |
size | (required) Size of the volume.
|
|
|
filesystem | The format for the file system | 'ext4' | |
filesystem_params | Optional parameters to use when formatting the file system | '-j -L log -m 2 -i 10240 -J size=400 -b 4096' | |
mount_point |
Either a String containing the path to the mount point, or a Hash with the following keys:
|
'/var/my/mount' | |
physical_volumes | Array of physical volumes that the volume will be restricted to | ['/dev/sda', '/dev/sdb'] | |
stripes | Number of stripes for the volume | 5 | |
stripe_size | 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) | 24 | |
mirrors | Number of mirrors for the volume | 5 | |
contiguous | Whether or not volume should use the contiguous allocation policy | true | false |
readahead | The readahead sector count for the volume (can be a value between 2 and 120, 'auto', or 'none') | 'auto' | |
take_up_free_space | whether to have the LV take up the remainder of free space on the VG. Only valid for resize action | true | false |
lvm_logical_volume 'home' do
group 'vg00'
size '25%VG'
filesystem 'ext4'
mount_point '/home'
stripes 3
mirrors 2
end
Manages LVM thin pools (which are simply logical volumes created with the --thinpool argument to lvcreate).
Action | Description |
---|---|
:create | (default) Create a new thin pool logical volume |
:resize | Resize an existing thin pool logical volume |
Attribute | Description | Example | Default |
---|---|---|---|
name | (name attribute) Name of the logical volume | bacon | |
group | (required) Volume group in which to create the new volume (not required if the volume is declared inside of an `lvm_volume_group` block) | bits | |
size | (required) Size of the volume.
|
|
|
filesystem | The format for the file system | 'ext4' | |
filesystem_params | Optional parameters to use when formatting the file system | '-j -L log -m 2 -i 10240 -J size=400 -b 4096' | |
mount_point |
Either a String containing the path to the mount point, or a Hash with the following keys:
|
'/var/my/mount' | |
physical_volumes | Array of physical volumes that the volume will be restricted to | ['/dev/sda', '/dev/sdb'] | |
stripes | Number of stripes for the volume | 5 | |
stripe_size | 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) | 24 | |
mirrors | Number of mirrors for the volume | 5 | |
contiguous | Whether or not volume should use the contiguous allocation policy | true | false |
readahead | The readahead sector count for the volume (can be a value between 2 and 120, 'auto', or 'none') | 'auto' | |
take_up_free_space | whether to have the LV take up the remainder of free space on the VG. Only valid for resize action | true | false |
thin_volume | Shortcut for creating a new `lvm_thin_volume` definition (the volumes will be created in the order they are declared) |
Manages LVM thin volumes (which are simply logical volumes created with the --thin argument to lvcreate and are contained inside of other logical volumes that were created with the --thinpool option to lvcreate).
Action | Description |
---|---|
:create | (default) Create a new thin logical volume |
:resize | Resize an existing thin logical volume |
Attribute | Description | Example | Default |
---|---|---|---|
name | (name attribute) Name of the logical volume | bacon | |
group | (required) Volume group in which to create the new volume (not required if the volume is declared inside of an `lvm_volume_group` block) | bits | |
pool | (required) Thin pool volume in which to create the new volume (not required if the volume is declared inside of an `lvm_thin_pool` block) | bits | |
size | (required) Size of the volume.
|
|
|
filesystem | The format for the file system | 'ext4' | |
filesystem_params | Optional parameters to use when formatting the file system | '-j -L log -m 2 -i 10240 -J size=400 -b 4096' | |
mount_point |
Either a String containing the path to the mount point, or a Hash with the following keys:
|
'/var/my/mount' |
lvm_thin_volume 'thin01' do
group 'vg00'
pool 'lv-thin-pool'
size '5G'
filesystem 'ext4'
mount_point location: '/var/thin01', options: 'noatime,nodiratime'
end
Manages LVM volume groups.
Action | Description |
---|---|
:create | (default) Creates a new volume group |
:extend | Extend an existing volume group to include new physical volumes |
Attribute | Description | Example | Default |
---|---|---|---|
name | (required) Name of the volume group | 'bacon' | |
physical_volumes | (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) | ['/dev/sda', '/dev/sdb'] | |
physical_extent_size | The physical extent size for the volume group | ||
logical_volume | Shortcut for creating a new `lvm_logical_volume` definition (the logical volumes will be created in the order they are declared) | ||
wipe_signatures | Force the creation of the Volume Group, even if `lvm` detects existing non-LVM data on disk | `true` | `false` |
thin_pool | Shortcut for creating a new `lvm_thin_pool` definition (the logical volumes will be created in the order they are declared) |
lvm_volume_group 'vg00' do
physical_volumes ['/dev/sda', '/dev/sdb', '/dev/sdc']
wipe_signatures true
logical_volume 'logs' do
size '1G'
filesystem 'xfs'
mount_point location: '/var/log', options: 'noatime,nodiratime'
stripes 3
end
logical_volume 'home' do
size '25%VG'
filesystem 'ext4'
mount_point '/home'
stripes 3
mirrors 2
end
thin_pool "lv-thin-pool" do
size '5G'
stripes 2
thin_volume "thin01" do
size '10G'
filesystem 'ext4'
mount_point location: '/var/thin01', options: 'noatime,nodiratime'
end
end
end
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:
run_list(
'recipe[lvm::default]'
)
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.
- Author:: Joshua Timberman [email protected]
- Author:: Greg Symons [email protected]
Copyright:: 2011-2015, Chef Software, 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
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.