Skip to main content

Site Map

[edit on GitHub]

This is the documentation for:

  • Chef Infra Server, Chef Infra Client, Chef Workstation, and related tools

Documentation for other Chef products:

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 Infra, we highly recommend the Getting Started track on Learn Chef to familiarize yourself with Chef Infra concepts.

If you need documentation for previous versions, see the Docs Archive.

Overview

Chef Platform Overview

Platform Overview

Community

About the Community | Contributing | Guidelines | Docs Style Guide

Packages and Platform Support

Packages | Platforms | Supported Versions | Omnitruck API

Licensing: About Licensing | Accepting License

Chef Infra

Getting Started

Chef Infra Overview | Quick Start | System Requirements

Release Notes: Chef Infra Client | ChefDK | Chef Infra Server | Chef Push Jobs |

Deprecations

Concepts

Chef Workstation | chef-repo | Nodes | Chef Infra Client Overview | Chef Infra Server Overview | Search | Cookbooks | Handlers

Policy: About Policy | Data Bags | Environments | Roles

Push Jobs | Run-lists

Security: Authentication | Authorization | FIPS-mode

Supermarket: Supermarket | Public Supermarket (overview) | Private Supermarket (overview) | Share Cookbooks on the Chef Supermarket

Appendix: Troubleshooting | Glossary

Guides

