Should I use include_recipe or add the recipe to run_list?

chef-infra recipe chef-recipe
Micah picture Micah · Jun 5, 2013 · Viewed 42.5k times · Source

Trying to figure out the best approach for a large project. When is it appropriate to add recipes within a recipe by using include_recipe as opposed to adding the recipe to the run_list? Is there a good rule of thumb?

Answer

Draco Ater picture Draco Ater · Jun 10, 2013

As I see it, any recipe should be able to run on an empty machine on its own. So if some recipe A depends on recipe B run before it, I always use include_recipe.

For example: 2 cookbooks, tomcat and java. Tomcat requires java.

  1. When some user wants to install tomcat, he may have no idea that he actually requires some other cookbook to install it. He runs the tomcat recipe and either it fails with some completely unhelpful error message like "No java found" or even worse - it succeeds, but then of course the user cannot start tomcat, because he does not have java installed.

  2. But when there is a include_recipe 'java' line in tomcat cookbook, which also requires a depends 'java' line in metadata, the user when trying to install tomcat, will see the understandable error message: "the cookbook java not found". This way actually user can download dependencies on his own (or even with some automatic tool) without actually running recipes, but reading metadata.

Related questions

Using a variable inside a Chef recipe

I'm using chef-cookbook-hostname cookbook to setup node's hostname. I don't want my hostname to be hard coded in the attribute file (default['set_fqdn']). Instead the hostname will be read from a VM definition XML file. I come up with …

Read More
How to get a linux command output to chef attribute

I want to get a command output into a chef attribute. Can some one help me how to set that in execute resource or bash resource. ruby_block "something" do block do #tricky way to load this Chef::Mixin::ShellOut …

Read More
Chef - execute vs bash resource

I used both the execute resource or the bash resource. Both achieve the same result: bash 'Execute my script' do user 'root' cwd '/mydir' code <<-EOH ./myscript.sh EOH end execute 'Execute my script' do user 'root' …

Read More