Skip to content

Latest commit

 

History

History
270 lines (166 loc) · 6.94 KB

README.md

File metadata and controls

270 lines (166 loc) · 6.94 KB
Raw

irqbalance

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with dnscache
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

The dnscache module installs, configures and manages the dnscache service.

Build Status

Module Description

The dnscache module handles installing, configuring and running dnscache on CentOS/Redhat, Fedora and Ubuntu.

Setup

What dnscache affects

  • dnscache-run / ndjbdns package
  • ndjbdns configuration file
  • dnscache environment files
  • dnscache service

Note: Ubuntu modifies /etc/resolv.conf to point to 127.0.0.1 which could pose a problem with DNS if dnscache is not started after the package is installed.

The Ubuntu version of dnscache also does not support multiple listen addresses and this module will fail if listen_ip has more than one value.

This module also does not perform any checks to ensure that the users and groups used in the provided parameters already exist.

Beginning with dnscache

include '::dnscache' sets dnscache to listen on 127.0.0.1 and accept DNS queries coming from 127.0.0.1. If you want to dnscache to accept DNS queries from say a local network, then:

class { '::dnscache':
  accept_net => [ '127.0.0.1', '192.168.1' ],
}

With CentOS/RedHat you need the epel repository

include '::epel'
Class['::epel'] -> Package['dnscache']

Usage

All interaction with the dnscache module can be done through the main dnscache class. This means you can simply toggle the options in ::dnscache to have full functionality of the module.

Reference

Classes

Public Classes

  • dnscache: Main class, includes all other classes.

Private Classes

  • dnscache::install: Handles the packages.
  • dnscache::config: Handles the ndjbdns configuration file and the dnscache environment variables
  • dnscache::services: Handles the service.

Parameters

The following parameters are available in the dnscache module:

accept_net

An array listing of IP addresses or subnets that are written out to $dnscache_root/ip/ as separate files. The dnscache daemon accepts DNS requests from these IP/subnet addresses. Defaults to ['127.0.0.1']

cachesize

CACHESIZE dnscache environment variable. Defaults to distribution default value.

config_file

Location of the dnscache.conf file used by ndjbdns. Defaults to /etc/ndjbdns/dnscache.conf

config_file_group

Group for the dnscache.conf file used by the ndjbdns package. Defaults to 0.

config_file_mode

File permissions for /etc/ndjbdns/dnscache.conf. Defaults to 0644.

config_file_owner

Owner of /etc/ndjbdns/dnscache.conf. Defaults to 0.

config_file_template

Location of the template that modifies /etc/ndjbdns/dnscache.conf. Defaults to dnscache/dnscache.conf.erb

config_log_run_script_mode

File permissions for the ${dnscache_root}/log/run script that invokes multilog. Defaults to 0755.

config_log_run_script_template

Location of the template that modifies the original script in ${dnscache_root}/env/log/run Defaults to dnscache/dnscache-log-run.erb

config_run_script_mode

File permissions for the ${dnscache_root}/log/run script that invokes dnscache Defaults to 0755

config_run_script_template

Location of the template that modifies the original script in ${dnscache_root}/env/run Defaults to dnscache/dnscache-run.erb

datalimit

DATALIMIT dnscache environment variable. Defaults to distribution default value.

debug_level

DEBUG_LEVEL dnscache environment variable. Defaults to 1

dnscache_account

Account under which dnscache is invoked via ${dnscache_root/env/run . Defaults to Gdnscache.

dnscache_root

ROOT dnscache environment variable. Defaults to /etc/sv/dnscache/root on osfamily Debian or /etc/ndjbdns on osfamily Redhat

dnscache_service_dir

Service directory for dnscache used by daemontools. Defaults to /etc/sv/dnscache.

env_group

Group for dnscache environment files placed in ${dnscache_root}/env when on osfamily Debian and also $accept_net IPs placed in ${dnscache_root}/ip/ osfamily: Debian and Redhat. Defaults to 0.

env_mode

File permissions for dnscache environment files placed in ${dnscache_root}/env when on osfamily Debian and also $accept_net IPs placed in ${dnscache_root}/ip/ osfamily: Debian and Redhat. Defaults to 0644.

env_owner

Owner of dnscache environment files placed in ${dnscache_root}/env when on osfamily Debian and also $accept_net IPs placed in ${dnscache_root}/ip/ osfamily: Debian and Redhat. Defaults to 0.

forwardonly

FORWARDONLY dnscache environment variable. Defaults to undefined (nil).

gid

gid that will be acquired by dnscache. Defaults to 2.

hidettl

HIDETTL dnscache environment variable. Defaults to undefined (nil).

ipsend

IPSEND dnscache environment variable. Defaults to 0.0.0.0

listen_ip

IP dnscache environment variable. Defaults to ['127.0.0.1']

log_account

Account that will be used to run multilog for dnscache. Must have a UID and GID. Defaults to Gdnslog.

log_mode

Permissions for the /var/log/dnscache folder (osfamily: Debian) Defaults to 0755 .

mergequeries

MERGEQUERIES dnscache environment variable. Defaults to 1.

package_ensure

Sets the dnscache package to be installed. Can be set to 'present', 'latest', or a specific version. Defaults to present.

package_name

Determines the name of the package(s) to install. Defaults to 'dnscache-run' on osfamily Debian or 'ndjbdns' on osfamily Redhat.

root_server_ips

Array of IPs that should contain the list of DNS root servers or if FORWARDONLY is used, the list of caching servers to query.

service_enable

Determines if the service should be enabled at boot. Defaults to true.

service_ensure

Determines if the service should be running or not. Defaults to running.

service_manage

Selects whether Puppet should manage the service. Defaults to true.

service_name

Selects the name of the dnscache service for Puppet to manage. Defaults to dnscache.

uid

uid that will be acquired by dnscache. Defaults to 2.

Limitations

This module has received limited testing against Puppet 3.8.7 and Puppet 4.x

This module has been tested on:

  • CentOS 5/6
  • Fedora 20
  • Ubuntu 10.04/12.04/14.04

Development

Patches are welcome.