Merge pull request #331 from kenyon/docs-fixes

Documentation cleanup

Author: bastelfreak

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: "Publish module"
 
 on:
   workflow_dispatch:
-  
+ 
 jobs:
   release: 
     uses: "puppetlabs/cat-github-actions/.github/workflows/module_release.yml@main"

.rubocop.yml

@@ -5,7 +5,7 @@ require:
 AllCops:
   NewCops: enable
   DisplayCopNames: true
-  TargetRubyVersion: '2.7'
+  TargetRubyVersion: '2.6'
   Include:
   - "**/*.rb"
   Exclude:
@@ -529,6 +529,8 @@ Lint/DuplicateBranch:
   Enabled: false
 Lint/DuplicateMagicComment:
   Enabled: false
+Lint/DuplicateMatchPattern:
+  Enabled: false
 Lint/DuplicateRegexpCharacterClassElement:
   Enabled: false
 Lint/EmptyBlock:
@@ -645,6 +647,8 @@ Style/ComparableClamp:
   Enabled: false
 Style/ConcatArrayLiterals:
   Enabled: false
+Style/DataInheritance:
+  Enabled: false
 Style/DirEmpty:
   Enabled: false
 Style/DocumentDynamicEvalDefinition:
@@ -713,6 +717,8 @@ Style/RedundantHeredocDelimiterQuotes:
   Enabled: false
 Style/RedundantInitialize:
   Enabled: false
+Style/RedundantLineContinuation:
+  Enabled: false
 Style/RedundantSelfAssignmentBranch:
   Enabled: false
 Style/RedundantStringEscape:

Gemfile

@@ -22,16 +22,15 @@ group :development do
   gem "racc", '~> 1.4.0',                        require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
   gem "voxpupuli-puppet-lint-plugins", '~> 5.0', require: false
   gem "facterdb", '~> 1.18',                     require: false
-  gem "metadata-json-lint", '~> 3.0',            require: false
+  gem "metadata-json-lint", '~> 4.0',            require: false
   gem "puppetlabs_spec_helper", '~> 6.0',        require: false
   gem "rspec-puppet-facts", '~> 2.0',            require: false
-  gem "codecov", '~> 0.2',                       require: false
   gem "dependency_checker", '~> 1.0.0',          require: false
   gem "parallel_tests", '= 3.12.1',              require: false
   gem "pry", '~> 0.10',                          require: false
-  gem "simplecov-console", '~> 0.5',             require: false
+  gem "simplecov-console", '~> 0.9',             require: false
   gem "puppet-debugger", '~> 1.0',               require: false
-  gem "rubocop", '= 1.48.1',                     require: false
+  gem "rubocop", '~> 1.50.0',                    require: false
   gem "rubocop-performance", '= 1.16.0',         require: false
   gem "rubocop-rspec", '= 2.19.0',               require: false
   gem "puppet-strings", '~> 4.0',                require: false

README.md

