Chef conf-2014
11 likes5,026 views
This document discusses best practices for creating self-contained software releases using Berkshelf and Chef. It recommends packaging the software artifact, cookbook artifact, and documentation together. The cookbook artifact contains the cookbooks and dependencies locked to a specific version. Berkflow is introduced as a tool to install and upgrade environments using these packaged artifacts. Following these practices allows for portable, repeatable, and predictable automation.
![$ cat cookbook/attributes/default.rb
#
# Cookbook Name:: berkshelf-api
# Attribute:: default
#
default[:berkshelf_api][:release] =
"v#{Berkshelf::API::Chef.cookbook_version(run_context)}"](https://image.slidesharecdn.com/chef-conf-2014-140418014710-phpapp02/85/Chef-conf-2014-43-320.jpg)
![$ cat cookbook/libraries/berkshelf_api.rb
#
# Cookbook Name:: berkshelf-api
# Libraries:: berkshelf_api
#
module Berkshelf
module API
module Chef
class << self
# Returns the version of the loaded berkshelf-api cookbook
#
# @param [Chef::RunContext] context
#
# @return [String]
def cookbook_version(context)
context.cookbook_collection["berkshelf-api"].version
end
end
end
end
end](https://image.slidesharecdn.com/chef-conf-2014-140418014710-phpapp02/85/Chef-conf-2014-44-320.jpg)
![$ cat cookbook/recipes/app.rb
node.set[:'build-essential'][:compile_time] = true
include_recipe "build-essential::default"
asset = github_asset "berkshelf-api.tar.gz" do
repo "berkshelf/berkshelf-api"
release "v1.2.1"
end
libarchive_file "berkshelf-api.tar.gz" do
path asset.asset_path
extract_to "/opt/berkshelf-api/v1.2.1"
owner "berkshelf"
group "berkshelf"
action :extract
notifies :restart, "runit_service[berks-api]"
only_if { ::File.exist?(asset.asset_path) }
end](https://image.slidesharecdn.com/chef-conf-2014-140418014710-phpapp02/85/Chef-conf-2014-50-320.jpg)
Chef conf-2014
- 1. Whatdo I dowith my hands Andwhyis my posture so bad ByJamieWinsor
- 3. berkshelf Chef Cookbook manager and dependency resolver » Retrieve a cookbooks dependencies » Package cookbooks and their dependencies » Author new cookbooks
- 6. BerkshelfCoreTeam » Jamie Winsor <jamie@vialstudios.com> » Seth Vargo <sethvargo@gmail.com> » Michael Ivey <michael.ivey@riotgames.com>
- 9. The BerkshelfWay » Introduction to Chef Cookbooks » Introduction to Cookbook Patterns » Best practices in » Cookbook development » Cookbook management » Avoiding pitfalls » How to iterate quickly Last year I gave a talk at ChefConf called The
- 10. “Berkshelf doesn'twork for my workflow” A lot of smart people
- 12. Automation is dangerous unless » It is portable » It is repeatable » It is predictable
- 15. “Ifyou putthe right people inthe right roomthey'llsolve the problemthe rightway” Jeff Hackert
- 18. DevOps is not » A position » A team » A department » Or an organization
- 19. “Disruptive startup is hiring DevOps ninjas” LinkedIn Spammer
- 21. ComingTogether
- 24. The 3 Requirements For Self Contained Releases 1.Software Artifact (berkshelf-api.tar.gz) 2.Cookbook Artifact (berkshelf-api-cookbooks.tar.gz) 3.Installation | Upgrade | Configuration Docs
- 25. Ifyou'readeveloper Give these three things to your Operators for every release.
- 26. Ifyou'rean Operator You should be receiving these three things for every release.
- 27. Ifyou're both, Throw a fucking pizza party
- 28. Withthose 3thingsyou can » Build a new environment with a specific version » Upgrade pre-existing environments » Promote through logical environments (Dev, Stage, Production)
- 29. Automation is dangerous unless » It is portable » It is repeatable » It is predictable
- 31. ArtifactServers » Github | Github Enterprise » Sonatype's Nexus » Artifactory » Basic Auth HTTP Server (sadface) (https://artifacts.myorg.com/myapp/1.2.3/ myapp.tar.gz)
- 36. The SoftwareArtifact 1.Bump version 2.Compile w/ dependencies 3.Test 4.Package (myapp.tar.gz)
- 37. The CookbookArtifact Pre-requisites » Resides in the same repository as your software » Shares the same version number as your compiled software » Deploys an archive of the software matching the cookbook's version (by default) » Follows the Environment Cookbook pattern
- 38. EnvironmentCookbook » Nearly identical to an Application Cookbook » Has it's Berksfile.lock committed into version control Generate an environment cookbook with: $ berks cookbook {myapp} --pattern environment
- 39. How does itwork? The Berksfile.lock is distributed with the cookbook so it can be "applied" to a Chef Environment $ berks apply berks-api-dev -b ~/Downloads/berkshelf-api/Berksfile.lock This sets an equality lock in the Chef Environment (berks-api-dev) for each cookbook in the lockfile
- 40. Berkshelf-API Server Example » Code in lib/ » Binaries in bin/ » Cookbook in cookbook/ » cookbook/Berksfile.lock present in version control
- 41. $ cat cookbook/metadata.rb lib = File.expand_path('../../lib', __FILE__) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) require 'berkshelf/api/version' name "berkshelf-api" maintainer "Jamie Winsor" maintainer_email "jamie@vialstudios.com" license "Apache 2.0" description "Installs/Configures a berkshelf-api server" long_description "Installs/Configures a berkshelf-api server" version Berkshelf::API::VERSION
- 42. Or with a VERSION file at the root of your application $ cat cookbook/metadata.rb name "some-app" maintainer "Jamie Winsor" maintainer_email "jamie@vialstudios.com" version File.read(File.expand_path("../../VERSION", __FILE__)) # ...other metadata...
- 43. $ cat cookbook/attributes/default.rb # # Cookbook Name:: berkshelf-api # Attribute:: default # default[:berkshelf_api][:release] = "v#{Berkshelf::API::Chef.cookbook_version(run_context)}"
- 44. $ cat cookbook/libraries/berkshelf_api.rb # # Cookbook Name:: berkshelf-api # Libraries:: berkshelf_api # module Berkshelf module API module Chef class << self # Returns the version of the loaded berkshelf-api cookbook # # @param [Chef::RunContext] context # # @return [String] def cookbook_version(context) context.cookbook_collection["berkshelf-api"].version end end end end end
- 45. Generatingthe Cookbookartifact $ cd cookbook/ $ berks package Cookbook(s) packaged to cookbooks-1397345842.tar.gz Thearchive contains » The Berksfile.lock from resolution » A cookbooks directory containing each cookbook found in the Berksfile.lock
- 46. How do I gettheartifacts intoa Github release? » Octokit & Rake/Thor » Create a release manually and attach the asset (boo.)
- 47. Howdo I getthe artifacts out?
- 48. Github Cookbook Provides an LWRP for downloading » An asset from a Github release » An archive containing source code from a tag, branch, or revision Libarchive Cookbook Provides an LWRP for idempotently extracting archives
- 49. $ cat cookbook/metadata.rb name "berkshelf-api" maintainer "Jamie Winsor" maintainer_email "jamie@vialstudios.com" # ... other metadata ... depends "github" depends "libarchive" depends "build-essential", "~> 2.0"
- 50. $ cat cookbook/recipes/app.rb node.set[:'build-essential'][:compile_time] = true include_recipe "build-essential::default" asset = github_asset "berkshelf-api.tar.gz" do repo "berkshelf/berkshelf-api" release "v1.2.1" end libarchive_file "berkshelf-api.tar.gz" do path asset.asset_path extract_to "/opt/berkshelf-api/v1.2.1" owner "berkshelf" group "berkshelf" action :extract notifies :restart, "runit_service[berks-api]" only_if { ::File.exist?(asset.asset_path) } end
- 51. The StorySo Far » We have an encapsulated release containing » A software artifact » A cookbook artifact » And you wrote and committed a README containing installation/configuration instructions » It's located on an artifact server » Bonus round: The release is also tied to the version control ref it was built from
- 54. InstallBerkflowwith Chef-DK $ sudo chef gem install berkflow $ export PATH=/opt/chefdk/embedded/bin:$PATH $ which blo /opt/chefdk/embedded/bin/blo Install with sudo for now: (https://github.com/opscode/chef-dk/issues/11)
- 55. "Install"the cookbookartifact intoyour ChefServer $ blo install https://github.com/berkshelf/berkshelf-api/releases/download/v1.2.1/cookbooks.tar.gz
- 56. "Upgrading"aChefEnvironment $ blo upgrade berks-api-dev berkshelf-api 1.2.1 Or upgrade to latest $ blo upgrade berks-api-dev berkshelf-api latest
- 58. WannaMake Games? http://undeadlabs.com/jobs/ » Game Programmer » Game Producer » Game Animator » Game Designer
- 59. ExternalResources » http://berkshelf.com » http://getchef.com/downloads/chef-dk » https://github.com/berkshelf/berkshelf » https://github.com/berkshelf/berkshelf-api » https://github.com/reset/berkflow » https://github.com/reset/libarchive-cookbook » https://github.com/reset/github-cookbook