Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
906 lines (808 sloc) 36.7 KB

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
  • 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

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 |

Deprecations

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

Microsoft Windows

Appendix: Env Variables | Troubleshooting | Glossary

Setup

Proxies | Chef DK 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

Air-gapped Installation | Microsoft Windows | Uninstall

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

Chef DK

About the 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 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

push-jobs-client (executable)

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

Habitat

Documentation: Habitat Documentation

Tutorials: Habitat Tutorials

InSpec

Documentation: InSpec Documentation

Tutorials: InSpec Tutorials

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

Community Resources

Handlers

Custom Handlers | Handler DSL | Community Handlers

Knife Plugins

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

Ohai Plugins

Custom Plugins | Community Plugins

Chef Client Plugins

Chef Client Plugins

Addenda

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

.. toctree::
   :hidden:

   about_chefdk
   api_chef_server
   api_compliance
   api_automate
   api_omnitruck
   api_push_jobs
   api_reporting
   attributes
   audit_cookbook
   auth
   automate_azure
   automate_compliance_scanner
   automate_compliance_reporting
   automate_compliance_profile_store
   automate_compliance_credentials
   automate_nodes
   automate_admin
   aws_marketplace
   aws_opsworks_chef_automate
   azure_portal
   backend_failure_recovery
   berkshelf
   chef_automate
   chef_automate_compliance
   chef_client_overview
   chef_client_security
   chef_deprecations_client
   chefdk_setup
   chef_license
   chef_overview
   chef_private_keys
   chef_quick_overview
   chef_repo
   chef_search
   chef_shell
   chef_solo
   chef_system_requirements
   chef_vault
   chefspec
   community
   community_contributions
   community_guidelines
   compliance_azure
   chef_compliance
   config_json_delivery
   config_rb
   config_rb_client
   config_rb_compliance
   config_rb_delivery
   config_rb_delivery_optional_settings
   config_rb_manage
   config_rb_metadata
   config_rb_metadata
   config_rb_optional_settings
   config_rb_policyfile
   config_rb_push_jobs_client
   config_rb_push_jobs_server
   config_rb_reporting
   config_rb_server
   config_rb_server_optional_settings
   config_rb_solo
   config_rb_supermarket
   config_yml_kitchen
   cookbook_repo
   cookbook_versioning
   cookbooks
   cookstyle
   ctl_chef
   ctl_chef_apply
   ctl_chef_backend
   ctl_chef_client
   ctl_chef_server
   ctl_chef_solo
   delivery_cli
   ctl_automate_server
   ctl_kitchen
   ctl_manage
   ctl_ohai
   ctl_opscode_expander
   ctl_push_jobs_client
   ctl_reporting
   ctl_supermarket
   custom_resources
   custom_resources_notes
   data_bags
   data_collection
   data_collection_ha
   data_collection_without_server
   scaling_capacity_planning_chef_automate
   stream_data_chef_automate
   data_retention_chef_automate
   debug
   definitions
   delivery_pipeline
   delivery_build_cookbook
   delivery_manage_dependencies
   delivery_manage_secrets
   delivery_server_backup
   delivery_server_disaster_recovery
   delivery_server_tuning
   delivery_truck
   delivery_users_and_roles
   deprecations_attributes
   deprecations_chef_gem_compile_time
   deprecations_chef_platform_methods
   deprecations_chef_rest
   deprecations_chocolatey_uninstall
   deprecations_custom_resource_cleanups
   deprecations_deploy_resource
   deprecations_dnf_package_allow_downgrade
   deprecations_easy_install
   deprecations_exit_code
   deprecations_internal_api
   deprecations_json_auto_inflate
   deprecations_launchd_hash_property
   deprecations_local_listen
   deprecations_namespace_collisions
   deprecations_ohai_amazon_linux
   deprecations_ohai_cloud
   deprecations_ohai_cloud_v2
   deprecations_ohai_digitalocean
   deprecations_ohai_filesystem
   deprecations_ohai_filesystem_v2
   deprecations_ohai_legacy_config
   deprecations_ohai_libvirt_plugin
   deprecations_ohai_run_command_helpers
   deprecations_ohai_sigar_plugins
   deprecations_ohai_v6_plugins
   deprecations_ohai_windows_cpu
   deprecations_ohai_ipscopes
   deprecations_property_name_collision
   deprecations_resource_cloning
   deprecations_run_command
   deprecations_shell_out
   deprecations_supports_property
   deprecations_verify_file
   dk_windows
   dsl_audit
   dsl_custom_resource
   dsl_delivery
   dsl_handler
   dsl_recipe
   elasticsearch_and_kibana_auth
   environment_variables
   environments
   errors
   error_messages
   feedback
   files
   filter_compliance_scan
   fips
   foodcritic
   glossary
   google
   handlers
   install_chef_automate
   install_bootstrap
   install_chef_air_gap
   install_chef_compliance
   install_dk
   install_omnibus
   install_push_jobs
   install_reporting
   install_server
   install_server_ha
   install_server_ha_aws
   install_server_ha_drbd
   install_server_post
   install_server_pre
   install_server_tiered
   install_supermarket
   install_windows
   integrate_chef_automate_saml
   integrate_compliance_chef_server
   integrate_compliance_server_chef_automate
   integrate_delivery_bitbucket
   integrate_delivery_github
   integrate_delivery_ldap
   integrate_delivery_slack
   integrate_delivery_smtp
   integrate_node_notifications_slack
   integrate_node_notifications_webhook
   junos
   kitchen
   knife
   knife_options
   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_setup
   knife_xargs
   libraries
   manage
   nodes
   ohai
   ohai_custom
   packages
   page_not_found
   perform_compliance_scan
   platform_overview
   platforms
   plugin_community
   plugin_kitchen_vagrant
   plugin_knife
   plugin_knife_custom
   plugin_knife_opc
   plugin_knife_push_jobs
   plugin_knife_reporting
   plugin_knife_spork
   plugin_knife_windows
   policy
   policyfile
   profile_store
   proxies
   provisioning
   provisioning_aws
   provisioning_fog
   provisioning_vagrant
   publish_cookbooks_multiple_servers
   push_jobs
   quick_start
   recipes
   reporting
   release_notes
   release_notes_chef_automate
   release_notes_chefdk
   release_notes_server
   release_notes_push_jobs
   resource
   resource_apt_package
   resource_apt_preference
   resource_apt_repository
   resource_apt_update
   resource_bash
   resource_batch
   resource_bff_package
   resource_breakpoint
   resource_build_essential
   resource_cab_package
   resource_chef_acl
   resource_chef_client
   resource_chef_container
   resource_chef_data_bag
   resource_chef_data_bag_item
   resource_chef_environment
   resource_chef_gem
   resource_chef_group
   resource_chef_handler
   resource_chef_mirror
   resource_chef_node
   resource_chef_organization
   resource_chef_role
   resource_chef_user
   resource_chocolatey_package
   resource_common
   resource_cookbook_file
   resource_cron
   resource_csh
   resource_deploy
   resource_directory
   resource_dmg_package
   resource_dnf_package
   resource_dpkg_package
   resource_dsc_resource
   resource_dsc_script
   resource_erlang_call
   resource_examples
   resource_execute
   resource_file
   resource_freebsd_package
   resource_gem_package
   resource_git
   resource_group
   resource_homebrew_cask
   resource_homebrew_package
   resource_homebrew_tap
   resource_hostname
   resource_http_request
   resource_ifconfig
   resource_ips_package
   resource_ksh
   resource_launchd
   resource_link
   resource_load_balancer
   resource_log
   resource_machine
   resource_machine_batch
   resource_machine_execute
   resource_machine_file
   resource_machine_image
   resource_macos_userdefaults
   resource_macports_package
   resource_mdadm
   resource_mount
   resource_msu_package
   resource_ohai
   resource_ohai_hint
   resource_openbsd_package
   resource_openssl_dhparam
   resource_openssl_ec_private_key
   resource_openssl_ec_public_key
   resource_openssl_rsa_private_key
   resource_openssl_rsa_public_key
   resource_openssl_x509_certificate
   resource_openssl_x509_crl
   resource_openssl_x509_request
   resource_osx_profile
   resource_package
   resource_pacman_package
   resource_paludis_package
   resource_perl
   resource_portage_package
   resource_powershell_package
   resource_powershell_script
   resource_private_key
   resource_public_key
   resource_python
   resource_reboot
   resource_registry_key
   resource_remote_directory
   resource_remote_file
   resource_rhsm_errata
   resource_rhsm_errata_level
   resource_rhsm_register
   resource_rhsm_repo
   resource_rhsm_subscription
   resource_route
   resource_rpm_package
   resource_ruby
   resource_ruby_block
   resource_script
   resource_service
   resource_smartos_package
   resource_solaris_package
   resource_subversion
   resource_sudo
   resource_swap_file
   resource_sysctl
   resource_systemd_unit
   resource_template
   resource_user
   resource_windows_ad_join
   resource_windows_auto_run
   resource_windows_env
   resource_windows_feature
   resource_windows_feature_dism
   resource_windows_feature_powershell
   resource_windows_font
   resource_windows_package
   resource_windows_path
   resource_windows_printer
   resource_windows_printer_port
   resource_windows_service
   resource_windows_shortcut
   resource_windows_task
   resource_yum_package
   resource_yum_repository
   resource_zypper_package
   resource_zypper_repository
   resource_reference
   roles
   ruby
   run_lists
   runners
   runbook
   search_query_chef_automate
   secrets
   server_backup_restore
   server_components
   server_configure_saml
   server_data
   server_firewalls_and_ports
   server_high_availability
   server_ldap
   server_logs
   server_manage_clients
   server_manage_cookbooks
   server_manage_data_bags
   server_manage_environments
   server_manage_nodes
   server_manage_reports
   server_manage_roles
   server_monitor
   server_orgs
   server_replication
   server_security
   server_sent_events
   server_services
   server_tuning
   server_users
   setup_build_node
   style_guide
   supermarket
   supermarket_api
   supermarket_backup_restore
   supermarket_logs
   supermarket_monitor
   supermarket_share_cookbook
   templates
   troubleshooting_chef_automate
   uninstall
   upgrade_chef_automate
   upgrade_client
   upgrade_client_notes
   upgrade_compliance
   upgrade_server
   upgrade_server_ha_v2
   upgrade_server_notes
   upgrade_server_open_source_notes
   visibility
   vmware
   windows
   workflow
   actions
   analytics
   analytics_monitor
   analytics_nodes_view
   analytics_rules
   analytics_splunk
   analytics_webui_tasks
   api_analytics
   chef_client_analytics
   config_rb_analytics
   ctl_analytics
   dsl_recipe_analytics
   install_analytics
   install_reporting
   install_server_pre
   plugin_knife_analytics
   release_notes_analytics
   upgrade_analytics