Engine Yard Developer Center

Custom Chef

 

Customization is a Major Design Goal of stable-v5

In stable-v5-3.0, there are no longer separate main and custom chef runs -- there is a single run, based on the main cookbook, that can be over-laid with customizations. The github repo can be found here

Historically, customizations have been the killer feature of Engine Yard Cloud (coupled with unparalleled support), but have also been a bane on progress. As customizations are often dependent on specific stack releases, we are restricted in our ability to keep every customer up-to-date on the latest version.

Thus, as important as your customization is to your application today, so should it be equally important that you maximize it's future chances of compatibility. In some cases this means submitting a contribution back to the mainline repository (this one) to insert a hook or variable for just the thing you need to tweak, and then adjusting your customizations accordingly when your change is accepted and released. If in doubt, just open a support ticket and we'll take a look at the custom cookbooks you've concocted.

If you've used custom chef on Engine Yard before...

Throw out your existing understanding of how it works! Previous versions (and the still supported stable-v4 works this way) ran chef twice. There was a main run (Engine Yard's code) and a custom run (Customer's code). This meant that if a customer wanted to customize something there would always be a brief period of time between the main and custom runs where their change would be un-done until the custom run completed. No More! With stable-v5 (and going forward) customizations are done as an overlay on the main cookbooks repository.

Chef configures instances in your environment

Engine Yard's Chef stack provides the platform upon which your applications run. Based on the configuration options you choose when creating your environment, Chef will do the work of setting up things like: haproxy, nginx, mysql, and unicorn. We call this setup an "Apply". Whenever you make a configuration change such as adding an SSL certificate, you must "Apply" those changes into reality on your instances. The Chef run may create or modify files and install or upgrade software packages as a result.

The file /etc/dna.json is the main input to the Chef run, telling the cookbooks what kind of instance they are running on (such as app or DB), and what other servers and services are connected. This repository, and specifically the cookbooks folder comprise the main program passed to chef-solo.

Customize your environment with Custom Chef

Each environment managed by Engine Yard supports the ability to upload a folder of custom cookbooks. When you run "Apply", before the chef run begins, the process pulls down both the exact cookbooks version your environment is running (e.g. stable-v5-3.0.11), and (if they exist) the latest custom cookbooks for that environment.

See also: example custom cookbooks in /custom-cookbooks.

The custom cookbooks folder is extracted on top of the main cookbooks folder. If a file exists in both folders, the custom one will overwrite the main one. This means you could literally replace the entire cookbooks run with your own code, or just customize 1 file.

With the great power to fork this whole repository and change just 1 files, comes the responsibility to scope your changes down to the bare minimum for the benefit of future upgrades.

Additionally, this design allows for 2 major ways of customizing chef without overwriting: hooks and attributes.

Hooks

Hooks are empty files such as cookbooks/ey-custom/recipes/before-main.rb and cookbooks/ey-custom/recipes/after-main.rb which are guaranteed to always be empty files in the main chef repository (or contain only comments). A blank file is a perfectly valid ruby file, thus these files are included via include_recipe at appropriate places in the main run. Adding to these files allow you to add cookbooks with recipes to be run directly before or directly after the rest of the main cookbooks.

If you find yourself wanting your custom cookbook to run somewhere specific in the middle of run, you can submit a Pull Request to add the hook you need for inclusion into the next stack release (Submit against the branch next-release).

Attributes

Much configuration is controlled by attributes files. Most existing attributes files specify defaults of pull attributes out of DNA. Since chef will pickup any *.rb file place within the attributes folder of a cookbook, you can easily add (for example) the file cookbooks/postgresql/attributes/custom.rb and set the max_fsm_pages attribute to something other than the default.

If you find yourself wanting to customize something that isn't controlled by an attribute, but could be, you can submit a Pull Request to add the change you need for inclusion into the next stack release (Submit against the branch next-release).

Was this article helpful?
3 out of 8 found this helpful
Have more questions? Submit a request

Comments

  • Avatar
    Will

    Just to clarify a bit - custom chef is still an option on v5, and is more than encouraged. We don't have the idea of having a custom-only chef run, because custom recipes are just additional recipes that overlay the default recipes. Instead, there is an ability to do a chef run that only runs specific recipes. So, it's possible to run a specific recipe or recipes out of the whole set, if wanted.

  • Avatar
    Junichi Sakaeda

    I want to apply custom chef In stable-v5-3.0, how can I do it?

    Until now, it was a command like,
    ey recipes upload
    ey recipes apply

    Is there any operation to replace "ey recipes apply"?

    Should I apply with the apply button on the dashboard?

    Edited by Junichi Sakaeda
  • Avatar
    Paul Tingle

    Hi Junichi,

    Yes, as there is now just the one, combined, Chef run `ey recipes apply` is no longer valid. You should instead use `ey recipes upload` to upload your recipes then use the dashboard Apply button or the `ey rebuild` command to run the combined Chef run on all instances.

  • Avatar
    Ilya Hoffman

Please sign in to leave a comment.

Powered by Zendesk