@@ -168,165 +168,13 @@ volume_group { "myvg":
 }
 ```
 
-## Type Documentation
-
-### filesystem
-
-* name (Parameter) (Namevar)
-* ensure (Property)
-* fs_type (Parameter) - The file system type. eg. ext3.
-* mkfs_cmd (Parameter) - Command to use to create the file system. Defaults to `mkswap` for `fs_type=swap`, otherwise `mkfs.{fs_type}`
-* options (Parameter) - Params for the mkfs command. eg. `-l internal,agcount=x`
-
-### logical_volume
-
-* name (Parameter) (Namevar) - The name of the logical volume. This is the unqualified name and will be automatically added to the volume group’s device path (e.g., ‘/dev/$vg/$lv’).
-* ensure (Property)
-* alloc (Parameter) - Selects the allocation policy when a command needs to allocate Physical Extents from the Volume Group. Allowed Values:
-    - `:anywhere`
-    - `:contiguous`
-    - `:cling`
-    - `:inherit`
-    - `:normal`
-* extents (Parameter) - The number of logical extents to allocate for the new logical volume. Set to undef to use all available space
-* initial_size (Parameter) - The initial size of the logical volume. This will only apply to newly-created volumes
-* minor (Parameter) - Set the minor number
-* mirror (Property) - The number of mirrors of the volume.
-* mirrorlog (Property) - How to store the mirror log (core, disk, mirrored).  Allowed Values:
-   -  `:core`
-   -  `:disk`
-   -  `:mirrored`
-* mounted - If puppet should mount the volume. This only affects what puppet will do, and not what will be mounted at boot-time.
-* no_sync (Parameter) - An optimization in lvcreate, at least on Linux.
-* persistent (Parameter) - Set to true to make the block device persistent
-* poolmetadatasize (Parameter) - Set the initial size of the logical volume pool metadata on creation
-* readahead (Parameter) - The readahead count to use for the new logical volume.
-* region_size (Parameter) - A mirror is divided into regions of this size (in MB), the mirror log uses this granularity to track which regions are in sync. CAN NOT BE CHANGED on already mirrored volume. Take your mirror size in terabytes and round up that number to the next power of 2, using that number as the -R argument.
-* size (Property) - The size of the logical volume. Set to undef to use all available space
-* size_is_minsize (Parameter) Default value: `false` - Set to true if the ‘size’ parameter specified, is just the minimum size you need (if the LV found is larger then the size requests this is just logged not causing a FAIL)
-* stripes (Parameter) - The number of stripes to allocate for the new logical volume.
-* stripesize (Parameter) - The stripesize to use for the new logical volume.
-* thinpool (Parameter) - Default value: `false` - Set to true to create a thin pool or to pool name to create thin volume
-* volume_group (Parameter) - The volume group name associated with this logical volume. This will automatically set this volume group as a dependency, but it must be defined elsewhere using the volume_group resource type.
-* yes_flag (Parameter) - Default value: `false` - If set to true, do not prompt for confirmation interactively but always assume the answer yes.
-
-### physical_volume
-
-* name (Parameter) (Namevar)
-* ensure (Property) -
-* force (Parameter) Default value: `false` - Force the creation without any confirmation. Allowed Values:
-   - `true`
-   - `false`
-* unless_vg (Parameter) - Do not do anything if the VG already exists. The value should be the name of the volume group to check for.
-
-### volume_group
-
-* name (Parameter) (Namevar) - The name of the volume group.
-* ensure (Property)
-* createonly (Parameter) Default value: false - If set to true the volume group will be created if it does not exist. If the volume group does exist no action will be taken. Defaults to `false`.  Allowed Values:
-   - `true`
-   - `false`
-* followsymlinks (Parameter) - If set to true all current and wanted values of the physical_volumes property will be followed to their real files on disk if they are in fact symlinks. This is useful to have Puppet determine what the actual PV device is if the property value is a symlink, like '/dev/disk/by-path/xxxx -> ../../sda'. Defaults to `false`.
-* physical_volumes (Property) - The list of physical volumes to be included in the volume group; this will automatically set these as dependencies, but they must be defined elsewhere using the physical_volume resource type.
-
-## AIX Specific Type Documentation
-
-There are a number of AIX specific parameters and properties. The regular
-parameters documented above also apply to AIX systems.
-
-### filesystem
-
-* accounting (Parameter) - Specify accounting subsystem support, Allowed Values:
-    * `true`
-    * `false`
-* ag_size (Parameter) - Specify the allocation group size in megabytes, Allowed Values:
-    * `/\d+/`
-* agblksize (Parameter) - JFS2 block size in bytes, Allowed Values:
-    * `/\d+/`
-* atboot (Parameter) - Specify whether the file system is mounted at boot time, Allowed Values:
-    * `true`
-    * `false`
-* compress (Parameter) - Data compression, LZ or no. Allowed Values:
-    * `:LG`
-    * `:no`
-* device (Parameter) - Device to create the filesystem on, this can be a device or a logical volume.
-* encrypted (Parameter) - Specify and encrypted filesystem. Allowed Values:
-    * `true`
-    * `false`
-* extended_attributes (Parameter) - Format to be used to store extended attributes. Allowed Values:
-    * `:v1`
-    * `:v2`
-* frag (Parameter) - JFS fragment size in bytes.  Allowed Values:
-    * `/\d+/`
-* initial_size (Parameter) - Initial size of the filesystem, Used only for resource creation, when using this option Puppet will not manage or maintain the size. To resize filesystems see the size property.
-* isnapshot (Parameter) - Specify whether the filesystem supports internal snapshots, Allowed Values:
-    * `true`
-    * `false`
-* large_files (Parameter) - Large file enabled file system. Allowed Values:
-    * `true`
-    * `false`
-* log_partitions (Parameter) - Specify the size of the log logical volume as number of logical partitions,
-* logname (Parameter) - Configure the log logical volume.
-* logsize (Parameter) - Size for an inline log in MB, Allowed Values:
-    * `/\d+/`
-* maxext (Parameter) - Size of a file extent in file system blocks, Allowed Values:
-    * `/\d+/`
-* mount_options (Parameter) - Specify the options to be passed to the mount command.
-* mountgroup (Parameter) - Mount group for the filesystem,
-* mountguard (Parameter) - Enable the mountguard. Allowed Values:
-    * `true`
-    * `false`
-* nbpi (Parameter) - Bytes per inode. Allowed Values:
-    * `/\d+/`
-* nodename (Parameter) - Specify the remote host where the filesystem resides.
-* perms (Parameter) - Permissions for the filesystem, Allowed Values:
-    * `:ro`
-    * `:rw`
-* size (Property) - Configures the size of the filesystem. Supports filesystem resizing. The size will be rounded up to the nearest multiple of the partition size.
-* vix (Parameter) - Specify that the file system can allocate inode extents smaller than the default, Allowed Values:
-    * `true`
-    * `false`
-* volume_group (Parameter) - Volume group that the file system should be created on.
-
-### logical_volume
-
-* range (Parameter) - Sets the inter-physical volume allocation policy. AIX only
-* type (Parameter) - Configures the logical volume type. AIX only
-
-## Functions
-
-`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`
-
-`lvm::size_to_bytes`: Converts an LVM size to bytes, the opposite of `lvm::bytes_to_size`.
-
 ## Tasks
 
-Documented in the ["Tasks" tab](https://forge.puppet.com/puppetlabs/lvm/tasks) on the forge
+See [tasks reference](REFERENCE.md#tasks)
 
 ## Plans
 
-### `lvm::expand`
-
-Executes common tasks for expanding mounts, this can include:
-
-* Creating PVs
-* Adding PVs to VG
-* Extending LV
-* Extending filesystem
-
-**Parameters:**
-
-`server`: *String* The target for the plan
-
-`volume_group`: *String* The volume group to which the logical volume belongs
-
-`logical_volume`: *String* The logical volume which is to be expanded
-
-`additional_size`: *String* How much size to add to the LV. This should be specified in LVM format i.e. "200m" or "2.5g"
-
-`disks`: *Array[String]* Any physical disks that should be added to the volume group as part of the expand process
-
-`resize_fs`: *Boolean* Whether or not to resize the filesystem
+See [plans reference](REFERENCE.md#plans)
 
 ## Limitations
 
@@ -362,7 +210,15 @@ Some facts reported by this module are being deprecated in favor of upcoming str
 
 ## License
 
-This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.
+This codebase is licensed under the GPL 2.0, however due to the nature of the
+codebase the open source dependencies may also use a combination of
+[AGPL](https://opensource.org/license/agpl-v3/),
+[BSD-2](https://opensource.org/license/bsd-2-clause/),
+[BSD-3](https://opensource.org/license/bsd-3-clause/),
+[GPL2.0](https://opensource.org/license/gpl-2-0/),
+[LGPL](https://opensource.org/license/lgpl-3-0/),
+[MIT](https://opensource.org/license/mit/) and
+[MPL](https://opensource.org/license/mpl-2-0/).
 
 # Contributors