Site Map

[edit on GitHub]

This is the documentation for

  • Chef, including the Chef server, the Chef client, the Chef development kit (Chef DK) and related tools
  • Habitat
  • InSpec
  • Chef Automate

This page has links to each topic in this doc set. You can also use the navigation tool or the search box to find what you’re looking for.

If you need documentation for previous versions, you can use the dropdown box labeled “Filter by product and version” to select the particular component and version you want.

If this is your first visit, we recommend reading how to learn Chef.

Overview

Platform Overview

Platform Overview

Packages and Platforms

Packages | Platforms | Omnitruck API | Licensing

Chef

Cookbook Reference

About Cookbooks | Attributes | Definitions | Files | Libraries

Recipes: About Recipes | Debug Recipes, Client Runs

Resources: About Resources | Common Functionality | Custom Resources | All Resources (Single Page) | apt_package | apt_repository | apt_update | bash | batch | bff_package | breakpoint | cab_package | chef_acl | chef_client | chef_container | chef_data_bag | chef_data_bag_item | chef_environment | chef_gem | chef_group | chef_handler | chef_mirror | chef_node | chef_organization | chef_role | chef_user | chocolatey_package | cookbook_file | cron | csh | deploy | directory | dpkg_package | dsc_resource | dsc_script | easy_install_package | env | erl_call | execute | file | freebsd_package | gem_package | git | group | homebrew_package | http_request | ifconfig | ips_package | ksh | launchd | link | log | macports_package | mdadm | mount | ohai | openbsd_package | osx_profile | package | pacman_package | paludis_package | perl | portage_package | powershell_script | private_key | public_key | python | reboot | registry_key | remote_directory | remote_file | route | rpm_package | ruby | ruby_block | script | service | smartos_package | solaris_package | subversion | systemd_unit | template | user | windows_package | windows_service | yum_package | yum_repository | Examples (by Resource)

Templates | Cookbook Repo | metadata.rb | Cookbook Versions | Ruby

Chef Automate Cookbooks: build-cookbook (cookbook) | delivery-truck (cookbook) | Publish Cookbooks to Multiple Chef Servers

Chef DK

Berkshelf | chef-apply (executable) chef-shell (executable)

chef (executable):chef env | chef exec | chef gem | chef generate app | chef generate attribute | chef generate cookbook | chef generate file | chef generate lwrp | chef generate recipe | chef generate repo | chef generate template | chef provision | chef shell-init | chef verify

Chef Solo: About Chef Solo | chef-solo (executable) | solo.rb

chef-shell (executable) | chef-zero (local mode) | chef-vault | ChefSpec

Configuration: config.rb | Multiple Config Files

cookstyle | Delivery CLI | Foodcritic

Kitchen: About Kitchen | kitchen (executable) | .kitchen.yml kitchen-vagrant

Knife: About Knife | Common Options | Using Knife | knife.rb | knife bootstrap | knife client | knife configure | knife cookbook | knife cookbook site | knife data bag | knife delete | knife deps | knife diff | knife download | knife edit | knife environment | knife exec | knife list | knife node | knife raw | knife recipe list | knife role | knife search | knife serve | knife show | knife ssh | knife ssl_check | knife ssl_fetch | knife status | knife tag | knife upload | knife user | knife xargs

knife opc: About knife opc | knife.rb Configuration | opc user list | opc user show | opc user create | opc user delete | opc user edit | Example | opc org list | opc org show | opc org create | opc org delete | opc org user add | opc org user remove

knife spork |

knife supermarket: supermarket download | supermarket install | supermarket list | supermarket search | supermarket share | supermarket show | supermarket unshare

Ohai: About Ohai | ohai (executable)

Policyfile: About Policyfile | Policyfile.rb

Provisioning: About Provisioning | load_balancer resource | machine resource | machine_batch resource | machine_execute resource | machine_file resource | machine_image resource | AWS Driver Resources | Fog Driver Resources | Vagrant Driver Resources

push-jobs-client (executable) | Rubocop

Habitat

Habitat Overview

Habitat Overview | Prism

Tutorials

InSpec

InSpec Overview

InSpec Overview

Chef Automate

Delivery CLI

Delivery CLI

Workflow DSL

Workflow DSL

Job Dispatch

Job Dispatch

AWS OpsWorks for Chef Automate

AWS OpsWorks for Chef Automate

Troubleshooting

Troubleshooting