confdroid_ntp/README.md

# Readme

[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_ntp&style=plastic)](https://jenkins.confdroid.com/job/confdroid_ntp/)

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/grizzlycoda/puppet_collection)

- [Readme](#readme)
  - [Synopsis](#synopsis)
  - [WARNING](#warning)
  - [Features](#features)
  - [Repo Documentation](#repo-documentation)
  - [Dependencies](#dependencies)
  - [Deployment](#deployment)
  - [SELINUX](#selinux)
  - [Known Problems](#known-problems)
  - [Support](#support)
  - [Tests](#tests)
  - [Contact Us](#contact-us)
  - [Disclaimer](#disclaimer)

## Synopsis

Time management in Linux is important. The underlying protocol is ntp, the service nowadays is chrony.

`confdroid_ntp` is a Puppet module to automate installation and configuration of chrony.

## WARNING

***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***

## Features

This module differentiates between client- and server configuration. If the `FQDN` of the puppet client matches the value of `cy_server_fqdn`, it assumes this to be an ntp time server, else it will be a client.

If you have no local time server(s), leave  `cy_use_lan_server` at `false` (default), else set it to `true`. This affects only client configurations.

The value for `cy_server_fqdn` is a string rather array, assuming either a single time server or a round-robin DNS CNAME entry returning several values for the time server (not configured by this module).

INSTALLATION

- installs chrony binaries

CONFIGURATION

- manage directories including selinux contexts
- and files and their templates including selinux contexts
- manage service
- optional: include nagios target for the chrony service (set `cy_manage_nagios`to `true`)

## Repo Documentation

See the full Puppet documentation including parameters in `docs/index.html`

## Dependencies

All dependencies must be included in the catalogue.

- [confdroid_nagios](https://sourcecode.confdroid.com/confdroid/confdroid_nagios) if nagios monitoring is desired

## Deployment

- native Puppet deployment

via site.pp or nodes.pp

```bash
node 'example.example.net' {
  include confdroid_ntp
}
```

- through Foreman:

In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.

See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).

## SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

## Known Problems

## Support

- OS: Rocky 9
- Puppet 8

## Tests

- Puppet Lint
  - excluded tests:
    - `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
- Puppet Parser
- ERB Template Parser
- Sonar Quality Gate

## Contact Us

- [contact Us](https://confdroid.com/contact/)
- [Feedback Portal](https://feedback.confdroid.com)

## Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.