{"id":6537,"date":"2017-03-10T11:47:55","date_gmt":"2017-03-10T03:47:55","guid":{"rendered":"http:\/\/rmohan.com\/?p=6537"},"modified":"2017-03-10T11:48:29","modified_gmt":"2017-03-10T03:48:29","slug":"berkshelf","status":"publish","type":"post","link":"https:\/\/mohan.sg\/?p=6537","title":{"rendered":"BERKSHELF"},"content":{"rendered":"
<\/div>\n

BERKSHELF<\/a><\/h1>\n

Manage a Cookbook or an Application’s Cookbook dependencies<\/p>\n

\n
$ gem install berkshelf\r\nSuccessfully installed berkshelf-2.0.0\r\n1 gem installed\r\n<\/code><\/pre>\n<\/div>\n
Specify your dependencies in a Berksfile in your cookbook\u2019s root<\/p>\n
\n
site :opscode\r\n\r\ncookbook 'mysql'\r\ncookbook 'nginx', '~> 0.101.5'\r\n<\/code><\/pre>\n<\/div>\n
Install the cookbooks you specified in the Berksfile and their dependencies<\/p>\n
\n
$ berks install\r\n<\/code><\/pre>\n<\/div>\n
Add the Berksfile to your project<\/p>\n
\n
$ git add Berksfile\r\n$ git commit -m \"add Berksfile to project\"\r\n<\/code><\/pre>\n<\/div>\n
A Berksfile.lock will also be created. Add this to version control if you want to ensure that other developers (or your build server) will use the same versions of all cookbook dependencies.<\/p><\/blockquote>\n
MANAGING AN EXISTING COOKBOOK<\/h3>\n
If you already have a cookbook and it\u2019s not managed by Berkshelf it\u2019s easy to get up and running. Just locate your cookbook and initialize it!<\/p>\n
\n
$ berks init ~\/code\/my_face-cookbook\r\n<\/code><\/pre>\n<\/div>\n
CREATING A NEW COOKBOOK<\/h3>\n
Want to start a new cookbook for a new application or supporting application?<\/p>\n
\n
$ berks cookbook new_application\r\n<\/code><\/pre>\n<\/div>\n
GETTING HELP<\/h2>\n
If at anytime you are stuck or if you\u2019re just curious about what Berkshelf can do, just type the help command<\/p>\n
\n
$ berks help\r\n\r\nCommands:\r\n  berks apply ENVIRONMENT     # Apply the cookbook version locks from Berksfile.lock to a Chef environment\r\n  berks configure             # Create a new Berkshelf configuration file\r\n  berks contingent COOKBOOK   # List all cookbooks that depend on the given cookbook\r\n  berks cookbook NAME         # Create a skeleton for a new cookbook\r\n  berks help [COMMAND]        # Describe available commands or one specific command\r\n  berks init [PATH]           # Initialize Berkshelf in the given directory\r\n  berks install               # Install the cookbooks specified in the Berksfile\r\n  berks list                  # List all cookbooks (and dependencies) specified in the Berksfile\r\n  berks outdated [COOKBOOKS]  # Show outdated cookbooks (from the community site)\r\n  berks package [COOKBOOK]    # Package a cookbook (and dependencies) as a tarball\r\n  berks shelf SUBCOMMAND      # Interact with the cookbook store\r\n  berks show [COOKBOOK]       # Display name, author, copyright, and dependency information about a cookbook\r\n  berks update [COOKBOOKS]    # Update the cookbooks (and dependencies) specified in the Berksfile\r\n  berks upload [COOKBOOKS]    # Upload the cookbook specified in the Berksfile to the Chef Server\r\n  berks version               # Display version and copyright information\r\n\r\nOptions:\r\n  -c, [--config=PATH]    # Path to Berkshelf configuration to use.\r\n  -F, [--format=FORMAT]  # Output format to use.\r\n                         # Default: human\r\n  -q, [--quiet]          # Silence all informational output.\r\n  -d, [--debug]          # Output debug information\r\n<\/code><\/pre>\n<\/div>\n
You can get more detailed information about a command, or a sub command, but asking it for help<\/p>\n
\n
$ berks shelf help\r\n\r\nCommands:\r\n  berks shelf help [COMMAND]  # Describe subcommands or one specific subcommand\r\n  berks shelf list            # List all cookbooks and their versions\r\n  berks shelf show            # Display information about a cookbook in the Berkshelf shelf\r\n  berks shelf uninstall       # Remove a cookbook from the Berkshelf shelf\r\n<\/code><\/pre>\n<\/div>\n
THE BERKSHELF<\/h2>\n
After running berks install<\/code> you may ask yourself, \u201cWhere did my cookbooks go?\u201d. They were added to The Berkshelf.<\/p><\/blockquote>\n
The Berkshelf is a location on your local disk which contains the cookbooks you have installed and their dependencies. By default, The Berkshelf is located at ~\/.berkshelf<\/code> but this can be altered by setting the environment variable BERKSHELF_PATH<\/code>.<\/p>\n
Berkshelf stores every version of a cookbook that you have ever installed. This is the same pattern found with RubyGems where once you have resolved and installed a gem, you will have that gem and it\u2019s dependencies until you delete it.<\/p>\n
This central location is not the typical pattern of cookbook storage that you may be used to with Chef. The traditional pattern is to place all of your cookbooks in a directory called cookbooks<\/code> or site-cookbooks<\/code> within your Chef Repository<\/a>. We do have all of our cookbooks in one central place, it\u2019s just not the Chef Repository and they\u2019re stored within directories named using the convention {<\/span>name<\/span>}<\/span>-<\/span>{<\/span>version<\/span>}<\/span><\/code>.<\/p>\n
Given you have the cookbooks installed:<\/p>\n
\n
* nginx - 0.101.2\r\n* mysql - 1.2.4\r\n<\/code><\/pre>\n<\/div>\n
These cookbooks will be located at:<\/p>\n
\n
~\/.berkshelf\/cookbooks\/nginx-0.101.2\r\n~\/.berkshelf\/cookbooks\/mysql-1.2.4\r\n<\/code><\/pre>\n<\/div>\n
By default Chef interprets the name of a cookbook by the directory name. Some Chef internals weigh the name of the directory more heavily than if a cookbook developer were to explicitly set the name<\/code> attribute in their metadata. Because the directory structure contains the cookbook\u2019s version number, do not treat The Berkshelf as just another entry in your Chef::Config#cookbooks_path<\/code>.<\/p>\n
VENDORING COOKBOOKS<\/h3>\n
You can easily install your Cookbooks and their dependencies to a location other than The Berkshelf. A good case for this is when you want to \u201cvendor\u201d your cookbooks to be packaged and distributed.<\/p>\n
\n
$ berks install --path vendor\/cookbooks\r\n<\/code><\/pre>\n<\/div>\n
This will install your Cookbooks to the vendor\/cookbooks<\/code> directory relative to where you ran the command from. Inside the vendored cookbooks directory you will find a directory named after the cookbook it contains.<\/p>\n
CONFIGURING BERKSHELF<\/h2>\n
Berkshelf will run with a default configuration unless you explicitly generate one. By default, Berkshelf uses the values found in your Knife configuration (if you have one).<\/p>\n
You can override this default behavior by generating an explicit Berkshelf configuration file with the configure<\/code> command<\/p>\n
\n
$ berks configure\r\n<\/code><\/pre>\n<\/div>\n
Answer each question prompt with a value or press enter to accept the default value. As with Berkshelf\u2019s default behavior, Berkshelf attempts to populate the default values from your Knife configuration (otherwise using something else sensible).<\/p>\n
\n
Config written to: '\/Users\/reset\/.berkshelf\/config.json'\r\n<\/code><\/pre>\n<\/div>\n
You will only be prompted to fill in the most travelled configuration options. Looking in the generated configuration will give you some insight to some other configurable values.<\/p>\n
\n
{<\/span>\r\n  \"chef\"<\/span>:<\/span> {<\/span>\r\n    \"chef_server_url\"<\/span>:<\/span> \"https:\/\/api.opscode.com\/organizations\/vialstudios\"<\/span>,<\/span>\r\n    \"validation_client_name\"<\/span>:<\/span> \"chef-validator\"<\/span>,<\/span>\r\n    \"validation_key_path\"<\/span>:<\/span> \"\/etc\/chef\/validation.pem\"<\/span>,<\/span>\r\n    \"client_key\"<\/span>:<\/span> \"\/Users\/reset\/.chef\/reset.pem\"<\/span>,<\/span>\r\n    \"node_name\"<\/span>:<\/span> \"reset\"<\/span>\r\n  },<\/span>\r\n  \"vagrant\"<\/span>:<\/span> {<\/span>\r\n    \"vm\"<\/span>:<\/span> {<\/span>\r\n      \"box\"<\/span>:<\/span> \"Berkshelf-CentOS-6.3-x86_64-minimal\"<\/span>,<\/span>\r\n      \"box_url\"<\/span>:<\/span> \"https:\/\/dl.dropbox.com\/u\/31081437\/Berkshelf-CentOS-6.3-x86_64-minimal.box\"<\/span>,<\/span>\r\n      \"forward_port\"<\/span>:<\/span> {<\/span>\r\n\r\n      },<\/span>\r\n      \"network\"<\/span>:<\/span> {<\/span>\r\n        \"bridged\"<\/span>:<\/span> true<\/span>,<\/span>\r\n        \"hostonly\"<\/span>:<\/span> \"33.33.33.10\"<\/span>\r\n      },<\/span>\r\n      \"provision\"<\/span>:<\/span> \"chef_solo\"<\/span>\r\n    }<\/span>\r\n  },<\/span>\r\n  \"ssl\"<\/span>:<\/span> {<\/span>\r\n    \"verify\"<\/span>:<\/span> true<\/span>\r\n  }<\/span>\r\n}<\/span>\r\n<\/code><\/pre>\n<\/div>\n
CONFIGURABLE OPTIONS<\/h3>\n