Chef on Azure: Microsoft Azure Portal | Chef Workstation in Azure Cloud Shell | Microsoft Azure PowerShell | Microsoft Azure Chef Extension | Knife Azure </knife_azure.html>__ | `Knife Azurerm </knife_azurerm.html>__

Chef on Microsoft Windows: Chef for Microsoft Windows | Chef Infra Client on Windows Nodes | Knife Windows

Setup

Proxies | Install Chef Workstation

Nodes: Install via Bootstrap | Install via Script | chef-client (executable) | client.rb | Upgrades | Security

Server: Hosted Chef Infra Server | Install Standalone | Chef Infra Server Prerequisites | Tiered Installation | Install High Availability | Upgrade High Availability

Supermarket: Public Supermarket | Install Private Supermarket | Customize Supermarket | Run in Kitchen

Management Console | Push Jobs

Integrations: AWS Marketplace | Microsoft Azure | Google Cloud Platform | VMware

Air-gapped Installation | Microsoft Windows | Uninstall

Cookbook Reference

About Cookbooks | Attributes | Files | Libraries

Recipes: About Recipes | Debug Recipes, Client Runs

Resources: About Resources | Common Resource Functionality | Custom Resources | Custom Resources Guide | Converting Definitions to Custom Resources

All Resources (Single Page) | apt_package | apt_preference | apt_repository | apt_update | archive_file | 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_sleep | chef_user | chocolatey_config | chocolatey_feature | chocolatey_package | chocolatey_source | cookbook_file | cron | cron_d | cron_access | csh | directory | dmg_package | dnf_package | dpkg_package | dsc_resource | dsc_script | 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 | msu_package | 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 | python | reboot | registry_key | remote_directory | remote_file | rhsm_errata | rhsm_errata_level | rhsm_register | rhsm_repo | rhsm_subscription | route | rpm_package | ruby | ruby_block | script | service | smartos_package | snap_package | solaris_package | ssh_known_hosts_entry | subversion | sudo | swap_file | sysctl | systemd_unit | template | timezone | user | windows_ad_join | windows_auto_run | windows_certificate | windows_dfs_folder | windows_dfs_namespace | windows_dfs_server | windows_dns_record | windows_dns_zone | windows_env | windows_feature | windows_feature_dism | windows_feature_powershell | windows_firewall_rule | windows_font | windows_package | windows_pagefile | windows_path | windows_printer | windows_printer_port | windows_service | windows_share | windows_shortcut | windows_task | windows_uac | windows_workgroup | yum_package | yum_repository | zypper_package | zypper_repository Templates | Cookbook Repo | metadata.rb | Cookbook Versioning | Ruby Guide

Chef Automate Cookbooks: build-cookbook (cookbook) | delivery-truck (cookbook) |

Chef Workstation

About Chef Workstation | Configure Chef Workstation | 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 shell-init

Chef Solo: About Chef Solo | chef-solo (executable) | solo.rb | chef-zero (local mode) | chef-vault | ChefSpec

Configuration: config.rb | Optional config.rb Settings | 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

Ohai: About Ohai | ohai (executable)

Policyfile: About Policyfile | Policyfile.rb

push-jobs-client (executable)

Managing Chef Infra Server: Runbook (Single Page) | Backend Cluster Failure Recovery | [Backup and Restore](/runbook/server_backup_restore/) | [Firewalls and Ports](/runbook/server_firewalls_and_ports/) | Active Directory and LDAP | [Log Files](/runbook/server_logs/) | [Monitor](/runbook/server_monitor/) | Organizations and Groups | Secrets | [Security](/runbook/server_security/) | [Services](/runbook/server_services/) | [Tuning](/runbook/server_tuning/) | Upgrades | Upgrade HA Cluster | Users | chef-server-ctl | chef-backend-ctl | chef-server.rb | Chef Server Optional Settings | opscode-expander-ctl | Chef Infra Server API

FIPS FIPS Overview

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: About the Management Console | Configure SAML | Clients | Cookbooks | Data Bags | Environments | Nodes | Roles | Users | manage.rb | chef-manage-ctl

Chef Automate

Chef Automate Documentation | Quick Start Demo | System Requirements | Installation Guide | Upgrade from Chef Automate One | Airgapped Installation Guide | Install Chef Habitat on-prem | Backup and Restore | Configuration | Data Lifecycle | Data Collection | LDAP Integration | Log Management | SAML Integration | Telemetry | Setting up the Applications Dashboard | Event Feed | Client Runs | Compliance Reports | Scan Jobs | Compliance Profiles | Notifications | Cloud Integrations | Node Credentials | Node Lifecycle | API Tokens | Users | Teams | API Tokens | Chef Automate CLI | Troubleshooting | IAM Overview | IAM Users Guide | IAM API Reference | Architecture | Chef Automate API | Chef Automate CLI | Monitoring Chef Automate | Troubleshooting

Chef Habitat

Documentation: Chef Habitat Documentation

Tutorials: Chef Habitat Tutorials

Chef InSpec

Documentation: Chef InSpec Documentation

Tutorials: Chef InSpec Tutorials

Legacy

Workflow

Workflow Basics: Workflow Overview | Configure a Pipeline | Configure a Project | Configure Data Collection | Data Collection with Chef HA | Data Collection without Chef Infra Server | Audit Cookbook

Managing Workflow: build-cookbook (cookbook) | delivery-truck (cookbook) | Manage Dependencies | Manage Secrets | Publish Cookbooks to Multiple Chef Servers | Runners | Workflow w/Bitbucket | Workflow w/Email (SMTP) | Workflow w/GitHub | Workflow w/Slack | Users and Roles | Authentication w/LDAP | Authentication w/SAML | Elastic Search and Kibana Auth | Delivery Server Backup | Delivery Server Disaster Recovery | Delivery Server Tuning

Reference: Delivery CLI | delivery.rb | delivery.rb Optional Settings | Workflow DSL

AWS OpsWorks for Chef Automate | Chef Automate for Microsoft Azure

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! | tag | tagged? | untag | value_for_platform | value_for_platform_family | Custom Resource DSL | Community Resources

Handlers

Custom Handlers | Handler DSL | Community Handlers

Knife Plugins

Cloud Plugins | Writing Custom Plugins | Community Plugins (knife)

Ohai Plugins

Custom Plugins | Community Plugins

Chef Infra Client Plugins

Chef Infra Client Plugins

Addenda

Available on GitHub | Get Chef | Send Feedback | Support | Site Map | Archive