22
33[ ![ Build Status] ( https://travis-ci.org/adamcrews/puppet-mlocate.svg )] ( https://travis-ci.org/adamcrews/puppet-mlocate )
44[ ![ Puppet Forge] ( http://img.shields.io/puppetforge/v/adamcrews/mlocate.svg )] ( http://forge.puppetlabs.com/adamcrews/mlocate )
5+ [ ![ License (Apache 2.0)] ( https://img.shields.io/badge/license-Apache-blue.svg )] ( https://opensource.org/licenses/Apache-2.0 )
56
67#### Table of Contents
78
23247 . [ Contributors] ( #contributors )
2425
2526## Overview
26-
2727Install and manage the mlocate/updatedb package.
2828
2929## Module Description
@@ -48,7 +48,7 @@ Everything can be configured via the default mlocate class.
4848
4949## Usage
5050
51- Basic usage that will result is a setup very close to a default CentOS configuration
51+ Basic usage that will result is a setup very close to a default RedHat configuration
5252
5353``` puppet
5454include ::mlocate
@@ -72,83 +72,85 @@ class { '::mlocate':
7272
7373#### Private Classes
7474
75- * mlocate::params: default parameters.
7675* mlocate::install: install and configure the software.
7776* mlocate::cron: setup the cron job.
7877
79- ###Parameters
78+ ### Parameters
8079
8180The following parameters are available as options to the default mlocate class.
8281
83- ####` package_name `
84-
85- The name of the package to install. Default: mlocate
86-
87- ####` package_ensure `
88-
89- Ensure the package is present, latest, or absent. Default: present
90-
91- ####` update_command `
92-
93- The name of the updatedb wrapper script. Default: /usr/local/bin/mlocate.cron
94-
95- ####` update_on_install `
96-
97- Run an initial update when the package is installed. Default: true
98-
99- ####` conf_file `
82+ #### ` package_name `
83+ The name of the package to install.
84+ ** Default: 'mlocate'**
10085
101- The configuration file for updatedb. Default: /etc/updatedb.conf
86+ #### ` package_ensure `
87+ Ensure the package is 'present', 'absent', or 'latest'.
88+ ** Default: 'present'**
10289
103- ####` cron_ensure `
90+ #### ` update_command `
91+ The name of the updatedb wrapper script.
92+ ** Default: '/usr/local/bin/mlocate.cron'**
10493
105- Ensure the cron jobs is present or absent. Default: present
94+ #### ` update_on_install `
95+ Run an initial update when the package is installed.
96+ ** Default: true**
10697
107- ####` cron_schedule `
98+ #### ` conf_file `
99+ The configuration file for updatedb.
100+ ** Default: '/etc/updatedb.conf'**
108101
109- The standard cron time schedule. Default: once a week based on fqdn_rand
102+ #### ` cron_ensure `
103+ Ensure the cron jobs is present or absent.
104+ ** Default: 'present'**
110105
111- ####` cron_daily_path `
106+ #### ` cron_schedule `
107+ The standard cron time schedule.
108+ ** Default: once a week based on * fqdn_rand* **
112109
113- The path to cron.daily file installed by mlocate and that is removed
110+ #### ` cron_daily_path `
111+ The path to cron.daily file installed by mlocate and that is removed.
112+ ** Default: '/etc/cron.daily/mlocate.cron' or '/etc/cron.daily/mlocate' (depending on OS version)**
114113
115- ####` prune_bind_mounts `
116-
117- Prune out bind mounts or not. Default: yes
114+ #### ` prune_bind_mounts `
115+ Prune out bind mounts or not.
116+ * Optional value*
117+ ** Default: 'yes'**
118118Refer to the updatedb.conf man page for more detail.
119- On redhat 5 systems defaults to none.
120-
121- ####` prunenames `
122119
123- Prune out directories matching this pattern. Default: .git .hg .svn
120+ #### ` prunenames `
121+ Prune out directories matching this pattern.
122+ * Optional value*
123+ ** Default: '.git .hg .svn'**
124124Refer to the updatedb.conf man page for more detail.
125- On redhat 5 systems defaults to none.
126-
127- ####` extra_prunenames `
128-
129- Prune out additional directories matching this pattern. Default: none
130125
131- ####` prunefs `
126+ #### ` extra_prunenames `
127+ Prune out additional directories matching this pattern.
128+ * Optional value*
129+ ** Default: undef**
132130
133- Prune out these FS types. Default: refer to the params.pp
131+ #### ` prunefs `
132+ Prune out these filesystem types.
133+ ** Default: refer to ` mlocate::prunefs ` in * data/common.yaml* **
134134Refer to the updatedb.conf man page for more detail.
135135
136- ####` extra_prunefs `
136+ #### ` extra_prunefs `
137+ Prune out additional filesystem types matching this pattern.
138+ * Optional value*
139+ ** Default: undef**
137140
138- Prune out additional directories matching this pattern. Default: none
139-
140- ####` prunepaths `
141-
142- Prune out paths matching this pattern. Default: refer to params.pp
141+ #### ` prunepaths `
142+ Prune out paths matching this pattern.
143+ ** Default: refer to ` mlocate::prunepaths ` in * data/common.yaml* **
143144Refer to the updatedb.conf man page for more detail.
144145
145- ####` extra_prunepaths `
146-
147- Prune out additional directories matching this pattern. Default: none
146+ #### ` extra_prunepaths `
147+ Prune out additional paths matching this pattern.
148+ * Optional value*
149+ ** Default: undef**
148150
149151## Limitations
150152
151- This has only been tested on CentOS 6.5 , but should work fine on any RHEL based system, versions 4+
153+ This has only been tested on CentOS 6 and RedHat 6/7 , but should work fine on any supported RHEL- based system.
152154
153155## Development
154156
@@ -165,4 +167,3 @@ With the 0.3.0 release, the cron job times will likely change as an extra seed a
165167## Contributors
166168
167169Contributors can be found on github.
168-
0 commit comments