deprecate

Puppet function to show deprecations in your manifests

deanwilson

deanwilson

7,153 downloads

7,047 latest version

4.6 quality score

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

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