Merge pull request #83 from Valantin/doc-supported

Document parameter supported
voxpupuli · Mar 21, 2024 · 90026ca · 90026ca
2 parents 00b7899 + 0f0a144
commit 90026ca
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 9 deletions.
diff --git a/README.markdown b/README.markdown
@@ -164,6 +164,11 @@ Pattern to look for in the process table to determine if the daemon is running.
 Only set this if your platform is not supported or you know what you are doing.
 Default: vmtoolsd
 
+##### `supported`
+
+Boolean that overrides the resulte of the supported OS check
+Default: undef
+
 ##### `uninstall_vmware_tools`
 
 Boolean that determines whether the conflicting VMWare Tools package should

diff --git a/REFERENCE.md b/REFERENCE.md
@@ -26,6 +26,14 @@ Install the Open Virtual Machine Tools.
 include openvmtools
 ```
 
+##### Force pass supported os check on OS non in supported list
+
+```puppet
+class { 'openvmtools':
+  supported => true,
+}
+```
+
 #### Parameters
 
 The following parameters are available in the `openvmtools` class:
@@ -41,9 +49,9 @@ The following parameters are available in the `openvmtools` class:
 * [`service_hasstatus`](#-openvmtools--service_hasstatus)
 * [`service_name`](#-openvmtools--service_name)
 * [`service_pattern`](#-openvmtools--service_pattern)
+* [`supported`](#-openvmtools--supported)
 * [`uninstall_vmware_tools`](#-openvmtools--uninstall_vmware_tools)
 * [`with_desktop`](#-openvmtools--with_desktop)
-* [`supported`](#-openvmtools--supported)
 
 ##### <a name="-openvmtools--ensure"></a>`ensure`
 
@@ -147,6 +155,14 @@ doing.
 
 Default value: `undef`
 
+##### <a name="-openvmtools--supported"></a>`supported`
+
+Data type: `Optional[Boolean]`
+
+Boolean that overrides the result of the supported OS check
+
+Default value: `undef`
+
 ##### <a name="-openvmtools--uninstall_vmware_tools"></a>`uninstall_vmware_tools`
 
 Data type: `Boolean`
@@ -164,14 +180,6 @@ Whether or not to install the desktop/GUI support.
 
 Default value: `false`
 
-##### <a name="-openvmtools--supported"></a>`supported`
-
-Data type: `Optional[Boolean]`
-
-
-
-Default value: `undef`
-
 ## Functions
 
 ### <a name="openvmtools--supported"></a>`openvmtools::supported`

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -47,6 +47,9 @@
 #   Only set this if your platform is not supported or you know what you are
 #   doing.
 #
+# @param supported
+#   Boolean that overrides the result of the supported OS check
+#
 # @param uninstall_vmware_tools
 #   Boolean that determines whether the conflicting VMWare Tools package should
 #   be uninstalled, if present.
@@ -57,6 +60,11 @@
 # @example Default usage
 #   include openvmtools
 #
+# @example Force pass supported os check on OS non in supported list
+#   class { 'openvmtools':
+#     supported => true,
+#   }
+#
 # @author Mike Arnold <mike@razorsedge.org>
 # @author Vox Pupuli <voxpupuli@groups.io>
 #