diff --git a/CHANGELOG.md b/CHANGELOG.md index cf1b3972..2c0919cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v9.0.0](https://github.com/puppetlabs/puppetlabs-ntp/tree/v9.0.0) (2021-02-27) +## [v9.0.1](https://github.com/puppetlabs/puppetlabs-ntp/tree/v9.0.1) (2021-03-29) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-ntp/compare/v9.0.0...v9.0.1) + +### Fixed + +- Allow setting user and group permissions of the NTP logfile [\#615](https://github.com/puppetlabs/puppetlabs-ntp/pull/615) ([Kristijan](https://github.com/Kristijan)) + +## [v9.0.0](https://github.com/puppetlabs/puppetlabs-ntp/tree/v9.0.0) (2021-03-01) [Full Changelog](https://github.com/puppetlabs/puppetlabs-ntp/compare/v8.5.0...v9.0.0) diff --git a/REFERENCE.md b/REFERENCE.md index b91fe418..bceaf23b 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -8,7 +8,7 @@ #### Public Classes -* [`ntp`](#ntp) +* [`ntp`](#ntp): ntp Main class, includes all other classes. #### Private Classes @@ -25,13 +25,44 @@ ### `ntp` -The ntp class. +ntp + +Main class, includes all other classes. #### Parameters The following parameters are available in the `ntp` class: +* [`authprov`](#authprov) +* [`broadcastclient`](#broadcastclient) +* [`burst`](#burst) +* [`config`](#config) +* [`config_dir`](#config_dir) +* [`config_epp`](#config_epp) +* [`config_file_mode`](#config_file_mode) +* [`config_template`](#config_template) +* [`daemon_extra_opts`](#daemon_extra_opts) +* [`disable_auth`](#disable_auth) +* [`disable_dhclient`](#disable_dhclient) +* [`disable_kernel`](#disable_kernel) +* [`disable_monitor`](#disable_monitor) +* [`driftfile`](#driftfile) +* [`enable_mode7`](#enable_mode7) +* [`fudge`](#fudge) +* [`iburst_enable`](#iburst_enable) +* [`interfaces`](#interfaces) +* [`interfaces_ignore`](#interfaces_ignore) +* [`keys`](#keys) +* [`keys_controlkey`](#keys_controlkey) +* [`keys_enable`](#keys_enable) +* [`keys_file`](#keys_file) +* [`keys_requestkey`](#keys_requestkey) +* [`keys_trusted`](#keys_trusted) +* [`leapfile`](#leapfile) +* [`logfile`](#logfile) +* [`logfile_group`](#logfile_group) * [`logfile_mode`](#logfile_mode) +* [`logfile_user`](#logfile_user) * [`logconfig`](#logconfig) * [`minpoll`](#minpoll) * [`maxpoll`](#maxpoll) @@ -72,33 +103,179 @@ The following parameters are available in the `ntp` class: * [`udlc`](#udlc) * [`udlc_stratum`](#udlc_stratum) * [`user`](#user) -* [`broadcastclient`](#broadcastclient) -* [`burst`](#burst) -* [`config`](#config) -* [`config_dir`](#config_dir) -* [`config_file_mode`](#config_file_mode) -* [`config_epp`](#config_epp) -* [`config_template`](#config_template) -* [`disable_auth`](#disable_auth) -* [`disable_dhclient`](#disable_dhclient) -* [`disable_kernel`](#disable_kernel) -* [`disable_monitor`](#disable_monitor) -* [`enable_mode7`](#enable_mode7) -* [`fudge`](#fudge) -* [`driftfile`](#driftfile) -* [`leapfile`](#leapfile) -* [`logfile`](#logfile) -* [`iburst_enable`](#iburst_enable) -* [`keys`](#keys) -* [`keys_enable`](#keys_enable) -* [`keys_file`](#keys_file) -* [`keys_controlkey`](#keys_controlkey) -* [`keys_requestkey`](#keys_requestkey) -* [`keys_trusted`](#keys_trusted) -* [`interfaces`](#interfaces) -* [`interfaces_ignore`](#interfaces_ignore) -* [`authprov`](#authprov) -* [`daemon_extra_opts`](#daemon_extra_opts) + +##### `authprov` + +Data type: `Optional[String]` + +Enables compatibility with W32Time in some versions of NTPd (such as Novell DSfW). Default value: undef. + +##### `broadcastclient` + +Data type: `Boolean` + +Enables reception of broadcast server messages to any local interface. Default value: false. + +##### `burst` + +Data type: `Boolean` + +When the server is reachable, send a burst of eight packets instead of the usual one. Default value: false. + +##### `config` + +Data type: `Stdlib::Absolutepath` + +Specifies a file for NTP's configuration info. Default value: '/etc/ntp.conf' (or '/etc/inet/ntp.conf' on Solaris). + +##### `config_dir` + +Data type: `Optional[Stdlib::Absolutepath]` + +Specifies a directory for the NTP configuration files. Default value: undef. + +##### `config_epp` + +Data type: `Optional[String]` + +Specifies an absolute or relative file path to an EPP template for the config file. +Example value: 'ntp/ntp.conf.epp'. A validation error is thrown if both this **and** the `config_template` parameter are specified. + +##### `config_file_mode` + +Data type: `String` + +Specifies a file mode for the ntp configuration file. Default value: '0664'. + +##### `config_template` + +Data type: `Optional[String]` + +Specifies an absolute or relative file path to an ERB template for the config file. +Example value: 'ntp/ntp.conf.erb'. A validation error is thrown if both this **and** the `config_epp` parameter are specified. + +##### `daemon_extra_opts` + +Data type: `Optional[String]` + +Specifies any arguments to pass to ntp daemon. Default value: '-g'. +Example value: '-g -i /var/lib/ntp' to enable jaildir options. +Note that user is a specific parameter handled separately. + +##### `disable_auth` + +Data type: `Boolean` + +Disables cryptographic authentication for broadcast client, multicast client, and symmetric passive associations. + +##### `disable_dhclient` + +Data type: `Boolean` + +Disables `ntp-servers` in `dhclient.conf` to prevent Dhclient from managing the NTP configuration. + +##### `disable_kernel` + +Data type: `Boolean` + +Disables kernel time discipline. + +##### `disable_monitor` + +Data type: `Boolean` + +Disables the monitoring facility in NTP. Default value: true. + +##### `driftfile` + +Data type: `Stdlib::Absolutepath` + +Specifies an NTP driftfile. Default value: '/var/lib/ntp/drift' (except on AIX and Solaris). + +##### `enable_mode7` + +Data type: `Boolean` + +Enables processing of NTP mode 7 implementation-specific requests which are used by the deprecated ntpdc program. Default value: false. + +##### `fudge` + +Data type: `Optional[Array[String]]` + +Provides additional information for individual clock drivers. Default value: [ ] + +##### `iburst_enable` + +Data type: `Boolean` + +Specifies whether to enable the iburst option for every NTP peer. Default value: false (true on AIX and Debian). + +##### `interfaces` + +Data type: `Array[String]` + +Specifies one or more network interfaces for NTP to listen on. Default value: [ ]. + +##### `interfaces_ignore` + +Data type: `Array[String]` + +Specifies one or more ignore pattern for the NTP listener configuration (for example: all, wildcard, ipv6). Default value: [ ]. + +##### `keys` + +Data type: `Array[String]` + +Distributes keys to keys file. Default value: [ ]. + +##### `keys_controlkey` + +Data type: `Optional[Ntp::Key_id]` + +Specifies the key identifier to use with the ntpq utility. Value in the range of 1 to 65,534 inclusive. Default value: ' '. + +##### `keys_enable` + +Data type: `Boolean` + +Whether to enable key-based authentication. Default value: false. + +##### `keys_file` + +Data type: `Stdlib::Absolutepath` + +Specifies the complete path and location of the MD5 key file containing the keys and key identifiers used by ntpd, ntpq and ntpdc +when operating with symmetric key cryptography. Default value: `/etc/ntp.keys` (on RedHat and Amazon, `/etc/ntp/keys`). + +##### `keys_requestkey` + +Data type: `Optional[Ntp::Key_id]` + +Specifies the key identifier to use with the ntpdc utility program. Value in the range of 1 to 65,534. Default value: ' '. + +##### `keys_trusted` + +Data type: `Optional[Array[Ntp::Key_id]]` + +Provides one or more keys to be trusted by NTP. Default value: [ ]. + +##### `leapfile` + +Data type: `Optional[Stdlib::Absolutepath]` + +Specifies a leap second file for NTP to use. Default value: ' '. + +##### `logfile` + +Data type: `Optional[Stdlib::Absolutepath]` + +Specifies a log file for NTP to use instead of syslog. Default value: ' '. + +##### `logfile_group` + +Data type: `Optional[Variant[String, Integer]]` + +Specifies the group for the NTP log file. Default is 'ntp'. ##### `logfile_mode` @@ -106,6 +283,12 @@ Data type: `String` Specifies the permission for the NTP log file. Default is 0664. +##### `logfile_user` + +Data type: `Optional[Variant[String, Integer]]` + +Specifies the user for the NTP log file. Default is 'ntp'. + ##### `logconfig` Data type: `Optional[String]` @@ -366,168 +549,6 @@ Specifies user to run ntpd daemon. Default value: ntp. Usually set by default on Centos7 (/etc/systemd/system/multi-user.target.wants/ntpd.service) and ubuntu 18.04 (/usr/lib/ntp/ntp-systemd-wrapper) This is currently restricted to Redhat based systems of version 7 and above and Ubuntu 18.04. -##### `broadcastclient` - -Data type: `Boolean` - - - -##### `burst` - -Data type: `Boolean` - - - -##### `config` - -Data type: `Stdlib::Absolutepath` - - - -##### `config_dir` - -Data type: `Optional[Stdlib::Absolutepath]` - - - -##### `config_file_mode` - -Data type: `String` - - - -##### `config_epp` - -Data type: `Optional[String]` - - - -##### `config_template` - -Data type: `Optional[String]` - - - -##### `disable_auth` - -Data type: `Boolean` - - - -##### `disable_dhclient` - -Data type: `Boolean` - - - -##### `disable_kernel` - -Data type: `Boolean` - - - -##### `disable_monitor` - -Data type: `Boolean` - - - -##### `enable_mode7` - -Data type: `Boolean` - - - -##### `fudge` - -Data type: `Optional[Array[String]]` - - - -##### `driftfile` - -Data type: `Stdlib::Absolutepath` - - - -##### `leapfile` - -Data type: `Optional[Stdlib::Absolutepath]` - - - -##### `logfile` - -Data type: `Optional[Stdlib::Absolutepath]` - - - -##### `iburst_enable` - -Data type: `Boolean` - - - -##### `keys` - -Data type: `Array[String]` - - - -##### `keys_enable` - -Data type: `Boolean` - - - -##### `keys_file` - -Data type: `Stdlib::Absolutepath` - - - -##### `keys_controlkey` - -Data type: `Optional[Ntp::Key_id]` - - - -##### `keys_requestkey` - -Data type: `Optional[Ntp::Key_id]` - - - -##### `keys_trusted` - -Data type: `Optional[Array[Ntp::Key_id]]` - - - -##### `interfaces` - -Data type: `Array[String]` - - - -##### `interfaces_ignore` - -Data type: `Array[String]` - - - -##### `authprov` - -Data type: `Optional[String]` - - - -##### `daemon_extra_opts` - -Data type: `Optional[String]` - - - ## Data types ### `Ntp::Key_id` diff --git a/metadata.json b/metadata.json index 00045fc8..460fcb22 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-ntp", - "version": "9.0.0", + "version": "9.0.1", "author": "puppetlabs", "summary": "Installs, configures, and manages the NTP service.", "license": "Apache-2.0",