Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document parameter supported #83

Merged
merged 1 commit into from
Mar 21, 2024
Merged

Document parameter supported #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.markdown
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this PR: we should also change the OS Support section to refer to metadata.json.

Copy link
Contributor Author

@Valantin Valantin Mar 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exist a way to use command like strings:generete:reference to dynamically update the section to reflect the metadata.json?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some modules have a generic "See metadata.json for supported platforms". I am not even sure that this make sense because when you see that on the puppet forge, the information is available on top of the module page and "metadata.json" is an implementation detail that may not make sense for the end user. Maybe just dropping these outdated lists of EOL operating systems is simpler?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, do you prefere a differente PR or on this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dropping is also fine by me. I think a separate PR for that is good.

Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 17 additions & 9 deletions REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`

Expand Down Expand Up @@ -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`
Expand All @@ -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`
Expand Down
8 changes: 8 additions & 0 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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>
#
Expand Down