Forge Home

cachefilesd

Module to control and configure cachefilesd.

10,630 downloads

10,377 latest version

1.9 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Jun 15th 2014

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'brentschler-cachefilesd', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add brentschler-cachefilesd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install brentschler-cachefilesd --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

brentschler/cachefilesd — version 1.0.1 Jun 15th 2014

brentschler-cachefilesd

Build Status

Table of Contents

  1. Overview
  2. Compatability
  3. Dependencies
  4. Examples
  5. Parameters
  6. Limitations
  7. License
  8. Development

Overview

This Puppet module is designed to facilitate the installation and configuration of cachefilesd. The primary scope includes installing the package on the system and populating the config file with the appropriate values.

Reasonable defaults have been set, so including the module with no settings will allow it to run.

Compatability

This module has been tested to work with puppet 3.0.x and greater

This module has been tested to work on the following systems.

  • Fedora 20
  • CentOS 6.x
  • SLES 11

Sections for all Linux versions reported by osfamily are present in params.pp and should work as all distros seem to repackage the RedHat package exactly as it is. If you have success with this module on an un-tested distro please report it so the documentation may be updated.

It should work on all Linux systems supported by puppet as it uses a single configuration file in a consistent location.

Dependencies

Examples

With traditional puppet node configuration:

class { 'cachefilesd':
  service_manage      => true,
  service_enable      => true,
  service_ensue       => 'running'
  package_ensue       => 'latest'
  brun                => '20%'
  frun                => '20%'
  bcull               => '20%'
  fcull               => '10%'
  bstop               => '5%'
  fstop               => '5%'
}

With heira:

---
classes:
  - cachefilesd

cachefilesd::service_manage: true
cachefilesd::service_enable: true
cachefilesd::service_ensure: 'running'
cachefilesd::package_ensure: 'latest'
cachefilesd::brun: '20%'
cachefilesd::frun: '20%'
cachefilesd::bcull: '10%'
cachefilesd::fcull: '10%'
cachefilesd::bstop: '5%'
cachefilesd::fstop: '5%'

Parameters

All Parameters are optional, if none are specified the defaults will use all but 10% of the drive on which the cache resides.

Variable Default value Description
brun 10% Amount of free space (in blocks) required for free running operation.
frun 10% Number of free files on the filesystem required for free running operation.
bcull 7% Amount of free space (in blocks) remaining at which cachefilesd culls the cache.
fcull 7% Same as bcull but for free files remaining.
bstop 3% Amount of free space (in blocks) remaining at which cachefilesd stops writing new files.
fstop 3% Same as bstop but for free files remaining.
cachedir /var/run/fscache Location for the cache. It is not recommended to change this, particularly if selinux is enabled.
disablecull false Turns off culling, may be useful in some cases but generally should be left alone.
debugcache 0 See man cachefilesd.conf for values.
culltable 12 See man cachefilesd.conf for values.
secctx OS dependant SElinux context to run under.

Limitations

The module does not check the underlying file system for correct mount options and features required by cachefilesd to run..

License

GPL v2

Development

Please report issues or submit a pull request.