cookbook 'zap', '= 0.6.0'
zap
(32) Versions
0.6.0
-
Follow6
Provides HWRPs for creating authoritative resources
cookbook 'zap', '= 0.6.0', :supermarket
knife supermarket install zap
knife supermarket download zap
zap
Library cookbook for garbage collecting chef controlled resource sets.
One of the common pitfalls in chef land is the pattern of one deleting a
resource definition from a recipe and the user wondering why the resource still
exists on the system.
For example, on Monday a cronjob is added:
cron 'collect stats' do action :create minute 0 command '/usr/local/bin/collect-stats | mailto ops@nvwls.com' end
After a few days, the issue is figured out and that cron resource is removed
from the recipe. After uploading the new cookbook, they wonder why they are
still receiving email.
The issue that chef is great for describing actions. I mean, action is part
of the DSL.
At the 2013 Opscode Communit Summit, Matt Ray and I had a discussion regarding
this issue. The name authoritative cookbook was coined. If chef is deploying
files to a .d directory, if there are files in that directory not converged by a
resource, those files should be removed.
This pattern has been added to https://github.com/Youscribe/sysctl-cookbook
I presented the zap pattern at ChefConf 2014. You can check out the
video
http://www.youtube.com/watch?v=4-So4AJlBI4&list=PL11cZfNdwNyMmx0msapJfuGsLV43C7XsA&feature=share&index=53
and the slides
https://speakerdeck.com/nvwls/building-authoritative-resource-sets
Thanks
Users and groups support was provided by Sander Botman sbotman@schubergphilis.com.
Yum_repository support was provided by Sander van Harmelen svanharmelen@schubergphilis.com
Apt_repository support was provided by Helgi Þormar Þorbjörnsson helgi@php.net
Resource/Provider
zap_directory
Actions
- :delete - Delete files in a directory
Attribute Parameters
-
pattern - Pattern of files to match, i.e.
*.conf, defaults to*
Examples
zap_directory '/etc/sysctl.d' do pattern '*.conf' end
zap_crontab
Actions
- :delete - Delete jobs from a user's crontab
Attribute Parameters
-
pattern - Pattern of job names match, i.e.
test \#*, defaults to*
Examples
zap_crontab 'root' do pattern 'test \#*' end
zap_users
Delete users from /etc/passwd style files.
node['zap']['users']['keep'] contains an array of user names to
keep, i.e. root.
Actions
- :remove
Example
zap_users '/etc/passwd' do # only zap users whose uid is greater than 500 filter { |u| u.uid > 500 } end
zap_groups
Delete groups from /etc/group style files.
node['zap']['groups']['keep'] contains an array of group names to
keep, i.e. wheel.
Actions
- :remove
Example
zap_groups '/etc/group' do filter { |g| g.gid > 500 && g.name != 'nrpe' } end
zap_yum_repos
If you manage your yum repos using the yum_repository LWRP from the yum cookbook,
you can use this provider to dynamically delete any unmanaged or obsolete repos.
Actions
- :delete - Delete yum repos using the yum_repository LWRP from the yum cookbook
Attribute Parameters
-
pattern - Pattern of repository names to match, i.e.
epelorupdate, defaults to* -
immediately - Set to
trueif you want this action to be executed immediately, defaults totrue
Example
zap_yum_repos '/etc/yum.repos.d' do pattern 'epel' immediately false end
zap_apt_repos
If you manage your apt repos using the apt_repository LWRP from the apt cookbook,
you can use this provider to dynamically delete any unmanaged or obsolete repos.
Actions
- :remove - Delete apt repos using the apt_repository LWRP from the apt cookbook
Attribute Parameters
-
pattern - Pattern of repository names to match, i.e.
ppaorupdate, defaults to* -
immediately - Set to
trueif you want this action to be executed immediately, defaults totrue
Example
zap_apt_repos '/etc/apt/sources.list.d' do pattern 'ppa' immediately false action :remove end
zap
This the base HWRP.
Example
zap '/etc/sysctl.d' do klass [Chef::Resource::File, 'Chef::Resource::Template'] collect { ::Dir.glob("#{base}/*") } end
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
zap Cookbook CHANGELOG
This file is used to list changes made in each version of the zap cookbook.
v0.5.2
Improvement
- Refactored recipe[zap::yum_repos_d] into the zap_yum_repos resource provider
- Added an option to call zap immediately at a certain point in your Chef run
v0.5.1
Improvement
- Added recipe[zap::yum_repos_d]
v0.5.0
Improvement
- Added collect and select to the resource
v0.4.3
Improvement
- Moved @filter.call back
v0.4.2
Improvement
- Moved @filter.call into iterate
v0.4.1
Improvement
- Fixed rubocop warning
v0.4.0
Improvement
- Added klass keyword to DSL which can take a class, i.e. Chef::Resource::File, or string, i.e. 'Chef::Resource::YumRepository', or an array of classes or strings.
v0.3.0
Improvement
- Added zap_users and zap_groups
v0.2.0
Improvement
- Added filter for more complex, codified filtering
v0.1.1
Improvement
- Log at info
v0.1.0
Minor
- Refactored into an HWRP to allow better code reuse
v0.0.6
Improvement
- Cleaned up Rubocop warnings
v0.0.5
Improvement
- Added zap_crontab to zap the specified user's crontab
v0.0.4
Improvement
- Use ::File.join instead of hardcoding slashes
v0.0.3
Improvement
- Split zap_directory into two phases, :delay to move it to the end of the resource list, and :run to do the actual work.
v0.0.2
Improvement
- Move zap_directory to the end of the resource list.
