Skip to content

Commit 3549910

Browse files
committed
logical_volume: docs cleanup
1 parent 2c95505 commit 3549910

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

manifests/logical_volume.pp

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,36 @@
1+
# @summary Manage a logical volume.
2+
#
13
# @param volume_group The volume group name associated with this logical volume.
24
# This will automatically set this volume group as a dependency,
35
# but it must be defined elsewhere using the volume_group resource type.
6+
#
47
# @param size Configures the size of the filesystem. Supports filesystem resizing. The size will be rounded up to the nearest multiple of
58
# the partition size.
9+
#
610
# @param initial_size The initial size of the logical volume. This will only apply to newly-created volumes
711
#
812
# @param ensure
13+
#
914
# @param options Params for the mkfs command
1015
#
1116
# @param pass
17+
#
1218
# @param dump
19+
#
1320
# @param fs_type The file system type. eg. ext3.
21+
#
1422
# @param mkfs_options
23+
#
1524
# @param mountpath
25+
#
1626
# @param mountpath_require
27+
#
1728
# @param mounted If puppet should mount the volume. This only affects what puppet will do, and not what will be mounted at boot-time.
29+
#
1830
# @param createfs
31+
#
1932
# @param extents The number of logical extents to allocate for the new logical volume. Set to undef to use all available space
33+
#
2034
# @param stripes The number of stripes to allocate for the new logical volume.
2135
#
2236
# @param stripesize The stripesize to use for the new logical volume.
@@ -27,30 +41,26 @@
2741
# (if the LV found is larger then the size requests this is just logged not causing a FAIL)
2842
#
2943
# @param size_is_minsize Lists strings for access control for connection method, users, databases, IPv4 addresses;
44+
#
3045
# @param type Configures the logical volume type. AIX only
3146
#
3247
# @param thinpool - Set to true to create a thin pool or to pool name to create thin volume
48+
#
3349
# @param poolmetadatasize Set the initial size of the logical volume pool metadata on creation
34-
50+
#
3551
# @param mirror The number of mirrors of the volume.
52+
#
3653
# @param mirrorlog How to store the mirror log (Allowed values: core, disk, mirrored).
37-
54+
#
3855
# @param no_sync An optimization in lvcreate, at least on Linux.
39-
56+
#
4057
# @param region_size A mirror is divided into regions of this size (in MB), the mirror log uses this granularity to track which regions
41-
# are in sync.
42-
# CAN NOT BE CHANGED on already mirrored volume.
58+
# are in sync. Cannot be changed on already mirrored volume.
4359
# Take your mirror size in terabytes and round up that number to the next power of 2, using that number as the -R argument
44-
45-
# @param alloc Selects the allocation policy when a command needs to allocate Physical Extents from the Volume Group. Allowed Values:
46-
# :anywhere
47-
# :contiguous
48-
# :cling
49-
# :inherit
50-
# :normal
51-
60+
#
61+
# @param alloc The allocation policy when a command needs to allocate Physical Extents from the Volume Group.
62+
#
5263
# @param yes_flag If set to true, do not prompt for confirmation interactively but always assume the answer yes.
53-
5464
#
5565
define lvm::logical_volume (
5666
String[1] $volume_group,

0 commit comments

Comments
 (0)