Ohai!
Welcome to Grocery Delivery, software to keep cookbooks, roles, and databags in sync between a VCS repo and a chef server. The idea is that if you have multiple, distinct Chef server instances that should all be identical, they can all run this script in cron. The script uses proper locking, so you should be able to run it every minute.
However, there are several things to know:
- It assumes you don't leverage versions or environments.
- It assumes you want anything committed to HEAD to be uploaded immediately.
Grocery Delivery is pretty customizable. Many things can be tuned from a simple config file, and it's pluggable so you can extend it as well.
Grocery Delivery is a particular way of managing your Chef infrastructure, and it assumes you follow that model consistently. Here are the basic principals:
- Checkins are live immediately (which implies code review before merge)
- Versions are meaningless (ideally, never change them)
- You want all your chef-servers in sync
- Everything you care about comes from version control.
We recommend enabling attributes whitelisting to prevent node attributes being
saved back to the server. In recent versions of Chef (past Chef 11), this
feature is built-in. For
older versions, we recommend using the
whitelist_node_attrs
cookbook.
- Mixlib::Config
- BetweenMeals
The default config file is /etc/gd-config.rb but you may use -c to specify
another. The config file works the same as client.rb does for Chef - there
are a series of keywords that take an argument and anything else is just
standard Ruby.
The following configuration options are available:
-
berksDescription: Determines if we should use Berkshelf to resolve deps, upload cookbooks
CLI Argument(s):
'-b','--berks'Value data type:
BooleanDefault:
falseNotes: Existence of CLI argument equates to
true -
berks_binDescription: Path to Berkshelf binary.
CLI Argument(s):
'-B', '--berks-bin FILE'Value data type:
StringDefault:
/opt/chefdk/bin/berks -
berks_configDescription: Path to Berkshelf config.
CLI Argument(s):
'--berks-config FILE'Value data type:
StringDefault:
nil -
config_fileDescription: Path to Grocery Delivery config
CLI Argument(s):
-c,--config-file FILEValue data type:
StringDefault:
/etc/gd-config.rb -
cookbook_pathsDescription: Space-delimited array of dirs that contain cookbooks relative to
reponameCLI Argument(s):
'--cookbook-paths DIRECTORY1 DIRECTORY2 DIRECTORY3 ...'Value data type:
StringDefault:
['chef/cookbooks'] -
databag_pathDescription: A directory to find databags in relative to
reponame.CLI Argument(s):
'-d', '--databag-path FILE'Value data type:
StringDefault:
'chef/databags' -
dry_runDescription: Enable dry-run mode.
CLI Argument(s):
'-n', '--dry-run'Value data type:
BooleanDefault:
falseNotes: Existence of CLI argument equates to
true -
knife_binDescription: Path to
knifebinary.CLI Argument(s):
'-k', '--knife-bin FILE'Value data type:
StringDefault:
/opt/chef/bin/knifeNotes: e.g.
/var/chef/grocery_delivery_work/ops/chef/cookbooks -
knife_configDescription: Knife config to use for uploads.
CLI Argument(s):
'-K', '--knife-config FILE'Value data type:
StringDefault:
/root/.chef/knife.rbNotes:
knife.rbwill need to setcookbook_pathpointing to the cookbook path in the work directory -
lockfileDescription: Path to lockfile.
CLI Argument(s):
'-l', '--lockfile FILE'Value data type:
StringDefault:
/var/lock/subsys/grocery_delivery -
master_pathDescription: The top-level path for Grocery Delivery's work (most other paths are relative to this).
CLI Argument(s):
'-m', '--master-path FILE'Value data type:
StringDefault:
/var/chef/grocery_delivery_work -
pidfileDescription: Path to pidfile.
CLI Argument(s):
-p, --pidfile FILEValue data type:
StringDefault:
/var/run/grocery_delivery.pid -
plugin_pathDescription: Path to plugin file.
CLI Argument(s):
'-P', '--plugin-path FILE'Value data type:
StringDefault:
/etc/gd-plugin.rb -
repo_updateDescription: Enables/disables cookbook repo update before run.
CLI Argument(s):
'-U', '--no-repo-update'Value data type:
BooleanDefault:
trueNote: Existence of CLI argument equates to
false. This might be beneficial for those wanting to run Grocery Delivery in CI, within a container, or some other non-standard environment where there is no need to update the cookbook repository before running Grocery Delivery. -
repo_urlDescription: The URL to clone/checkout if it doesn't exist.
CLI Argument(s):
'-u', '--repo-url URL'Value data type:
StringDefault:
nil -
reponameDescription: The relative directory to check the repo out to, inside of
master_path.CLI Argument(s):
'-N', '--repo-name'Value data type:
StringDefault:
ops -
rev_checkpointDescription: File with last-uploaded revision, relative to reponame.
CLI Argument(s):
'-C', '--revision-checkpoint FILE'Value data type:
StringDefault:
gd_revision -
role_pathDescription: A directory to find roles in relative to
reponame.CLI Argument(s):
'-r', '--role-path FILE'Value data type:
StringDefault:
'chef/roles' -
role_typeDescription: RB or JSON roles?
CLI Argument(s):
'-R', '--role-type TYPE'Value data type:
StringDefault:
rb -
stdoutDescription: Log to stdout as well.
CLI Argument(s):
'--stdout'Value data type:
BooleanDefault:
falseNotes: Existence of CLI argument equates to
true -
track_symlinksDescription: Whether or not to track symlinks.
CLI Argument(s):
'--track-symlinks'Value data type:
BooleanDefault:
falseNotes: Existence of CLI argument equates to
true -
vcs_pathDescription: Path to git or svn binary.
CLI Argument(s):
'--vcs-path FILE'Value data type:
StringDefault:
nilNotes: If not given, just uses 'git' or 'svn'
-
vcs_typeDescription: Git or SVN?
CLI Argument(s):
'--vcs-type TYPE'Value data type:
StringDefault:
svn -
verbosityDescription: Verbosity level.
CLI Argument(s):
'-v','--verbosity'Value data type: N/A
Default:
WARNNotes: Specify twice via CLI for debug.
The plugin should be a ruby file which defines several class methods. It is
class_eval()d into a Hooks class.
The following functions can optionally be defined:
- self.preflight_checks(dryrun)
This code will run once we've read our config and loaded our plugins but before
anything else. We don't even have a lock yet. Dryrun is a bool which
indicates if we are in dryrun mode.
- self.prerun(dryrun)
This is run after we've gotten a lock, written a pidfile and initialized our repo object (but not touched the repo yet)
- self.post_repo_up(dryrun)
This is code to run after we've updated the repo, but before we've done any work to parse it.
- self.postrun(dryrun, success, msg)
After we've parsed the updates to the repo and uploaded/deleted the relevant
items from the local server. Success is a bool for whether we succeeded, and
msg is the status message - either the revision we sync'd or an error.
- self.atexit(dryrun, success, msg)
Same as postrun, but is registered as an atexit function so it happens even if we crash.
See the LICENSE file in this repo.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent