Site Map¶
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 documenation 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¶
Community¶
About the Community | Contributing | Guidelines | Docs Style Guide
Packages and Platforms¶
Chef¶
Getting Started¶
Chef Overview | Quick Start | System Requirements
Release Notes: Chef Client | Chef Server
Tutorials¶
Concepts¶
Workstation | chef-repo | Nodes | chef-client | Server | Search | Cookbooks | Handlers | Management Console
Policy: About Policy | Data Bags | Environments | Roles
Push Jobs | Reporting | Run-lists
Security:Authentication | Authorization | Private Keys | FIPS-mode
Supermarket: Public Supermarket (overview) | Private Supermarket (overview)
Appendix: Env Variables | Troubleshooting | Glossary
Setup¶
Nodes:Install via Bootstrap | Install via URL | Install on Windows | Install on Junos OS | chef-client (executable) | client.rb | Upgrades | Security
Server: Hosted Chef Server | Install Standalone | Install High Availability | AWS Marketplace | Microsoft Azure | Openstack
Supermarket: Public Supermarket | Install Private Supermarket | Customize Supermarket | Run in Kitchen
Management Console | Push Jobs | Reporting
Integrations: w/Chef Compliance
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 Cookbooks: Chef-maintained | chef-handler (cookbook)
Chef Automate Cookbooks: build-cookbook (cookbook) | delivery-truck (cookbook)
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 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
Managing the Server¶
Runbook (Single Page) | Backup and Restore | Data Storage | Firewalls and Ports | Active Directory and LDAP | Log Files | Monitor | Organizations and Groups | Secrets | Security | Services | Tuning | Upgrades | Upgrade HA Cluster | Users | chef-server-ctl | chef-backend-ctl | chef-server.rb | opscode-expander-ctl | Chef Server API
Push Jobs:knife push jobs | push-jobs-client | push-jobs-client.rb | push-jobs-server.rb | Push Jobs API | Server Sent Events
Reporting:View Reports | knife reporting | opscode-reporting-ctl | Reporting API
Supermarket:Log Files | Monitoring | supermarket.rb | knife supermarket | supermarket-ctl | Cookbooks Site API
Management Console: Configure SAML | Clients | Cookbooks | Data Bags | Environments | Nodes | Roles | Users | manage.rb | chef-manage-ctl
Chef Automate¶
Getting Started¶
Tutorials¶
Install Chef Automate | Visibility into Infrastructure | Deploy with Chef Automate | Assess for Compliance | Remediate Compliance Failures
Concepts¶
Workflow: Workflow Overview | Manage Dependencies
Delivery CLI¶
Integrations¶
w/Bitbucket | w/Email (SMTP) | w/GitHub | w/LDAP | w/SAML | w/Slack
Cookbooks¶
Workflow DSL¶
Managing the Server¶
Backups | Capacity Planning | delivery.rb | Delivery API | Disaster Recovery | Secrets | Manage Elasticsearch Indices | Node Search Reference | Stream Data | Tuning | Upgrades | Users and Roles | cleanse | create-enterprise | create-user | delete-application | delete-enterprise | delete-project | delete-user | list-applications | list-enterprises | list-users | migrate-change-description | migrate-patchset-diffs | reconfigure | rename-enterprise | revoke-token | show-config | uninstall | update-project-hooks
Compliance scanner¶
Overview | Installation Guide | Integrate w/Chef Server | Integrate w/Chef Automate | Upgrade Compliance | chef-compliance.rb | Chef Compliance API
Troubleshooting¶
Extension APIs¶
Resources¶
Recipe DSL: attribute? | control | control_group | cookbook_name | data_bag | data_bag_item | platform? | platform_family? | reboot_pending? | recipe_name | registry_data_exists? | registry_get_subkeys | registry_get_values | registry_has_subkeys? | registry_key_exists? | registry_value_exists? | resources | search | shell_out | shell_out! | shell_out_with_systems_locale | tag | tagged? | untag | value_for_platform | value_for_platform_family | Windows Platform Helpers
Handlers¶
Knife Plugins¶
About Cloud Plugins | Custom Plugins | Community Plugins (knife)