Site Map¶
This is the documentation for:
- Chef, including the Chef server, the Chef client, the Chef development kit (ChefDK) and related tools
- Chef Automate
For information on Habitat and InSpec, see their respective documentation:
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 are new to Chef, we highly recommend the Getting Started track on Learn Chef to familarize yourself with Chef concepts.
If you need documentation for previous versions, see the Docs Archive.
Overview¶
Chef Platform Overview¶
Community¶
About the Community | Contributing | Guidelines | Docs Style Guide
Packages and Platform Support¶
Packages | Platforms and Supported Versions | Omnitruck API | Licensing
Chef¶
Getting Started¶
Chef Overview | Quick Start | System Requirements
Chef Workstation: Chef Workstation Beta | Documentation
Release Notes: Chef Client | Chef Development Kit | Chef Server | Chef Push Jobs |
Concepts¶
Workstation | chef-repo | Nodes | Chef Client Overview | 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) | Share Cookbooks on the Chef Supermarket
Appendix: Env Variables | Troubleshooting | Glossary
Setup¶
Proxies | ChefDK on Windows | Workstation
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 | Upgrade High Availability | Integrate Chef Compliance with Chef Server
Supermarket: Public Supermarket | Install Private Supermarket | Customize Supermarket | Run in Kitchen
Management Console | Push Jobs
Integrations: AWS Marketplace | Microsoft Azure | Google Cloud Platform | VMware
Cookbook Reference¶
About Cookbooks | Attributes | Files | Libraries
Recipes: About Recipes | Debug Recipes, Client Runs
Resources: About Resources | Common Functionality | Custom Resources | All Resources (Single Page) | Examples (by Resource)
apt_package | apt_preference | apt_repository | apt_update | bash | batch | bff_package | breakpoint | build_essential | 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_config chocolatey_package chocolatey_source cookbook_file | cron | cron_d | cron_access | csh | deploy | directory | dmg_package | dpkg_package | dsc_resource | dsc_script | windows_env | erl_call | execute | file | freebsd_package | gem_package | git | group | homebrew_cask | homebrew_package | homebrew_tap | hostname | http_request | ifconfig | ips_package | kernel_module | ksh | launchd | link | log | locale | macos_userdefaults | macports_package | mdadm | mount | ohai | ohai_hint | openbsd_package | openssl_dhparam | openssl_ec_private_key | openssl_ec_public_key | openssl_rsa_private_key | openssl_rsa_public_key | openssl_x509_certificate | openssl_x509_crl | openssl_x509_request | osx_profile | package | pacman_package | paludis_package | perl | portage_package | powershell_package | powershell_package_source | powershell_script | private_key | public_key | python | reboot | registry_key | remote_directory | remote_file | route | rpm_package | ruby | ruby_block | script | rhsm_errata | rhsm_errata_level | rhsm_register | rhsm_repo | rhsm_subscription | service | smartos_package | solaris_package | ssh_known_hosts_entry | subversion | sudo | swap_file | sysctl | systemd_unit | template | user | windows_ad_join | windows_auto_run | windows_feature | windows_feature_dism | windows_feature_powershell.html | windows_font | windows_package | windows_printer.html | windows_printer_port | windows_service | windows_shortcut | windows_task | windows_workgroup | yum_package | yum_repository | dnf_package | zypper_package | zypper_repository
Templates | Cookbook Repo | metadata.rb | Cookbook Versioning | Ruby
Chef Automate Cookbooks: build-cookbook (cookbook) | delivery-truck (cookbook) | Publish Cookbooks to Multiple Chef Servers
ChefDK¶
About ChefDK | 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 build-cookbook | chef generate file | chef generate resource | chef generate recipe | chef generate repo | chef generate template | chef provision | chef shell-init
Chef Solo: About Chef Solo | chef-solo (executable) | solo.rb | 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 | Setting up Knife | 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 supermarket | knife tag | knife upload | knife user | knife xargs | knife azure | knife_azurerm | knife windows
knife opc: About knife opc | config.rb Configuration | opc user list | opc user show | opc user create | opc user delete | opc user delete | opc org list | opc org show | opc org create | opc org delete | opc org user add | opc org user remove | knife spork
Ohai: About Ohai | ohai (executable)
Policyfile: About Policyfile | Policyfile.rb
Managing the Server: Runbook (Single Page) | Backend Cluster Failure Recovery | 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
Supermarket: Log Files | Backup and Restore | Monitoring | supermarket.rb | knife supermarket | supermarket-ctl | Supermarket API
Management Console: Configure SAML | Clients | Cookbooks | Data Bags | Environments | Nodes | Roles | Users | manage.rb | chef-manage-ctl
Legacy¶
Analytics¶
Overview | Release Notes | Install Standalone | Web UI | Management Console | Nodes View | Integrations | Splunk | Rules | Monitor | Upgrades | Chef Client for Analytics | opscode-analytics-ctl | opscode-analytics.rb | knife-analytics | Analytics API | Recipe DSL for Analytics
Chef Automate 1¶
Overview: Chef Automate Overview | Workflow Overview | Nodes Overview | Compliance Overview | Administration Overview
Getting Started: Installation Guide | Configure a Pipeline | Configure a Project | Configure Data Collection | Data Collection and Chef HA | Data Collection without Chef Server | Stream Data | Upgrades
Release Notes: Release Notes
Nodes: Node Notifications w/Slack | Node Notifications w/Webhooks | Node Search Reference
Compliance: Reporting | Scanner | Profile Store | Credentials
Workflow: build-cookbook (cookbook) | delivery-truck (cookbook) | Manage Dependencies | Runners | Workflow w/Bitbucket | Workflow w/Email (SMTP) | Workflow w/GitHub | Workflow w/Slack
Admin: Authentication w/LDAP | Authentication w/SAML
Managing the Server: Backups | Capacity Planning | Disaster Recovery | Elasticsearch and Kibana Authentication | Secrets | Data Retention Management in Chef Automate | Tuning | Users and Roles
Reference: Chef Automate API | Automate CTL | Chef Compliance API | Delivery CLI | delivery.rb | Workflow DSL
Chef Automate for Microsoft Azure: Chef Automate for Microsoft Azure
AWS OpsWorks for Chef Automate: AWS OpsWorks for Chef Automate
Troubleshooting: Troubleshooting
Compliance scanner¶
Overview | Installation Guide | Integrate w/Chef Server | Integrate w/Chef Automate | Upgrade Compliance | chef-compliance.rb | Profile Store Chef Compliance for Microsoft Azure
Reporting¶
Overview | Install Reporting | View Reports | knife reporting | opscode-reporting-ctl | opscode-reporting.rb | Reporting API
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)