Forge Home

deprecate

Puppet function to show deprecations in your manifests

8,441 downloads

8,260 latest version

4.6 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.

Version information

  • 0.0.2 (latest)
  • 0.0.1
released Nov 27th 2015
This version is compatible with:
  • RedHat, Ubuntu, Debian, Fedora, CentOS

Start using this module

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

Add this module to your Puppetfile:

mod 'deanwilson-deprecate', '0.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add deanwilson-deprecate
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install deanwilson-deprecate --version 0.0.2

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

deanwilson/deprecate — version 0.0.2 Nov 27th 2015

puppet-deprecate

A puppet function to log deprecations in your manifests

Introduction

Sometimes you need to add resources to your manifests that should only exist for a set period of time. By adding a call to the deprecate function you can either output a warning in the puppetservers log or cause the entire run to fail.

deprecate takes 2 or 3 arguments.

  • A date string, in either YYYYMMDD or YYYY-MM-DD formats
  • A free form string describing the what and why of the deprecation
  • An optional boolean to control if the run should be aborted

Examples

class deprecated_resources {

  # show a warning in puppetservers log
  deprecate('2015-01-20', 'Remove Foo at the end of the contract')

  # fail the run and show a warning clients output and masters logfile
  deprecate('2015-01-25', 'Remove Foo at the end of the contract', true)

}


# warning in the puppermaster log
13:56:17,938 WARN  [puppet-server] Puppet Class[Json_tester]
  expired on 20150120: Remove Foo at the end of the contract

# error on the client side when abort is set to true
Error: Could not retrieve catalog from remote server:
Error 400 on SERVER: Evaluation Error: 
Error while evaluating a Function Call, 
Class[Json_tester] expired on 20150120: Remove Foo at the end of the contract
at modules/json_tester/manifests/init.pp:12:3 on node testy

License

Apache 2.0 - Dean Wilson