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.

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

[Fix] titles in readme #24

Merged
merged 1 commit into from
May 26, 2018
Merged
Changes from all commits
Commits
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
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#puppet-chrony
# puppet-chrony

[![Build Status](https://secure.travis-ci.org/aboe76/puppet-chrony.png?branch=master)](http://travis-ci.org/aboe76/puppet-chrony)

####Table of Contents
## Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
Expand All @@ -21,21 +21,21 @@
Manage chrony time daemon on Archlinux and Redhat


##Module Description
## Module Description

The Chrony module handles running chrony in Archlinux and Redhat systems
with systemd.

##Setup
## Setup

###What chrony affects
### What chrony affects

* chrony package.
* chrony configuration file.
* chrony key file.
* chrony service.
###Beginning with chrony

### 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
Expand All @@ -47,34 +47,34 @@ class { '::chrony':
}
```

##Usage
## 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?
### I just want chrony, what's the minimum I need?

```puppet
include '::chrony'
```

###I just want to tweak the servers, nothing else.
### I just want to tweak the servers, nothing else.

```puppet
class { '::chrony':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com', ],
}
```

###I'd like to make sure a secret password is used for chronyc:
### I'd like to make sure a secret password is used for chronyc:
```puppet
class { '::chrony':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com', ],
chrony_password => 'secret_password',
}
```

###I'd like to use NTP authentication:
### I'd like to use NTP authentication:
```puppet
class { '::chrony':
keys => [
Expand All @@ -87,113 +87,113 @@ class { '::chrony':
}
```

###I'd like chronyd to auto generate a command key at startup:
### I'd like chronyd to auto generate a command key at startup:
```puppet
class { '::chrony':
chrony_password => 'unset',
config_keys_manage => false,
}
```

###Allow some hosts
### Allow some hosts
```puppet
class { '::chrony':
queryhosts => [ '192.168/16', ],
}
```

##Reference
## Reference

###Classes
### 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
### Parameters

The following parameters are available in the chrony module

####`chrony_password`
#### `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`
#### `commandkey`

This sets the key ID used by chronyc to authenticate to chronyd.

####`config`
#### `config`

This sets the file to write chrony configuration into.

####`config_template`
#### `config_template`

This determines which template puppet should use for the chrony configuration.

####`config_keys`
#### `config_keys`

This sets the file to write chrony keys into.

####`config_keys_owner`
#### `config_keys_owner`

Specify unix owner of chrony keys file, defaults to 0.

####`config_keys_group`
#### `config_keys_group`

Specify unix group of chrony keys files, defaults to 0 on ArchLinux
and chrony on Redhat.

####`config_keys_mode`
#### `config_keys_mode`

Specify unix mode of chrony keys files, defaults to 0644 on ArchLinux
and 0640 on Redhat.

####`config_keys_template`
#### `config_keys_template`

This determines which template puppet should use for the chrony key file.

####`keys`
#### `keys`

An array of key lines. These are printed as-is into the chrony key file.

####`package_ensure`
#### `package_ensure`

This can be set to 'present' or 'latest' or a specific version to choose the
chrony package to be installed.

####`package_name`
#### `package_name`

This determines the name of the package to install.

####`servers`
#### `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`
#### `queryhosts`

This adds the networks, hosts that are allowed to query the daemon.

####`service_enable`
#### `service_enable`

This determines if the service should be enabled at boot.

####`service_ensure`
#### `service_ensure`

This determines if the service should be running or not.

####`service_manage`
#### `service_manage`

This selects if puppet should manage the service in the first place.

####`service_name`
#### `service_name`

This selects the name of the chrony service for puppet to manage.

##Limitations
## Limitations

This module has been built on and tested against Puppet 3.2.3 and higher.

Expand Down