pan is an example cookbook generator
- Mac OSX 10.10 with ChefDK 3.5
- Windows 7 with ChefDK 3.5
While in the directory you wish to create your cookbook:
chef generate cookbook my_cookbook_name -g ~/path/to/pan
- create a cookbook named my_cookbook_name in the same subdirectory where pan resides.
(Mac & Windows): chef generate cookbook my_cookbook_name -g ./pan
- create a cookbook named my_cookbook_name in the root of your primary drive with pan residing in your home directory
(Mac): chef generate cookbook /mycookbook -g ~/pan
(Windows): chef generate cookbook C:\mycookbook -g %USERPROFILE%\pan
- Why is there a top level folder called
code_generator?
A: The chef command line tool expects a folder with this name in order to work correctly.
Things you might not be familiar with that this generator creates:
- IO.read(File.join(File.dirname(FILE) 5BF9 , 'README.md'))
- A hack to force Chef Manage to display the contents of the README.md. (Perhaps this will be fixed in Chef 12?)
- privacy true
- A new setting in metadata to ensure that cookbooks cannot be accidentally uploaded to the public Supermarket. (Great if you have an internal supermarket). Warning: Seems to cause failures with chef_solo at the moment.
- Text isn't aligned
- This blows up rubocop, and I'd rather have it more standardized. Just say no to vertical whitespace. ;)
- default['<%= @attribute_context %>']['file_cache_path']
- I like to do this so that I can create a "workspace" for the cookbook to drop any files in so I avoid cookbook download collisions. If your cookbook doesn't download anything, than you can trash this.
- It also provides a good example of how to do an attribute.
- chef_zero provisioner
- It's probably stronger to provision with chef_zero than chef_solo since it behaves more like the server does. (That is to say, if you use chef server, then test with chef zero. If you're using solo, then test with solo.)
- Windows 2012 R2 with WinRM transport
- Ideally this is how you would set up the transport for WinRM with Kitchen, if you're using Salim Afiune's patch for Test Kitchen.
-
I think it's better to create the items in the cookbook by using data driven patterns, so if you add something new it's fairly simple. The patterns speak for themselves. Perhaps there's a better way still.
-
Using the :create_if_missing action is stronger here because you can use it to stub out already existing cookbooks without blowing up existing work.