Version information
Start using this module
Add this module to your Puppetfile:
mod 'j0hnds-chrony', '0.2.1'
Learn more about managing modules with a PuppetfileDocumentation
puppet-chrony
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with chrony
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
Overview
Chrony Puppet Module
Manage chrony time daemon on Archlinux and Redhat
Module Description
The Chrony module handles running chrony in Archlinux and Redhat systems with systemd.
Setup
What chrony affects
- chrony package.
- chrony configuration file.
- chrony key file.
- chrony service.
Beginning with chrony
include '::chrony' is all you need to get it running. If you wish to pass in parameters like which servers to use then you can use:
class { '::chrony':
servers => ['ntp1.corp.com', 'ntp2.corp.com' ],
}
Usage
All interaction with the chrony module can be done through the main chrony class.
I just want chrony, what's the minimum I need?
include '::chrony'
I just want to tweak the servers, nothing else.
class { '::chrony':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com', ],
}
I'd like to make sure a secret password is used for chronyc:
class { '::chrony':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com', ],
chrony_password => 'secret_password',
}
I'd like to use NTP authentication:
class { '::chrony':
keys => [
'25 SHA1 HEX:1dc764e0791b11fa67efc7ecbc4b0d73f68a070c',
],
servers => {
'ntp1.corp.com' => ['key 25', 'iburst'],
'ntp2.corp.com' => ['key 25', 'iburst'],
},
}
I'd like chronyd to auto generate a command key at startup:
class { '::chrony':
chrony_password => 'unset',
config_keys_manage => false,
}
Allow some hosts
class { '::chrony':
queryhosts => [ '192.168/16', ],
}
Reference
Classes
- chrony: Main class, includes all the rest.
- chrony::install: Handles the packages.
- chrony::config: Handles the configuration and key file.
- chrony::service: Handles the service.
Parameters
The following parameters are available in the chrony module
chrony_password
This sets the chrony password to be used in the key file. By default a short fixed string is used. If set explicitly to 'unset' then no password will setting will be added to the keys file by puppet.
commandkey
This sets the key ID used by chronyc to authenticate to chronyd.
config
This sets the file to write chrony configuration into.
config_template
This determines which template puppet should use for the chrony configuration.
config_keys
This sets the file to write chrony keys into.
config_keys_owner
Specify unix owner of chrony keys file, defaults to 0.
config_keys_group
Specify unix group of chrony keys files, defaults to 0 on ArchLinux and chrony on Redhat.
config_keys_mode
Specify unix mode of chrony keys files, defaults to 0644 on ArchLinux and 0640 on Redhat.
config_keys_template
This determines which template puppet should use for the chrony key file.
keys
An array of key lines. These are printed as-is into the chrony key file.
package_ensure
This can be set to 'present' or 'latest' or a specific version to choose the chrony package to be installed.
package_name
This determines the name of the package to install.
servers
This selects the servers to use for ntp peers. It can be an array of servers or a hash of servers to their respective options.
queryhosts
This adds the networks, hosts that are allowed to query the daemon.
service_enable
This determines if the service should be enabled at boot.
service_ensure
This determines if the service should be running or not.
service_manage
This selects if puppet should manage the service in the first place.
service_name
This selects the name of the chrony service for puppet to manage.
Limitations
This module has been built on and tested against Puppet 3.2.3 and higher.
The module has been tested on:
- Arch Linux
- Red Hat
Dependencies
- puppetlabs-stdlib (>= 2.2.1)
Copyright 2013 Niels Abspoel Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.