knife-tidy 1.2.0 → 2.0.0

data/.gitignore

@@ -1,52 +0,0 @@
-*.rbc
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-_Store
-reports/
-conf/*.json
-*~
-*#
-.#*
-\#*#
-.*.sw[a-z]
-*.un~
-*.tmp
-*.bk
-*.bkup
-
-# ruby/bundler files
-.ruby-version
-.ruby-gemset
-.rvmrc
-Gemfile.lock
-.bundle
-*.gem
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-.idea
-
-# chef stuff
-Berksfile.lock
-.kitchen
-.kitchen.local.yml
-vendor/
-.coverage/
-.zero-knife.rb
-Policyfile.lock.json
-.chef/
-
-# vagrant stuff
-.vagrant/
-.vagrant.d/
-.kitchen/

data/.travis.yml

@@ -1,26 +0,0 @@
-language: ruby
-cache: bundler
-dist: trusty
-sudo: false
-
-# Early warning system to catch if Rubygems breaks something
-before_install:
-  - gem update --system
-  - gem uninstall bundler -a -x
-  - gem install bundler
-  - rm -f .bundle/config
-
-rvm:
-  - 2.3.5
-  - 2.4.2
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-
-script: bundle exec rake spec
-
-branches:
-  only:
-  - master

data/CHANGELOG.md

@@ -1,246 +0,0 @@
-# Change Log
-
-## [1.2.0](https://github.com/chef-customers/knife-tidy/tree/1.2.0) (2018-05-17)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/1.1.0...1.2.0)
-
-**Closed issues:**
-
-- notifications fail for chef orgs containing an underscore [\#77](https://github.com/chef-customers/knife-tidy/issues/77)
-- Add option to attach raw JSON report files to the email notification [\#75](https://github.com/chef-customers/knife-tidy/issues/75)
-
-**Merged pull requests:**
-
-- bump to 1.2.0 [\#85](https://github.com/chef-customers/knife-tidy/pull/85) ([jeremymv2](https://github.com/jeremymv2))
-- fix empty clients group [\#84](https://github.com/chef-customers/knife-tidy/pull/84) ([jeremymv2](https://github.com/jeremymv2))
-
-## [1.1.0](https://github.com/chef-customers/knife-tidy/tree/1.1.0) (2018-01-11)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/1.0.1...1.1.0)
-
-**Closed issues:**
-
-- the backup-path should default to current working directory [\#79](https://github.com/chef-customers/knife-tidy/issues/79)
-
-**Merged pull requests:**
-
-- Jjh/fix notification reports [\#80](https://github.com/chef-customers/knife-tidy/pull/80) ([itmustbejj](https://github.com/itmustbejj))
-
-## [1.0.1](https://github.com/chef-customers/knife-tidy/tree/1.0.1) (2017-12-12)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/1.0.0...1.0.1)
-
-**Closed issues:**
-
-- Clean up references to tidy methods [\#68](https://github.com/chef-customers/knife-tidy/issues/68)
-- A stale search index can generate inaccurate tidy reports [\#62](https://github.com/chef-customers/knife-tidy/issues/62)
-
-**Merged pull requests:**
-
-- Fix validate\_user\_acls and default\_user\_acl methods [\#73](https://github.com/chef-customers/knife-tidy/pull/73) ([itmustbejj](https://github.com/itmustbejj))
-
-## [1.0.0](https://github.com/chef-customers/knife-tidy/tree/1.0.0) (2017-12-04)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.7.0...1.0.0)
-
-**Merged pull requests:**
-
-- Enabled cookbook deletion [\#71](https://github.com/chef-customers/knife-tidy/pull/71) ([itmustbejj](https://github.com/itmustbejj))
-- Add option for backup path to server clean [\#70](https://github.com/chef-customers/knife-tidy/pull/70) ([TheLunaticScripter](https://github.com/TheLunaticScripter))
-- Warn the user if there are nodes created in the last hour that haven'… [\#67](https://github.com/chef-customers/knife-tidy/pull/67) ([itmustbejj](https://github.com/itmustbejj))
-- Add guard to skip generating org reports if the search index is not u… [\#66](https://github.com/chef-customers/knife-tidy/pull/66) ([itmustbejj](https://github.com/itmustbejj))
-- Enable server clean command and clarify confirmation dialogue [\#31](https://github.com/chef-customers/knife-tidy/pull/31) ([jonlives](https://github.com/jonlives))
-
-## [0.7.0](https://github.com/chef-customers/knife-tidy/tree/0.7.0) (2017-11-29)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.6.1...0.7.0)
-
-**Closed issues:**
-
-- Users/clients from backups older than CS 12.5 may be missing read acls on clients [\#63](https://github.com/chef-customers/knife-tidy/issues/63)
-- notify subcommand ignores --orgs option [\#59](https://github.com/chef-customers/knife-tidy/issues/59)
-
-**Merged pull requests:**
-
-- release 0.7.0 [\#65](https://github.com/chef-customers/knife-tidy/pull/65) ([jeremymv2](https://github.com/jeremymv2))
-- Add admins/users groups to the read acl for clients from \< CS 12.5 [\#64](https://github.com/chef-customers/knife-tidy/pull/64) ([itmustbejj](https://github.com/itmustbejj))
-- Restore acls for ::server-admins and org read access groups if they a… [\#61](https://github.com/chef-customers/knife-tidy/pull/61) ([itmustbejj](https://github.com/itmustbejj))
-- Filter email notifications on org\_list config option. [\#60](https://github.com/chef-customers/knife-tidy/pull/60) ([itmustbejj](https://github.com/itmustbejj))
-- Set default encoding to utf-8 to properly handle non-ascii in backups. [\#58](https://github.com/chef-customers/knife-tidy/pull/58) ([itmustbejj](https://github.com/itmustbejj))
-- Add check for pre-12.3 nodes to report generation… [\#57](https://github.com/chef-customers/knife-tidy/pull/57) ([jonlives](https://github.com/jonlives))
-- bump path to 0.6.1 [\#55](https://github.com/chef-customers/knife-tidy/pull/55) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.6.1](https://github.com/chef-customers/knife-tidy/tree/0.6.1) (2017-10-26)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.6.0...0.6.1)
-
-**Closed issues:**
-
-- knife tidy server clean - org names with \_ [\#53](https://github.com/chef-customers/knife-tidy/issues/53)
-
-**Merged pull requests:**
-
-- fixing orgs with underscores [\#54](https://github.com/chef-customers/knife-tidy/pull/54) ([jeremymv2](https://github.com/jeremymv2))
-- Jeremymv2/release 0 6 0 [\#52](https://github.com/chef-customers/knife-tidy/pull/52) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.6.0](https://github.com/chef-customers/knife-tidy/tree/0.6.0) (2017-10-23)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.5.2...0.6.0)
-
-**Merged pull requests:**
-
-- fix travis [\#51](https://github.com/chef-customers/knife-tidy/pull/51) ([jeremymv2](https://github.com/jeremymv2))
-- Add knife tidy notify command [\#50](https://github.com/chef-customers/knife-tidy/pull/50) ([jonlives](https://github.com/jonlives))
-- bump to 0.5.2 [\#49](https://github.com/chef-customers/knife-tidy/pull/49) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.5.2](https://github.com/chef-customers/knife-tidy/tree/0.5.2) (2017-10-20)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.5.1...0.5.2)
-
-**Merged pull requests:**
-
-- fixing regex for whitespace [\#48](https://github.com/chef-customers/knife-tidy/pull/48) ([jeremymv2](https://github.com/jeremymv2))
-- bump patch to 0.5.1 [\#47](https://github.com/chef-customers/knife-tidy/pull/47) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.5.1](https://github.com/chef-customers/knife-tidy/tree/0.5.1) (2017-10-19)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.5.0...0.5.1)
-
-**Merged pull requests:**
-
-- Add node\_count to stale node json output. [\#46](https://github.com/chef-customers/knife-tidy/pull/46) ([MarkGibbons](https://github.com/MarkGibbons))
-- bump to 0.5.0 [\#45](https://github.com/chef-customers/knife-tidy/pull/45) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.5.0](https://github.com/chef-customers/knife-tidy/tree/0.5.0) (2017-10-06)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.4.1...0.5.0)
-
-**Closed issues:**
-
-- Supermarket.chef.io [\#37](https://github.com/chef-customers/knife-tidy/issues/37)
-
-**Merged pull requests:**
-
-- enabling deletion of stale nodes [\#44](https://github.com/chef-customers/knife-tidy/pull/44) ([jeremymv2](https://github.com/jeremymv2))
-- better warning message before confirmation [\#43](https://github.com/chef-customers/knife-tidy/pull/43) ([jeremymv2](https://github.com/jeremymv2))
-- Jeremymv2/chef sugar fix default [\#42](https://github.com/chef-customers/knife-tidy/pull/42) ([jeremymv2](https://github.com/jeremymv2))
-- deleting nodes also deletes client [\#41](https://github.com/chef-customers/knife-tidy/pull/41) ([jeremymv2](https://github.com/jeremymv2))
-- Change nodes\_list method to get all nodes [\#40](https://github.com/chef-customers/knife-tidy/pull/40) ([nsdavidson](https://github.com/nsdavidson))
-- bump version to 0.4.1 [\#39](https://github.com/chef-customers/knife-tidy/pull/39) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.4.1](https://github.com/chef-customers/knife-tidy/tree/0.4.1) (2017-09-27)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.4.0...0.4.1)
-
-**Merged pull requests:**
-
-- fixing corrupt invitations and invalid platform names with commas in … [\#38](https://github.com/chef-customers/knife-tidy/pull/38) ([jeremymv2](https://github.com/jeremymv2))
-- bump to 0.4.0 [\#36](https://github.com/chef-customers/knife-tidy/pull/36) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.4.0](https://github.com/chef-customers/knife-tidy/tree/0.4.0) (2017-09-26)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.6...0.4.0)
-
-**Merged pull requests:**
-
-- fix NilClass on env\_run\_lists [\#35](https://github.com/chef-customers/knife-tidy/pull/35) ([jeremymv2](https://github.com/jeremymv2))
-- fix merge conflict from rebase [\#34](https://github.com/chef-customers/knife-tidy/pull/34) ([jeremymv2](https://github.com/jeremymv2))
-- Simple feature to clean up EC11 org objects which don't load into CS12 [\#33](https://github.com/chef-customers/knife-tidy/pull/33) ([irvingpop](https://github.com/irvingpop))
-- role run\_list clean up and metadata name regex simplification [\#32](https://github.com/chef-customers/knife-tidy/pull/32) ([jeremymv2](https://github.com/jeremymv2))
-- bump to 0.3.6 [\#30](https://github.com/chef-customers/knife-tidy/pull/30) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.3.6](https://github.com/chef-customers/knife-tidy/tree/0.3.6) (2017-09-25)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.5...0.3.6)
-
-**Merged pull requests:**
-
-- first check if the\_user.has\_key?\('email'\) [\#29](https://github.com/chef-customers/knife-tidy/pull/29) ([jeremymv2](https://github.com/jeremymv2))
-- bump to 0.3.5 [\#28](https://github.com/chef-customers/knife-tidy/pull/28) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.3.5](https://github.com/chef-customers/knife-tidy/tree/0.3.5) (2017-09-20)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.4...0.3.5)
-
-**Merged pull requests:**
-
-- Catch pins with no cookbooks [\#27](https://github.com/chef-customers/knife-tidy/pull/27) ([nsdavidson](https://github.com/nsdavidson))
-
-## [0.3.4](https://github.com/chef-customers/knife-tidy/tree/0.3.4) (2017-09-16)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.3...0.3.4)
-
-**Merged pull requests:**
-
-- check if metadata.has\_key?\('platforms'\) [\#26](https://github.com/chef-customers/knife-tidy/pull/26) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.3.3](https://github.com/chef-customers/knife-tidy/tree/0.3.3) (2017-09-15)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.2...0.3.3)
-
-**Merged pull requests:**
-
-- boiler plate gsub file now works [\#25](https://github.com/chef-customers/knife-tidy/pull/25) ([jeremymv2](https://github.com/jeremymv2))
-- fixing null values and emtpy arrays in metadata.json [\#24](https://github.com/chef-customers/knife-tidy/pull/24) ([jeremymv2](https://github.com/jeremymv2))
-- Jeremyv2/action needed notification [\#23](https://github.com/chef-customers/knife-tidy/pull/23) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.3.2](https://github.com/chef-customers/knife-tidy/tree/0.3.2) (2017-09-14)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.1...0.3.2)
-
-**Merged pull requests:**
-
-- fixed name mismatch in metadata.json [\#22](https://github.com/chef-customers/knife-tidy/pull/22) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.3.1](https://github.com/chef-customers/knife-tidy/tree/0.3.1) (2017-09-14)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.0...0.3.1)
-
-**Merged pull requests:**
-
-- generate a metadata.rb if needed [\#21](https://github.com/chef-customers/knife-tidy/pull/21) ([jeremymv2](https://github.com/jeremymv2))
-- newline for action needed messages [\#20](https://github.com/chef-customers/knife-tidy/pull/20) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.3.0](https://github.com/chef-customers/knife-tidy/tree/0.3.0) (2017-09-14)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.4...0.3.0)
-
-**Closed issues:**
-
-- FATAL: Cannot find subcommand for: 'tidy backup clean' [\#12](https://github.com/chef-customers/knife-tidy/issues/12)
-
-**Merged pull requests:**
-
-- bump to 0.3.0 [\#19](https://github.com/chef-customers/knife-tidy/pull/19) ([jeremymv2](https://github.com/jeremymv2))
-- added dry-run to server clean [\#18](https://github.com/chef-customers/knife-tidy/pull/18) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.2.4](https://github.com/chef-customers/knife-tidy/tree/0.2.4) (2017-09-12)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.3...0.2.4)
-
-**Merged pull requests:**
-
-- disable server clean [\#17](https://github.com/chef-customers/knife-tidy/pull/17) ([jeremymv2](https://github.com/jeremymv2))
-- bump patch to 0.2.4 [\#16](https://github.com/chef-customers/knife-tidy/pull/16) ([jeremymv2](https://github.com/jeremymv2))
-- correct any cookbook metadata name issues [\#15](https://github.com/chef-customers/knife-tidy/pull/15) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.2.3](https://github.com/chef-customers/knife-tidy/tree/0.2.3) (2017-09-11)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.2...0.2.3)
-
-**Merged pull requests:**
-
-- setting required ruby to \>= 2.0.0 [\#14](https://github.com/chef-customers/knife-tidy/pull/14) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.2.2](https://github.com/chef-customers/knife-tidy/tree/0.2.2) (2017-09-11)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.1...0.2.2)
-
-**Merged pull requests:**
-
-- Jeremymv2/fix to i [\#13](https://github.com/chef-customers/knife-tidy/pull/13) ([jeremymv2](https://github.com/jeremymv2))
-- release 0.2.1 [\#11](https://github.com/chef-customers/knife-tidy/pull/11) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.2.1](https://github.com/chef-customers/knife-tidy/tree/0.2.1) (2017-09-01)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.0...0.2.1)
-
-**Merged pull requests:**
-
-- first round of tests [\#10](https://github.com/chef-customers/knife-tidy/pull/10) ([jeremymv2](https://github.com/jeremymv2))
-- Add environment checking for unused cookbook list [\#9](https://github.com/chef-customers/knife-tidy/pull/9) ([nsdavidson](https://github.com/nsdavidson))
-- disable [\#8](https://github.com/chef-customers/knife-tidy/pull/8) ([jeremymv2](https://github.com/jeremymv2))
-- server object deletion [\#7](https://github.com/chef-customers/knife-tidy/pull/7) ([jeremymv2](https://github.com/jeremymv2))
-- bump version to 0.2.0 [\#6](https://github.com/chef-customers/knife-tidy/pull/6) ([jeremymv2](https://github.com/jeremymv2))
-
-## [0.2.0](https://github.com/chef-customers/knife-tidy/tree/0.2.0) (2017-08-16)
-[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.1.1...0.2.0)
-
-**Merged pull requests:**
-
-- moved all common functions to tidy\_common.rb [\#5](https://github.com/chef-customers/knife-tidy/pull/5) ([jeremymv2](https://github.com/jeremymv2))
-- Jeremymv2/acl items [\#4](https://github.com/chef-customers/knife-tidy/pull/4) ([jeremymv2](https://github.com/jeremymv2))
-- updated changelog [\#3](https://github.com/chef-customers/knife-tidy/pull/3) ([jeremymv2](https://github.com/jeremymv2))
-- bump version to 0.1.1 [\#2](https://github.com/chef-customers/knife-tidy/pull/2) ([jeremymv2](https://github.com/jeremymv2))
-
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
-

data/Gemfile

@@ -1,38 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-if vsn = ENV['TRAVIS_CHEF_VERSION']
-  if m = /branch:(?<branch>.*)$/.match(vsn)
-    gem 'chef', git: 'https://github.com/chef/chef', branch: m[:branch]
-  else
-    gem 'chef', vsn
-  end
-end
-
-group :development do
-  gem 'rspec'
-  gem 'rake'
-  gem 'simplecov'
-  gem 'fakefs'
-  gem "chefstyle", git: "https://github.com/chef/chefstyle.git"
-  gem "chef-zero"
-end
-
-group :changelog do
-  gem "github_changelog_generator", git: "https://github.com/chef/github-changelog-generator"
-end
-
-# This is here instead of gemspec so that we can
-# override which Chef gem to use when we do testing
-# Possibilities in the future include using environmental
-# variables, thus allowing us to to have Travis support
-
-# Examples you can use in Gemfile.local
-# gem 'chef', '~> 10.28'
-# gem 'chef' # latest
-# gem 'chef', git: 'git://github.com/mal/chef.git', branch: 'CHEF-3307'
-
-# If you want to load debugging tools into the bundle exec sandbox,
-# # add these additional dependencies into Gemfile.local
-eval(IO.read(__FILE__ + '.local'), binding) if File.exists?(__FILE__ + '.local')

data/README.md

@@ -1,165 +0,0 @@
-# knife tidy
-
-# Summary
-
-NOTE: If you're a first-time or inexperienced knife-tidy user, we recommend you read through this blogpost before proceeding with the rest of this documentation: https://blog.chef.io/2017/10/16/migrating-chef-server-knife-ec-backup-knife-tidy/
-
-This Chef Knife plugin provides:
- * Reports on the state of Chef Server objects that can be tidied up
- * Removal of stale nodes (and associated clients and ACLs) identified by the above Reports
- * A [knife-ec-backup](https://github.com/chef/knife-ec-backup) companion tool that will clean up data integrity issues in an object backup
-
-# Requirements
-
-A current Chef Client. Can easily be installed via [Chef DK](https://github.com/chef/chef-dk#installation)
-
-# Installation
-
-Via Rubygems
-```bash
-gem install knife-tidy
-```
-
-Via Source
-```bash
-git clone https://github.com/chef-customers/knife-tidy.git
-cd knife-tidy
-gem build knife-tidy.gemspec && gem install knife-tidy-*.gem --no-ri --no-rdoc
-```
-
-## Common Options
-
-The following options are supported across all subcommands:
-
-  * `--orgs ORG1,ORG2`:
-    Only apply to objects in the named organizations (default: all orgs)
-
-## $ knife tidy server report --help
-
-Cookbooks and nodes account for the largest objects in your Chef Server.
-If you want to keep it lean and mean and easy to port the object data, you must
-tidy these unused objects up!
-
-## Options
-
-  * `--node-threshold NUM_DAYS`
-    Maximum number of days since last checkin before node is considered stale (default: 30)
-
-Example:
-```bash
-knife tidy server report --orgs brewinc,acmeinc --node-threshold 50
-```
-
-## Notes
-  `server report` generates json reports as such:
-
-File Name | Contents
---- | ---
-org_threshold_numdays_stale_nodes.json | Nodes in that org that have not checked in for the number of days specified.
-org_cookbook_count.json | Number of cookbook versions for each cookbook that that org.
-org_unused_cookbooks.json | List of cookbooks and versions that do not appear to be in-use for that org. This is determined by checking the versioned run list of each of the nodes in the org.
-
-## $ knife tidy server clean --help
-Remove stale nodes that haven't checked-in to the Chef Server as defined by the `--node-threshold NUM_DAYS` option when the reports were generated.. The associated client and ACLs are also removed.
-
-## Options
-
-  * `--backup-path /path/to/an-ec-backup`
-    The location to the last backup of the target Chef Server. It is not recommended to run the clean command without first taking a current backup using [knife-ec-backup](https://github.com/chef/knife-ec-backup)
-
-  * `--only-cookbooks`
-    Only deletes the unused cookbooks from the target Chef Server. NOTE: Cannot be specified if `--only-nodes` is already specified
-
-  * `--only-nodes`
-    Only deltes the stale nodes, associated clients, and ACLs from the target Chef Server. NOTE: Cannot be specified if `--only-cookbooks` is already specified
-
-  * `--dry-run`
-    Do not perform any actual deletion, only report on what would have been deleted.
-
-Example:
-```bash
-knife tidy server clean --orgs brewinc,acmeinc
-```
-
-## $ knife tidy backup clean --help
-
-## Options
-
-  * `--backup-path /path/to/an-ec-backup`:
-    The Chef Repo to tidy up (such as one created from a [knife-ec-backup](https://github.com/chef/knife-ec-backup)
-
-  * `--gsub-file /path/to/gsub/file`:
-    The path to the file used for substitutions. If non-existant, a boiler plate one will be created.
-
-Run the following example before attempting the `knife ec backup restore` operation:
-```bash
-knife tidy backup clean --gen-gsub
-INFO: Creating boiler plate gsub file: 'substitutions.json'
-knife tidy backup clean --backup-path backups/ --gsub-file substitutions.json
-```
-
-## Notes
-
-  Global file substitutions can be performed when `--gsub-file` option is used. Several known issues are corrected
-  and others can be added with search/replace pairings. The following boiler plate file is created for you when `--gen-gsub` is used:
-
-```json
-{
-  "io-read-version-and-readme.md":{
-    "organizations/*/cookbooks/*/metadata.rb":[
-      {
-        "pattern":"^version +IO.read.* 'VERSION'.*",
-        "replace":"version !COOKBOOK_VERSION!"
-      },
-      {
-        "pattern":"^long_description +IO.read.* 'README.md'.*",
-        "replace":"#long_description \"A Long Description..\""
-      }
-    ]
-  }
-}
-```
-
-## $ knife tidy notify
-
-The ```knife tidy notify```command is used to send a summary of the reports generated by ```knife tidy server report``` to your organisation admins.
-
-When run from the directory containing your reports, it will iterate through the reports for each organisation in turn, and query the Chef server specified in your ```knife.rb``` for all admins of that organisation.
-
-It will then generate a summary email from your knife tidy reports, and email it to all admins for that organisation.
-
-This command assumes you have access to an SMTP server you can use for sending outgoing emails.
-
-## Options
-
-  * `--smtp_server `:
-    The SMTP Server to use (defaults to localhost)
-  * `--smtp_port `:
-       The SMTP Port to be used (defaults to 25)  
-  * `--smtp_username `:
-       The SMTP Username to be used
-  * `--smtp_password `:
-       The SMTP Password to be used
-  * `--smtp_from `:
-       The From email address to be used when sending email reports
-  * `--smtp_enable_tls `:
-       Whether or not to enable TLS when sending reports via SMTP (defaults to false)            
-  * `--smtp_helo `:
-     The SMTP HELO to be used (defaults to localhost)
-
-Run the following example before attempting the `knife ec backup restore` operation:
-```bash
-$> knife tidy notify --smtp_server smtp.myserver.com --smtp_port 587  --smtp_from myuser@myserver.com --smtp_username myuser --smtp_password mypassword --smtp_use_tls
-
-Reading from /home/myuser/knife_tidy/reports directory
-Fetching report data for organisation mytestorg
-  Parsing file /home/myuser/knife_tidy/reports/mytestorg_unused_cookbooks.json
-  Parsing file /home/myuser/knife_tidy/reports/mytestorg_cookbook_count.json
-  Parsing file /home/myuser/knife_tidy/reports/mytestorg_stale_nodes.json
-Fetching admins users for organisation mytestorg
-Sending email reports for organisation mytestorg
-```
-
-## Summary and Credits
-
-  * Server Report was ported from Nolan Davidson's [chef-cleanup](https://github.com/nsdavidson/chef-cleanup)