Chef Documentation

Commands

• Chef Infra Client
• automate-ctl
• chef
• chef-apply
• chef-backend-ctl
• chef-manage-ctl
• chef-server-ctl
• chef-shell
• chef-solo
• chef-solo
• chef-vault
• kitchen
• kitchen-vagrant
• 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 opc
• knife push jobs
• 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-spork
• ohai
• opscode-expander-ctl
• push-jobs-client
• supermarket-ctl

Guides

• AWS Marketplace
• AWS OpsWorks for Chef Automate
• About Attributes
• About Berkshelf
• About Chef Automate Pipelines
• About Chef Licenses
• About ChefDK
• About Cookbook Versioning
• About Cookbooks
• About Data Bags
• About Environments
• About Files
• About Foodcritic
• About Handlers
• About Knife
• About Libraries
• About Nodes
• About Ohai
• About Policy
• About Policyfile
• About Recipes
• About Resources
• About Roles
• About Run-lists
• About Search
• About Templates
• About the Chef Community
• About the Custom Resource DSL
• About the Handler DSL
• About the Recipe DSL
• About the Workflow DSL
• About the build-cookbook
• About the chef-repo
• About the delivery-truck Cookbook
• Accepting the Chef License
• Active Directory and LDAP
• An Overview of Chef Infra
• An Overview of Workflow in Chef Automate
• Authentication
• Backup and Restore a Standalone or Frontend install
• Bootstrap a Node
• Chef Automate Backups
• Chef Automate Disaster Recovery
• Chef Automate Server Tuning
• Chef Automate for Microsoft Azure
• Chef Backend Failure Recovery
• Chef Contributor Covenant Code of Conduct
• Chef Deprecation Warnings
• Chef Infra Client Overview
• Chef Infra Client Security
• Chef Infra Server API
• Chef Infra Server Overview
• Chef Infra Server Prerequisites
• Chef Manage
• Chef Push Jobs
• Chef Software Inc Packages
• Chef Supermarket
• Chef Workstation in Azure Cloud Shell
• Chef and Google
• Chef and VMware
• Chef for Junos OS
• Chef for Microsoft Windows
• ChefSpec
• Common Functionality
• Community Contributions
• Community Plugins
• Configure Data Collection
• Configuring ChefDK
• Configuring for SAML Authentication
• Converting Definitions to Custom Resources
• Cookbook Directory
• Cookstyle
• Custom Resources
• Custom Resources Notes
• Data Collection with a Chef Backend Cluster
• Data Collection without Chef Infra Server
• Debug Recipes, Chef Infra Client Runs
• Delivery CLI
• Deprecation: :uninstall Resource for chocolatey_package (CHEF-21)
• Deprecation: Amazon linux moved to the Amazon platform_family (OHAI-7)
• Deprecation: Chef Gem Compile Time (CHEF-3)
• Deprecation: Chef REST (CHEF-9)
• Deprecation: Chef::Platform methods (CHEF-13)
• Deprecation: Cloud plugin replaced by the Cloud_V2 plugin (OHAI-8)
• Deprecation: Cloud_v2 attribute removal (OHAI-11)
• Deprecation: Custom Resource Cleanups (CHEF-5)
• Deprecation: DNF Package allow_downgrade Property (CHEF-10)
• Deprecation: Deploy Resource (CHEF-20)
• Deprecation: Deprecation of lc_all from locale resource (CHEF-27)
• Deprecation: Deprecation of old shell_out APIs (CHEF-26)
• Deprecation: Deprecation of run_command (CHEF-14)
• Deprecation: Deprecation of the erl_call resource (CHEF-22)
• Deprecation: DigitalOcean plugin attribute changes (OHAI-6)
• Deprecation: Easy Install Resource (CHEF-6)
• Deprecation: Filesystem plugin replaced by the Filesystem V2 plugin. (OHAI-9)
• Deprecation: Filesystem2 attribute removal (OHAI-12)
• Deprecation: Internal API Changes (CHEF-0)
• Deprecation: JSON Auto Inflate (CHEF-1)
• Deprecation: Launchd hash Property (CHEF-12)
• Deprecation: Legacy HWRP mixins (CHEF-23)
• Deprecation: Libvirt plugin attributes changes (OHAI-4)
• Deprecation: Local Mode Listen (CHEF-18)
• Deprecation: Map Collision (CHEF-25)
• Deprecation: Ohai::Config removal (OHAI-1)
• Deprecation: Old Exit Codes (CHEF-2)
• Deprecation: Removal of IpScopes Plugin (OHAI-13)
• Deprecation: Removal of support for Ohai version 6 plugins (OHAI-10)
• Deprecation: Resource Cloning (CHEF-3694)
• Deprecation: Resource Property Name Collision (CHEF-11)
• Deprecation: Sigar gem based plugins removal (OHAI-2)
• Deprecation: Some Attribute Methods (CHEF-4)
• Deprecation: System Profile plugin (OHAI-14)
• Deprecation: Use of property_name inside of actions (CHEF-19)
• Deprecation: Verify File Expansion (CHEF-7)
• Deprecation: Windows CPU plugin attribute changes. (OHAI-5)
• Deprecation: epic_fail (CHEF-24)
• Deprecation: run_command and popen4 helper method removal (OHAI-3)
• Deprecation: “Supports” metaproperty (CHEF-8)
• Documentation Style Guide
• FIPS (Federal Information Processing Standards)
• Firewalls and Ports
• Glossary
• High Availability: Chef Backend
• High Availability: Upgrade to Chef Backend 2
• Install Chef Infra Client on Windows Nodes
• Install Chef Push Jobs
• Install Chef in an air-gapped environment
• Install ChefDK
• Install Private Supermarket
• Install the Chef Infra Server
• Install via Install Script
• Installing Chef on Windows
• Integrate Workflow with Bitbucket
• Integrate Workflow with GitHub
• Integrate Workflow with SMTP
• Integrate Workflow with Slack
• Integrate with LDAP for Authentication
• Knife Azure
• Knife Azurerm
• Knife Cloud Plugins
• Knife Common Options
• Knife Windows
• Log Files
• Manage Client Keys
• Manage Cookbooks
• Manage Data Bags
• Manage Environments
• Manage Nodes
• Manage Roles
• Manage Secrets
• Manage Secrets in a build-cookbook
• Manage Users and Roles
• Managing Run-time Dependencies
• Microsoft Azure CLI
• Microsoft Azure Portal
• Microsoft Azure PowerShell
• Monitor
• Monitor Supermarket
• Omnitruck API
• Organizations and Groups
• Platform Overview
• Platforms
• Publish Cookbooks to Multiple Chef Infra Servers
• Push Jobs API
• Push Jobs Server Sent Events Feed
• Quick Start
• Release Notes: Chef Infra Client 12.0 - 15.7
• Release Notes: Chef Infra Server 12.0 - 13.0.11
• Release Notes: Chef Push Jobs 1.0 - 2.5
• Release Notes: ChefDK 0.19 - 4.6
• Resources Reference
• Ruby Guide
• Runbook
• Runners
• Search the Chef Documentation
• Security
• Send Feedback
• Sending Compliance Data to Chef Automate with Audit Cookbook
• Server Tuning
• Services
• Setting up Knife
• Share Cookbooks on the Chef Supermarket
• Site Map
• Site Map
• Supermarket API
• Supermarket Backup and Restore
• Supermarket Logs
• Supported Versions
• System Requirements
• Test Kitchen
• Tiered Installation
• Troubleshooting
• Uninstall
• Unix Environment Variables
• Upgrade to Chef Server 12
• Upgrading Chef Infra Client
• Users
• Working with Proxies
• Writing Custom Knife Plugins
• Writing Ohai Custom Plugins

Methods

• :filter_result
• attribute?
• cookbook_name
• data_bag
• data_bag_item
• declare_resource
• delete_resource
• delete_resource!
• edit_resource
• edit_resource!
• find_resource
• find_resource!
• 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
• with_run_context

Resources

• 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_access
• cron_d
• csh
• deploy
• directory
• dmg_package
• dnf_package
• dpkg_package
• dsc_resource
• dsc_script
• 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
• load_balancer
• locale
• log
• machine
• machine_batch
• machine_execute
• machine_file
• machine_image
• 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
• private_key
• public_key
• 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

Settings

• Configure a Project through config.json
• Policyfile.rb
• chef-server.rb Optional Settings
• chef-server.rb Settings
• client.rb
• config.rb
• config.rb Optional Settings
• delivery.rb Optional Settings
• delivery.rb Settings
• kitchen.yml
• manage.rb
• metadata.rb
• opscode-push-jobs-server.rb
• push-jobs-client.rb
• solo.rb
• supermarket.rb Settings