Skip to content

Commit 82e1ee2

Browse files
author
Dylan Ratcliffe
committed
README update
1 parent a0f9a5f commit 82e1ee2

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,40 @@ parameters documented above also apply to AIX systems.
287287
* range (Parameter) - Sets the inter-physical volume allocation policy. AIX only
288288
* type (Parameter) - Configures the logical volume type. AIX only
289289

290+
## Functions
291+
292+
`lvm::bytes_to_size`: Converts a number of bytes to a size format that LVM can understand e.g. `lvm::bytes_to_size(214748364800)` would return `200g`
293+
294+
`lvm::size_to_bytes`: Converts an LVM size to bytes, the opposite of `lvm::bytes_to_size`.
295+
296+
## Tasks
297+
298+
Documented in the ["Tasks" tab](https://forge.puppet.com/puppetlabs/lvm/tasks) on the forge
299+
300+
## Plans
301+
302+
### `lvm::expand`
303+
304+
Executes common tasks for expanding mounts, this can include:
305+
306+
* Creating PVs
307+
* Adding PVs to VG
308+
* Extending LV
309+
* Extending filesystem
310+
311+
**Parameters:**
312+
313+
`server`: *String* The target for the plan
314+
315+
`volume_group`: *String* The volume group to which the logical volume belongs
316+
317+
`logical_volume`: *String* The logical volume which is to be expanded
318+
319+
`additional_size`: *String* How much size to add to the LV. This should be specified in LVM format i.e. "200m" or "2.5g"
320+
321+
`disks`: *Array[String]* Any physical disks that should be added to the volume group as part of the expand process
322+
323+
`resize_fs`: *Boolean* Whether or not to resize the filesystem
290324

291325
## Limitations
292326

0 commit comments

Comments
 (0)