Skip to main content

Site Map

This is a site map for the following 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.

Overview

Platform Overview

Licensing

About Licensing | Accept License | Add License Key | Terms

Chef Local License Service : Overview | Install | Backup and Restore | API

Enterprise Chef

Enterprise vs Community Edition | Enterprise Edition

Community

About the Community | Community Contributions | Guidelines | Send Feedback

Packages & Platforms

Packages | Supported versions | Supported platforms | Install script

Download : Overview | Commercial API | Community API

Style Guide

Docs Style | Contribute | Chef House Style | Product names | Terms | Tools

Formatting : Linking | Lists | Markdown | Notices | Headings | Tables | Procedures

Hugo : Content Reuse | Page Front Matter | Shortcodes

Chef 360 Platform

version 1.1 | version 1.0

Chef Automate

Overview

Getting Started

Get Started Tutorial | System Requirements

Install

Install Guide | Install Airgapped | Install Habitat Builder On-prem | Install Chef Infra Server | Supermarket Integration | License

High Availability

Overview

Prerequisites : On-Premises Prerequisites | AWS Deployment Prerequisites

Deployment : On-Prem Deployment with Chef Managed Database | On-Premises Deployment with AWS Managed Database | On-Prem Deployment with Customer Managed Database | AWS Deployment with Chef Managed Database | AWS Deployment with AWS Managed Database

Backup and Restore : Overview | On-Prem Deployment using Filesystem | On-Prem Back Up With Object Storage | AWS Deployment using EFS | AWS Deployment using S3

| Upgrade | Integrations

Migration : Existing A2HA to Automate HA | In-Place A2HA to Automate HA | Chef Infra Server/Chef Backend to Automate HA | Automate to Automate HA

| Supermarket with Automate HA

Manage HA Cluster : Add Nodes to the Deployment | Remove Single Node from Cluster | Automate Config Generation | Config Verify | Automate HA Commands | Node Bootstrapping

Configuration : Overview | HA OpenSearch Node Config | HA PostgreSQL Node Config

Disaster Recovery : Disaster Recovery On-Prem | Disaster Recovery for AWS Deployment

Certificates : View Certificates | Add Custom Certificate During Deployment | Self Sign Certificates | Certificate Rotation

| Performance Benchmarks | FAQs | Troubleshooting

Reference : Loadbalancer Configuration | Create Amazon OpenSearch | VPC and CIDR Setup | Create Amazon RDS | Sudo Password | IAM Users | Migrate Bastion to New Machine | AWS Certificate Manager | Reference Topics

Configure

Overview | Data Collection | Disclosure Panel and Banner | Session Timeout | Telemetry | Invalid Login Attempts | Large Compliance Report Ingestion | Chef Infra Configuration In Chef Automate | Chef Infra External Cookbooks In Chef Automate

Manage

Backup | Log Management | Centralize Logs | Migrate | Monitoring | Restore | Managed Services

Elasticsearch : Configure Elasticsearch | Upgrade to OpenSearch

OpenSearch : Configure OpenSearch

PostgreSQL : Configure PostgreSQL | Upgrade External PostgreSQL

Settings

Notifications | Data Feeds | Data Lifecycle | Node Integrations | Node Credentials | Projects | User Profile

Users

Authentication : LDAP | SAML

Authorization : IAM Overview | IAM Users Guide | IAM Actions

| API Tokens | Policies | Roles | Teams | Users | Event Feed

Applications

Chef EAS | Setting up the Applications Dashboard | Applications Dashboard | Desktop Dashboard | Troubleshooting

Compliance

Reports | Scan Jobs | Profiles | Nodes

Infrastructure

Client Runs | Chef Infra Server

Integrations

ServiceNow : Integration App | Incident App | Administrator Reference

Reference

Architecture | Chef Automate API | Automate CLI | Feature Flags | Security Best Practices

Upgrade

Upgrade | Upgrade to 3.x | Upgrade to 4.x | Update Non-SAN Certificates for 4.7.52 Version

Chef Desktop

About Chef Desktop

Getting Started

Requirements | Infrastructure Overview

Install

Quick Start guide | Install Workstation | Automate Server | Cookbook Setup | Set up Policy | Set up Nodes

Zero Touch Deployment

macOS : Enrollment | Application Management

Windows : Enrollment | Application Management

| Chef Desktop Cookbook Reference

Resources

All Resources (Single Page) | macos_admin_control | macos_app_management | macos_automatic_logout | macos_automatic_software_updates | macos_desktop_screensaver | macos_disk_encryption | macos_firewall | macos_password_policy | macos_power_management | rescue_account | windows_admin_control | windows_app_management | windows_automatic_logout | windows_choco_installer | windows_defender | windows_defender_exclusion | windows_desktop_screensaver | windows_desktop_winrm_settings | windows_disk_encryption | windows_firewall | windows_ie_esc | windows_password_policy | windows_power_management | windows_update_settings

Chef Habitat

Overview | Get Started

Install Habitat

Get Chef Habitat | Set up the Chef Habitat CLI | Download and Install FAQ

Builder

Chef Habitat Builder | Create an Account | Builder Profile | Origins | Origin Packages

Origins

Create an Origin | Origin Keys | Origin Membership & RBAC | Origin Settings

Packages

Building Packages | Promoting Packages | Exporting Packages | Continuous Integration | Runtime Binds

Plans

Plan Writing | Plan Quickstart | Plan Contents | Scaffolding | Binary Wrapper Packages

Services

About Services | Service Groups | Service Group Topologies | Service Group Configuration | Single Service Updates | Service Group Updates | Monitoring Services

Supervisors

About Supervisors | Running Supervisors | Running Chef Habitat on Servers (Linux and Windows) | Supervisor Design | Leader Elections | Setting Up a Ring | Supervisor Networks | Supervisor Cryptography | Securing Networks | Supervisor Configuration File | Supervisor Log Configuration | Supervisor Package Configuration | Launcher | Remote Control | Updating Supervisors | Habitat Studio

Reference

Habitat CLI Reference

API : Builder API | Supervisor API

| Application Lifecycle Hooks | Build Helpers | Build Phase Callbacks | Plan Configuration Helpers | Configuration Management | Configuration Templates | Custom Certificates | Environment Variables | Keys | Package Contents | Package Identifiers | Pattern Library | Plan Settings | Plan Variables | Service Restarts | Service Template Data | Supervisor Log Codes

Containers

Chef Habitat and Containers | Container Orchestration | Kubernetes | Azure Container Services (AKS) | Amazon Container Services (ECS) | Google Container Registry (GCR) | Apache Mesos and DC/OS | Running Chef Habitat Linux Containers | Running Chef Habitat Windows Containers

Diagrams

Architecture Overview | Initial Package Build Flow | Dependency Update Flow | Application Rebuild Flow | Docker Container Publishing Flow | Automated Docker Container Publishing Flow | Promote Packages Through Channels | Runtime Services Group Binding | Chef Habitat Builder Architecture | Chef Habitat Builder on-prem Flow

Chef Infra

Overview

Chef Infra Overview | Chef Infra Client Overview | Nodes | Quick Start

Install

System Requirements | Install using Bootstrap | Working with Proxies | client.rb | Air-gapped Installation | Upgrade | Uninstall

Features

Chef Solo : About Chef Solo | chef-solo (executable) | solo.rb

| Compliance Phase

Ohai : About Ohai | ohai (executable)

| Handlers | Search | Target Mode

Policy

About Policy | About Policyfiles | Policyfile.rb | Data Bags | Run-lists | Environments | Roles

Integrations

AWS Marketplace | Google Cloud Platform | VMware | Chef and Terraform

Microsoft Azure : Azure Marketplace | Azure Test Drive | Chef Workstation in Azure Cloud Shell | Microsoft Azure PowerShell | Microsoft Azure Chef Extension

Windows : Chef for Windows | Windows Installation Guide

Security

Chef Infra Client Security | FIPS

Reference

chef-client (executable) | chef-solo (executable) | Handler DSL | ohai (executable) | supermarket-ctl | client.rb | metadata.rb | Policyfile.rb | Deprecations | solo.rb | Glossary | Troubleshooting

Cookbook Reference

About Cookbooks | About chef-repo | Cookbook Directory

Attributes : Attributes | Attributes Arrays | Attribute Persistence | Attribute Precedence | Attribute Sources | Attribute Types

| Files | Libraries | metadata.rb

Recipes : About Recipes | Debug Recipes, Client Runs

| Templates | Versioning Cookbooks

Chef Infra Language

Language Overview | Checking Architectures | Checking Clouds | Checking Hypervisors | Checking Platforms | Cookbook Execution | Editing Resources | Logging | Node Tags | Reading Data Bags | Reading Registry Keys | Search | Secrets Management Integrations | Shelling Out | Windows | Ruby Guide

Chef Infra Resources

About Resources | Unified Mode | Target Mode | Common Resource Functionality | All Resources (Single Page)

Custom Resources : Custom resource guide | Accumulators | Helpers | Partials | Migrating from Definitions | Migration Notes | Migrating from LWRPs | Glossary

| alternatives | apt_package | apt_preference | apt_repository | apt_update | archive_file | bash | batch | bff_package | breakpoint | build_essential | cab_package | chef_acl | chef_client | chef_client_config | chef_client_cron | chef_client_launchd | chef_client_scheduled_task | chef_client_systemd_timer | chef_client_trusted_certificate | chef_container | chef_data_bag | chef_data_bag_item | chef_environment | chef_gem | chef_group | chef_handler | chef_node | chef_organization | chef_role | chef_sleep | chef_user | chef_vault_secret | chocolatey_config | chocolatey_feature | chocolatey_installer | chocolatey_package | chocolatey_source | cookbook_file | cron | cron_access | cron_d | csh | directory | dmg_package | dnf_package | dpkg_package | dsc_resource | dsc_script | execute | file | freebsd_package | gem_package | git | group | habitat_config | habitat_install | habitat_package | habitat_service | habitat_sup | habitat_user_toml | homebrew_cask | homebrew_package | homebrew_tap | homebrew_update | hostname | http_request | ifconfig | inspec_input | inspec_waiver | inspec_waiver_file_entry | ips_package | kernel_module | ksh | launchd | link | locale | log | macos_userdefaults | macosx_service | macports_package | mdadm | mount | msu_package | notify_group | 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 | plist | 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 | selinux_boolean | selinux_fcontext | selinux_install | selinux_login | selinux_module | selinux_permissive | selinux_port | selinux_state | selinux_user | service | smartos_package | snap_package | solaris_package | ssh_known_hosts_entry | subversion | sudo | swap_file | sysctl | systemd_unit | template | timezone | user | user_ulimit | windows_ad_join | windows_audit_policy | windows_auto_run | windows_certificate | windows_defender | windows_defender_exclusion | 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_profile | windows_firewall_rule | windows_font | windows_package | windows_pagefile | windows_path | windows_printer | windows_printer_port | windows_security_policy | windows_service | windows_share | windows_shortcut | windows_task | windows_uac | windows_update_settings | windows_user_privilege | windows_workgroup | yum_package | yum_repository | zypper_package | zypper_repository

Extension APIs

Handlers : Custom Handlers | Handler DSL | Community Handlers

| Compliance DSL

Ohai Plugins : Custom Plugins | Community Plugins

Chef Infra Server

Overview

Infra Server Overview | Services

Plan

Chef Infra Server Prerequisites | Capacity Planning

Install

Install Chef Infra Server | Install High Availability | Airgap | Tiered Installation | Upgrades | Upgrade HA Cluster | License Usage

Configure

chef-server.rb Settings | Chef Infra Server Optional Settings | chef-backend.rb Settings | Server Firewalls and Ports | Security

Manage

Backup and Restore | Backend Failure Recovery | Monitor | Tuning | Log Files

Users

Authentication and Authorization | Organizations & Groups | Server Users

Reference

chef-server-ctl | chef-backend-ctl | Chef Infra Server API | Firewalls & Ports

Chef InSpec

Chef InSpec Overview

Install

Platforms | Install | License | Uninstall | Configure

Profiles

About Profiles | inspec.yml | Controls | Custom Resources | Dependencies | Files | Inputs | Platforms | Profile Style Guide | Signed Profiles

Cloud Platforms

Overview | AliCloud | AWS | Azure | GCP | Audit Log | InSpec Shell | Parallel | Plugins | Reporters | Waivers | Troubleshooting

Chef Tools

kitchen-inspec | Chef Habitat Integration

RSpec and Serverspec | Migration from Serverspec

Chef InSpec Reference

InSpec Executable | Matchers | Chef InSpec Glossary

Chef InSpec Resources

InSpec Resources (Single Page)

OS Resources : aide_conf | apache | apache_conf | apt | audit_policy | auditd | auditd_conf | bash | bond | bridge | bsd_service | cassandradb_conf | cassandradb_session | cgroup | chocolatey_package | chrony_conf | command | cpan | cran | cron | crontab | csv | default_gateway | dh_params | directory | docker | docker_container | docker_image | docker_plugin | docker_service | elasticsearch | etc_fstab | etc_group | etc_hosts | etc_hosts_allow | etc_hosts_deny | file | filesystem | firewalld | gem | group | groups | grub_conf | host | http | ibmdb2_conf | ibmdb2_session | iis_app | iis_site | inetd_conf | ini | interface | interfaces | ip6tables | ipfilter | ipnat | iptables | json | kernel_module | kernel_parameter | kernel_parameters | key_rsa | launchd_service | limits_conf | linux_audit_system | login_defs | lxc | mail_alias | mongodb_conf | mongodb_session | mount | mssql_session | mssql_sys_conf | mysql_conf | mysql_session | nftables | nginx | nginx_conf | npm | ntp_conf | oneget | opa_api | opa_cli | oracledb_conf | oracledb_listener_conf | oracledb_session | os | os_env | package | packages | parse_config | parse_config_file | passwd | php_config | pip | podman | podman_container | podman_image | podman_network | podman_pod | podman_volume | port | postfix_conf | postgres_conf | postgres_hba_conf | postgres_ident_conf | postgres_session | powershell | ppa | processes | rabbitmq_config | registry_key | routing_table | runit_service | security_identifier | security_policy | selinux | service | shadow | ssh_config | ssh_key | sshd_active_config | sshd_config | ssl | sybase_conf | sybase_session | sys_info | systemd_service | sysv_service | timezone | toml | upstart_service | user | users | vbscript | virtualization | windows_feature | windows_firewall | windows_firewall_rule | windows_hotfix | windows_task | wmi | x509_certificate | x509_private_key | xinetd_conf | xml | yaml | yum | zfs | zfs_dataset | zfs_pool

Alibaba Resources : alicloud_apsaradb_rds_instance | alicloud_apsaradb_rds_instances | alicloud_disk | alicloud_disks | alicloud_ecs_instance | alicloud_ecs_instances | alicloud_disk | alicloud_ram_policies | alicloud_ram_policy | alicloud_ram_user | alicloud_ram_user_mfa | alicloud_ram_users

AWS Resources : aws_alb | aws_albs | aws_ami | aws_amis | aws_amplify_app | aws_amplify_apps | aws_amplify_branch | aws_amplify_branches | aws_api_gateway_deployment | aws_api_gateway_deployments | aws_api_gateway_documentation_part | aws_api_gateway_documentation_parts | aws_api_gateway_documentation_version | aws_api_gateway_documentation_versions | aws_api_gateway_domain_name | aws_api_gateway_domain_names | aws_api_gateway_method | aws_api_gateway_methods | aws_api_gateway_model | aws_api_gateway_models | aws_api_gateway_request_validator | aws_api_gateway_request_validators | aws_api_gateway_resource | aws_api_gateway_resources | aws_api_gateway_response | aws_api_gateway_responses | aws_api_gateway_restapi | aws_api_gateway_restapis | aws_api_gateway_stage | aws_api_gateway_stages | aws_api_gateway_usage_plan | aws_api_gateway_usage_plan_key | aws_api_gateway_usage_plan_keys | aws_api_gateway_usage_plans | aws_api_gateway_v2_api | aws_api_gateway_v2_api_mapping | aws_api_gateway_v2_api_mappings | aws_api_gateway_v2_apis | aws_api_gateway_v2_authorizer | aws_api_gateway_v2_authorizers | aws_api_gateway_v2_deployment | aws_api_gateway_v2_deployments | aws_api_gateway_v2_domain_name | aws_api_gateway_v2_domain_names | aws_api_gateway_v2_integration | aws_api_gateway_v2_integration_response | aws_api_gateway_v2_integration_responses | aws_api_gateway_v2_integrations | aws_api_gateway_v2_model | aws_api_gateway_v2_models | aws_api_gateway_v2_route | aws_api_gateway_v2_routes | aws_api_gateway_vpc_link | aws_api_gateway_vpc_links | aws_apigateway_account | aws_apigateway_api_key | aws_apigateway_api_keys | aws_apigateway_authorizer | aws_apigateway_authorizers | aws_apigateway_base_path_mapping | aws_apigateway_base_path_mappings | aws_apigateway_client_certificate | aws_apigateway_client_certificates | aws_application_autoscaling_scalable_target | aws_application_autoscaling_scalable_targets | aws_application_autoscaling_scaling_policies | aws_application_autoscaling_scaling_policy | aws_athena_work_group | aws_athena_work_groups | aws_auto_scaling_group | aws_auto_scaling_groups | aws_autoscaling_scaling_policies | aws_autoscaling_scaling_policy | aws_batch_compute_environment | aws_batch_compute_environments | aws_batch_job_definition | aws_batch_job_definitions | aws_batch_job_queue | aws_batch_job_queues | aws_cloud_formation_stack_set | aws_cloud_formation_stack_sets | aws_cloudformation_stack | aws_cloudformation_stacks | aws_cloudformation_template | aws_cloudfront_cache_policies | aws_cloudfront_cache_policy | aws_cloudfront_distribution | aws_cloudfront_distributions | aws_cloudfront_key_group | aws_cloudfront_key_groups | aws_cloudfront_origin_access_identities | aws_cloudfront_origin_access_identity | aws_cloudfront_origin_request_policy | aws_cloudfront_public_key | aws_cloudfront_public_keys | aws_cloudfront_realtime_log_config | aws_cloudfront_realtime_log_configs | aws_cloudfront_streaming_distribution | aws_cloudfront_streaming_distributions | aws_cloudtrail_trail | aws_cloudtrail_trails | aws_cloudwatch_alarm | aws_cloudwatch_anomaly_detector | aws_cloudwatch_anomaly_detectors | aws_cloudwatch_composite_alarm | aws_cloudwatch_composite_alarms | aws_cloudwatch_dashboard | aws_cloudwatch_dashboards | aws_cloudwatch_insight_rules | aws_cloudwatch_log_group | aws_cloudwatch_log_metric_filter | aws_cloudwatch_metric_stream | aws_cloudwatch_metric_streams | aws_cloudwatchlogs_destination | aws_cloudwatchlogs_destinations | aws_cloudwatchlogs_log_stream | aws_cloudwatchlogs_log_streams | aws_cloudwatchlogs_subscription_filter | aws_cloudwatchlogs_subscription_filters | aws_cognito_identity_pool | aws_cognito_identity_pools | aws_cognito_userpool | aws_cognito_userpool_client | aws_cognito_userpool_clients | aws_cognito_userpools | aws_config_delivery_channel | aws_config_recorder | aws_db_parameter_group | aws_db_parameter_groups | aws_db_subnet_group | aws_db_subnet_groups | aws_dhcp_options | aws_dms_endpoint | aws_dms_endpoints | aws_dms_replication_instance | aws_dms_replication_instances | aws_dms_replication_subnet_group | aws_dms_replication_subnet_groups | aws_dynamodb_table | aws_dynamodb_tables | aws_ebs_snapshot | aws_ebs_snapshots | aws_ebs_volume | aws_ebs_volumes | aws_ec2_capacity_reservation | aws_ec2_capacity_reservations | aws_ec2_carrier_gateway | aws_ec2_carrier_gateways | aws_ec2_client_vpn_authorization_rule | aws_ec2_client_vpn_authorization_rules | aws_ec2_client_vpn_endpoint | aws_ec2_client_vpn_endpoints | aws_ec2_client_vpn_route | aws_ec2_client_vpn_routes | aws_ec2_client_vpn_target_network_association | aws_ec2_client_vpn_target_network_associations | aws_ec2_customer_gateway | aws_ec2_customer_gateways | aws_ec2_dhcp_option | aws_ec2_dhcp_options | aws_ec2_egress_only_internet_gateway | aws_ec2_egress_only_internet_gateways | aws_ec2_eip | aws_ec2_eip_association | aws_ec2_eip_associations | aws_ec2_eips | aws_ec2_fleet | aws_ec2_fleets | aws_ec2_host | aws_ec2_hosts | aws_ec2_instance | aws_ec2_instances | aws_ec2_internet_gateway | aws_ec2_internet_gateways | aws_ec2_launch_template | aws_ec2_launch_templates | aws_ec2_network_insights_analysis | aws_ec2_network_insights_analysis_plural | aws_ec2_network_insights_path | aws_ec2_network_insights_paths | aws_ec2_network_interface | aws_ec2_network_interface_attachment | aws_ec2_network_interface_attachments | aws_ec2_network_interface_permission | aws_ec2_network_interface_permissions | aws_ec2_network_interfaces | aws_ec2_placement_group | aws_ec2_placement_groups | aws_ec2_prefix_list | aws_ec2_prefix_lists | aws_ec2_spot_fleet | aws_ec2_spot_fleets | aws_ec2_traffic_mirror_filter | aws_ec2_traffic_mirror_filters | aws_ec2_traffic_mirror_session | aws_ec2_traffic_mirror_sessions | aws_ec2_transit_gateway_attachment | aws_ec2_transit_gateway_attachments | aws_ec2_transit_gateway_route_table | aws_ec2_transit_gateway_route_table_association | aws_ec2_transit_gateway_route_table_associations | aws_ec2_transit_gateway_route_table_propagation | aws_ec2_transit_gateway_route_table_propagations | aws_ec2_transit_gateway_route_tables | aws_ec2_volume_attachment | aws_ec2_volume_attachments | aws_ec2_vpc_peering_connection | aws_ec2_vpc_peering_connections | aws_ec2_vpn_connection_routes | aws_ec2_vpn_gateway_route_propagation | aws_ec2_vpn_gateway_route_propagations | aws_ecr | aws_ecr_image | aws_ecr_images | aws_ecr_repositories | aws_ecr_repository | aws_ecr_repository_policy | aws_ecrpublic_repositories | aws_ecrpublic_repository | aws_ecs_cluster | aws_ecs_clusters | aws_ecs_service | aws_ecs_services | aws_ecs_task_definition | aws_ecs_task_definitions | aws_efs_file_system | aws_efs_file_systems | aws_efs_mount_target | aws_efs_mount_targets | aws_eks_cluster | aws_eks_clusters | aws_elasticache_cluster | aws_elasticache_cluster_node | aws_elasticache_clusters | aws_elasticache_replication_group | aws_elasticache_replication_groups | aws_elasticloadbalancingv2_listener | aws_elasticloadbalancingv2_listener_certificate | aws_elasticloadbalancingv2_listener_certificates | aws_elasticloadbalancingv2_listener_rule | aws_elasticloadbalancingv2_listener_rules | aws_elasticloadbalancingv2_listeners | aws_elasticloadbalancingv2_target_group | aws_elasticloadbalancingv2_target_groups | aws_elasticsearchservice_domain | aws_elasticsearchservice_domains | aws_elb | aws_elbs | aws_emr_cluster | aws_emr_clusters | aws_emr_security_configuration | aws_emr_security_configurationss | aws_eventbridge_rule | aws_eventbridge_rules | aws_flow_log | aws_glue_crawler | aws_glue_crawlers | aws_glue_database | aws_glue_databases | aws_guardduty_detector | aws_guardduty_detectors | aws_hosted_zone | aws_hosted_zones | aws_iam_access_key | aws_iam_access_keys | aws_iam_account_alias | aws_iam_group | aws_iam_groups | aws_iam_inline_policy | aws_iam_instance_profile | aws_iam_instance_profiles | aws_iam_managed_policies | aws_iam_managed_policy | aws_iam_oidc_provider | aws_iam_oidc_providers | aws_iam_password_policy | aws_iam_policies | aws_iam_policy | aws_iam_role | aws_iam_roles | aws_iam_root_user | aws_iam_saml_provider | aws_iam_saml_providers | aws_iam_server_certificate | aws_iam_server_certificates | aws_iam_service_linked_role_deletion_status | aws_iam_ssh_public_key | aws_iam_ssh_public_keys | aws_iam_user | aws_iam_users | aws_iam_virtual_mfa_devices | aws_internet_gateway | aws_internet_gateways | aws_kms_key | aws_kms_keys | aws_lambda | aws_lambda_alias | aws_lambda_aliases | aws_lambda_code_signing_config | aws_lambda_code_signing_configs | aws_lambda_event_invoke_config | aws_lambda_event_invoke_configs | aws_lambda_event_source_mapping | aws_lambda_event_source_mappings | aws_lambda_layer_version_permission | aws_lambda_permission | aws_lambda_permissions | aws_lambda_version | aws_lambda_versions | aws_lambdas | aws_launch_configuration | aws_logs_metric_filter | aws_logs_metric_filters | aws_mq_broker | aws_mq_brokers | aws_mq_configuration | aws_mq_configurations | aws_nat_gateway | aws_nat_gateways | aws_network_acl | aws_network_acls | aws_network_firewall_firewall | aws_network_firewall_firewall_policies | aws_network_firewall_firewall_policy | aws_network_firewall_firewalls | aws_network_firewall_logging_configuration | aws_network_firewall_rule_group | aws_network_firewall_rule_groups | aws_network_manager_customer_gateway_association | aws_network_manager_customer_gateway_associations | aws_network_manager_device | aws_network_manager_devices | aws_network_manager_global_network | aws_network_manager_global_networks | aws_organizations_member | aws_ram_resource_share | aws_ram_resource_shares | aws_rds_cluster | aws_rds_clusters | aws_rds_db_cluster_snapshot | aws_rds_db_cluster_snapshots | aws_rds_db_proxy | aws_rds_db_proxy_endpoint | aws_rds_db_proxy_endpoints | aws_rds_db_proxy_target_group | aws_rds_db_proxy_target_groups | aws_rds_db_security_group | aws_rds_db_security_groups | aws_rds_event_subscription | aws_rds_event_subscriptions | aws_rds_global_cluster | aws_rds_global_clusters | aws_rds_group_option | aws_rds_group_options | aws_rds_instance | aws_rds_instances | aws_rds_snapshot | aws_rds_snapshot_attributes | aws_rds_snapshots | aws_redshift_cluster | aws_redshift_cluster_parameter_group | aws_redshift_cluster_parameter_groups | aws_redshift_clusters | aws_region | aws_regions | aws_route53_record_set | aws_route53_record_sets | aws_route53resolver_resolver_endpoint | aws_route53resolver_resolver_endpoints | aws_route53resolver_resolver_rule | aws_route53resolver_resolver_rule_association | aws_route53resolver_resolver_rule_associations | aws_route53resolver_resolver_rules | aws_route_table | aws_route_tables | aws_s3_access_point | aws_s3_access_points | aws_s3_bucket | aws_s3_bucket_object | aws_s3_bucket_objects | aws_s3_bucket_policy | aws_s3_buckets | aws_sdb_domains | aws_secretsmanager_secret | aws_secretsmanager_secrets | aws_security_group | aws_security_groups | aws_securityhub_hub | aws_servicecatalog_cloud_formation_product | aws_servicecatalog_launch_role_constraint | aws_servicecatalog_launch_role_constraints | aws_servicecatalog_portfolio_principal_association | aws_servicecatalog_portfolio_principal_associations | aws_servicecatalog_portfolio_product_association | aws_servicecatalog_portfolio_product_associations | aws_ses_receipt_rule | aws_ses_receipt_rule_set | aws_ses_receipt_rule_sets | aws_ses_template | aws_ses_templates | aws_shield_subscription | aws_signer_profile_permissions | aws_signer_signing_profile | aws_signer_signing_profiles | aws_sns_subscription | aws_sns_subscriptions | aws_sns_topic | aws_sns_topics | aws_sqs_queue | aws_sqs_queues | aws_ssm_activation | aws_ssm_activations | aws_ssm_association | aws_ssm_associations | aws_ssm_document | aws_ssm_documents | aws_ssm_maintenance_window | aws_ssm_maintenance_window_target | aws_ssm_maintenance_window_targets | aws_ssm_maintenance_window_task | aws_ssm_maintenance_window_tasks | aws_ssm_maintenance_windows | aws_ssm_parameter | aws_ssm_parameters | aws_ssm_patch_baseline | aws_ssm_patch_baseline | aws_ssm_resource_compliance_summaries | aws_ssm_resource_compliance_summary | aws_ssm_resource_data_syncs | aws_stepfunctions_activities | aws_stepfunctions_activity | aws_stepfunctions_state_machine | aws_stepfunctions_state_machines | aws_sts_caller_identity | aws_subnet | aws_subnets | aws_synthetics_canaries | aws_synthetics_canary | aws_transfer_user | aws_transfer_users | aws_transit_gateway | aws_transit_gateway_connect | aws_transit_gateway_connects | aws_transit_gateway_multicast_domain | aws_transit_gateway_multicast_domain_association | aws_transit_gateway_multicast_domain_associations | aws_transit_gateway_multicast_domains | aws_transit_gateway_multicast_group_member | aws_transit_gateway_multicast_group_members | aws_transit_gateway_multicast_group_source | aws_transit_gateway_multicast_group_sources | aws_transit_gateway_route | aws_transit_gateway_routes | aws_vpc | aws_vpc_endpoint | aws_vpc_endpoint_connection_notification | aws_vpc_endpoint_connection_notifications | aws_vpc_endpoint_service | aws_vpc_endpoint_service_permission | aws_vpc_endpoint_service_permissions | aws_vpc_endpoint_services | aws_vpc_endpoints | aws_vpcs | aws_vpn_connection | aws_vpn_connections | aws_vpn_gateway | aws_vpn_gateways | aws_waf_byte_match_set | aws_waf_byte_match_sets | aws_waf_ip_set | aws_waf_ip_sets | aws_waf_rule | aws_waf_rules | aws_waf_size_constraint_set | aws_waf_size_constraint_sets | aws_waf_sql_injection_match_set | aws_waf_sql_injection_match_sets | aws_waf_web_acl | aws_waf_web_acls | aws_waf_xss_match_set | aws_waf_xss_match_sets

Azure Resources : azure_active_directory_domain_service | azure_active_directory_domain_services | azure_active_directory_object | azure_active_directory_objects | azure_aks_cluster | azure_aks_clusters | azure_api_management | azure_api_managements | azure_application_gateway | azure_application_gateways | azure_bastion_hosts_resource | azure_bastion_hosts_resources | azure_blob_service | azure_blob_services | azure_cdn_profile | azure_cdn_profiles | azure_container_group | azure_container_groups | azure_container_registries | azure_container_registry | azure_cosmosdb_database_account | azure_data_factories | azure_data_factory | azure_data_factory_dataset | azure_data_factory_datasets | azure_data_factory_linked_service | azure_data_factory_linked_services | azure_data_factory_pipeline | azure_data_factory_pipeline_run_resource | azure_data_factory_pipeline_run_resources | azure_data_factory_pipelines | azure_data_lake_storage_gen2_filesystem | azure_data_lake_storage_gen2_filesystems | azure_data_lake_storage_gen2_path | azure_data_lake_storage_gen2_paths | azure_db_migration_service | azure_db_migration_services | azure_ddos_protection_resource | azure_ddos_protection_resources | azure_dns_zones_resource | azure_dns_zones_resources | azure_event_hub_authorization_rule | azure_event_hub_event_hub | azure_event_hub_namespace | azure_express_route_circuit | azure_express_route_circuits | azure_express_route_providers | azure_generic_resource | azure_generic_resources | azure_graph_generic_resource | azure_graph_generic_resources | azure_graph_user | azure_graph_users | azure_hdinsight_cluster | azure_hpc_asc_operation | azure_hpc_cache | azure_hpc_cache_skus | azure_hpc_caches | azure_hpc_storage_target | azure_hpc_storage_targets | azure_iothub | azure_iothub_event_hub_consumer_group | azure_iothub_event_hub_consumer_groups | azure_key_vault | azure_key_vault_key | azure_key_vault_keys | azure_key_vault_secret | azure_key_vault_secrets | azure_key_vaults | azure_load_balancer | azure_load_balancers | azure_lock | azure_locks | azure_managed_application | azure_managed_applications | azure_management_group | azure_management_groups | azure_mariadb_server | azure_mariadb_servers | azure_microsoft_defender_pricing | azure_microsoft_defender_pricings | azure_microsoft_defender_security_contact | azure_microsoft_defender_setting | azure_microsoft_defender_settings | azure_migrate_assessment | azure_migrate_assessment_group | azure_migrate_assessment_groups | azure_migrate_assessment_machine | azure_migrate_assessment_machines | azure_migrate_assessment_project | azure_migrate_assessment_projects | azure_migrate_assessments | azure_migrate_project | azure_migrate_project_database | azure_migrate_project_database_instance | azure_migrate_project_database_instances | azure_migrate_project_databases | azure_migrate_project_event | azure_migrate_project_events | azure_migrate_project_machine | azure_migrate_project_machines | azure_migrate_project_solution | azure_migrate_project_solutions | azure_monitor_activity_log_alert | azure_monitor_activity_log_alerts | azure_monitor_log_profile | azure_monitor_log_profiles | azure_mysql_database | azure_mysql_database_configuration | azure_mysql_database_configurations | azure_mysql_databases | azure_mysql_server | azure_mysql_servers | azure_network_interface | azure_network_interfaces | azure_network_security_group | azure_network_security_groups | azure_network_watcher | azure_network_watchers | azure_policy_assignments | azure_policy_definition | azure_policy_definitions | azure_policy_exemption | azure_policy_exemptions | azure_policy_insights_query_result | azure_policy_insights_query_results | azure_postgresql_database | azure_postgresql_databases | azure_postgresql_server | azure_postgresql_servers | azure_power_bi_app | azure_power_bi_app_capacities | azure_power_bi_app_dashboard | azure_power_bi_app_dashboard_tile | azure_power_bi_app_dashboard_tiles | azure_power_bi_app_dashboards | azure_power_bi_app_report | azure_power_bi_app_reports | azure_power_bi_apps | azure_power_bi_capacity_refreshable | azure_power_bi_capacity_refreshables | azure_power_bi_capacity_workload | azure_power_bi_capacity_workloads | azure_power_bi_dashboard | azure_power_bi_dashboard_tile | azure_power_bi_dashboard_tiles | azure_power_bi_dashboards | azure_power_bi_dataflow | azure_power_bi_dataflow_storage_accounts | azure_power_bi_dataflows | azure_power_bi_dataset | azure_power_bi_dataset_datasources | azure_power_bi_datasets | azure_power_bi_embedded_capacities | azure_power_bi_embedded_capacity | azure_power_bi_gateway | azure_power_bi_gateways | azure_public_ip | azure_redis_cache | azure_redis_caches | azure_resource_group | azure_resource_groups | azure_resource_health_availability_status | azure_resource_health_availability_statuses | azure_resource_health_emerging_issue | azure_resource_health_emerging_issues | azure_resource_health_events | azure_role_definition | azure_role_definitions | azure_security_center_policies | azure_security_center_policy | azure_service_bus_namespace | azure_service_bus_namespaces | azure_service_bus_regions | azure_service_bus_subscription | azure_service_bus_subscription_rule | azure_service_bus_subscription_rules | azure_service_bus_subscriptions | azure_service_bus_topic | azure_service_bus_topics | azure_service_fabric_mesh_application | azure_service_fabric_mesh_applications | azure_service_fabric_mesh_network | azure_service_fabric_mesh_networks | azure_service_fabric_mesh_replica | azure_service_fabric_mesh_replicas | azure_service_fabric_mesh_service | azure_service_fabric_mesh_services | azure_service_fabric_mesh_volume | azure_service_fabric_mesh_volumes | azure_snapshot | azure_snapshots | azure_sql_database | azure_sql_database_server_vulnerability_assessment | azure_sql_database_server_vulnerability_assessments | azure_sql_databases | azure_sql_managed_instance | azure_sql_managed_instances | azure_sql_server | azure_sql_servers | azure_sql_virtual_machine | azure_sql_virtual_machine_group | azure_sql_virtual_machine_group_availability_listener | azure_sql_virtual_machine_group_availability_listeners | azure_sql_virtual_machine_groups | azure_sql_virtual_machines | azure_storage_account | azure_storage_account_blob_container | azure_storage_account_blob_containers | azure_storage_accounts | azure_streaming_analytics_function | azure_streaming_analytics_functions | azure_subnet | azure_subnets | azure_subscription | azure_subscriptions | azure_synapse_notebook | azure_synapse_notebooks | azure_synapse_workspace | azure_synapse_workspaces | azure_virtual_machine | azure_virtual_machine_disk | azure_virtual_machine_disks | azure_virtual_machines | azure_virtual_network | azure_virtual_network_gateway | azure_virtual_network_gateway_connection | azure_virtual_network_gateway_connections | azure_virtual_network_gateways | azure_virtual_network_peering | azure_virtual_network_peerings | azure_virtual_networks | azure_virtual_wan | azure_virtual_wans | azure_web_app_function | azure_web_app_functions | azure_webapp | azure_webapps | azurerm_ad_user | azurerm_ad_users | azurerm_aks_cluster | azurerm_aks_clusters | azurerm_cosmosdb_database_account | azurerm_event_hub_authorization_rule | azurerm_event_hub_event_hub | azurerm_event_hub_namespace | azurerm_iothub | azurerm_iothub_event_hub_consumer_group | azurerm_iothub_event_hub_consumer_groups | azurerm_key_vault | azurerm_key_vault_key | azurerm_key_vault_keys | azurerm_key_vault_secret | azurerm_key_vault_secrets | azurerm_key_vaults | azurerm_load_balancer | azurerm_load_balancers | azurerm_locks | azurerm_management_group | azurerm_management_groups | azurerm_monitor_activity_log_alert | azurerm_monitor_activity_log_alerts | azurerm_monitor_log_profile | azurerm_monitor_log_profiles | azurerm_mysql_database | azurerm_mysql_databases | azurerm_mysql_server | azurerm_mysql_servers | azurerm_network_interface | azurerm_network_interfaces | azurerm_network_security_group | azurerm_network_security_groups | azurerm_network_watcher | azurerm_network_watchers | azurerm_postgresql_database | azurerm_postgresql_databases | azurerm_postgresql_server | azurerm_postgresql_servers | azurerm_resource_groups | azurerm_role_definition | azurerm_role_definitions | azurerm_security_center_policies | azurerm_security_center_policy | azurerm_sql_database | azurerm_sql_databases | azurerm_sql_server | azurerm_sql_servers | azurerm_storage_account_blob_container | azurerm_storage_account_blob_containers | azurerm_subnet | azurerm_subnets | azurerm_subscription | azurerm_virtual_machine | azurerm_virtual_machine_disk | azurerm_virtual_machine_disks | azurerm_virtual_machines | azurerm_virtual_network | azurerm_virtual_networks | azurerm_webapp | azurerm_webapps

GCP Resources : google_access_context_manager_access_policies | google_access_context_manager_access_policy | google_access_context_manager_service_perimeter | google_access_context_manager_service_perimeters | google_appengine_standard_app_version | google_appengine_standard_app_versions | google_bigquery_dataset | google_bigquery_datasets | google_bigquery_table | google_bigquery_tables | google_billing_project_billing_info | google_cloud_scheduler_job | google_cloud_scheduler_jobs | google_cloudbuild_trigger | google_cloudbuild_triggers | google_cloudfunctions_cloud_function | google_cloudfunctions_cloud_functions | google_compute_address | google_compute_addresses | google_compute_autoscaler | google_compute_autoscalers | google_compute_backend_bucket | google_compute_backend_buckets | google_compute_backend_service | google_compute_backend_services | google_compute_disk | google_compute_disks | google_compute_firewall | google_compute_firewalls | google_compute_forwarding_rule | google_compute_forwarding_rules | google_compute_global_address | google_compute_global_addresses | google_compute_global_forwarding_rule | google_compute_global_forwarding_rules | google_compute_health_check | google_compute_health_checks | google_compute_http_health_check | google_compute_http_health_checks | google_compute_https_health_check | google_compute_https_health_checks | google_compute_image | google_compute_instance | google_compute_instance_group | google_compute_instance_group_manager | google_compute_instance_group_managers | google_compute_instance_groups | google_compute_instance_template | google_compute_instance_templates | google_compute_instances | google_compute_network | google_compute_network_endpoint_group | google_compute_network_endpoint_groups | google_compute_networks | google_compute_node_group | google_compute_node_groups | google_compute_node_template | google_compute_node_templates | google_compute_project_info | google_compute_region | google_compute_region_backend_service | google_compute_region_backend_services | google_compute_region_instance_group_manager | google_compute_region_instance_group_managers | google_compute_regional_disk | google_compute_regions | google_compute_route | google_compute_router | google_compute_router_nat | google_compute_router_nats | google_compute_routers | google_compute_routes | google_compute_security_policies | google_compute_security_policy | google_compute_snapshot | google_compute_snapshots | google_compute_ssl_certificate | google_compute_ssl_certificates | google_compute_ssl_policies | google_compute_ssl_policy | google_compute_subnetwork | google_compute_subnetwork_iam_binding | google_compute_subnetwork_iam_policy | google_compute_subnetworks | google_compute_target_http_proxies | google_compute_target_http_proxy | google_compute_target_https_proxies | google_compute_target_https_proxy | google_compute_target_pool | google_compute_target_pools | google_compute_target_tcp_proxies | google_compute_target_tcp_proxy | google_compute_url_map | google_compute_url_maps | google_compute_vpn_tunnel | google_compute_vpn_tunnels | google_compute_zone | google_compute_zones | google_container_cluster | google_container_clusters | google_container_node_pool | google_container_node_pools | google_container_regional_cluster | google_container_regional_clusters | google_container_regional_node_pool | google_container_regional_node_pools | google_dataproc_cluster | google_dataproc_clusters | google_dns_managed_zone | google_dns_managed_zones | google_dns_resource_record_set | google_dns_resource_record_sets | google_filestore_instance | google_filestore_instances | google_iam_custom_role | google_iam_custom_roles | google_iam_organization_custom_role | google_iam_organization_custom_roles | google_iam_service_account | google_iam_service_account_key | google_iam_service_account_keys | google_iam_service_accounts | google_kms_crypto_key | google_kms_crypto_key_iam_binding | google_kms_crypto_key_iam_bindings | google_kms_crypto_key_iam_policy | google_kms_crypto_keys | google_kms_key_ring | google_kms_key_ring_iam_binding | google_kms_key_ring_iam_bindings | google_kms_key_ring_iam_policy | google_kms_key_rings | google_logging_folder_exclusion | google_logging_folder_exclusions | google_logging_folder_log_sink | google_logging_folder_log_sinks | google_logging_organization_log_sink | google_logging_organization_log_sinks | google_logging_project_exclusion | google_logging_project_exclusions | google_logging_project_sink | google_logging_project_sinks | google_ml_engine_model | google_ml_engine_models | google_organization | google_organization_iam_binding | google_organization_iam_policy | google_organization_policy | google_organizations | google_project | google_project_alert_policies | google_project_alert_policy | google_project_alert_policy_condition | google_project_iam_binding | google_project_iam_bindings | google_project_iam_custom_role | google_project_iam_custom_roles | google_project_iam_policy | google_project_logging_audit_config | google_project_metric | google_project_metrics | google_project_service | google_project_services | google_projects | google_pubsub_subscription | google_pubsub_subscription_iam_binding | google_pubsub_subscription_iam_policy | google_pubsub_subscriptions | google_pubsub_topic | google_pubsub_topic_iam_binding | google_pubsub_topic_iam_policy | google_pubsub_topics | google_redis_instance | google_redis_instances | google_resourcemanager_folder | google_resourcemanager_folder_iam_binding | google_resourcemanager_folder_iam_policy | google_resourcemanager_folders | google_resourcemanager_organization_policy | google_resourcemanager_project_iam_binding | google_resourcemanager_project_iam_policy | google_runtime_config_config | google_runtime_config_config_iam_binding | google_runtime_config_config_iam_policy | google_runtime_config_configs | google_runtime_config_variable | google_runtime_config_variables | google_service_account | google_service_account_key | google_service_account_keys | google_service_accounts | google_sourcerepo_repositories | google_sourcerepo_repository | google_spanner_database | google_spanner_databases | google_spanner_instance | google_spanner_instance_iam_binding | google_spanner_instance_iam_policy | google_spanner_instances | google_sql_database_instance | google_sql_database_instances | google_sql_user | google_sql_users | google_storage_bucket | google_storage_bucket_acl | google_storage_bucket_iam_binding | google_storage_bucket_iam_bindings | google_storage_bucket_iam_policy | google_storage_bucket_object | google_storage_bucket_objects | google_storage_buckets | google_storage_default_object_acl | google_storage_object_acl | google_user | google_users

Habitat Resources : habitat_package | habitat_packages | habitat_service | habitat_services

Kubernetes Resources : k8s_api_resources | k8s_config_map | k8s_config_maps | k8s_container | k8s_containers | k8s_cronjob | k8s_cronjobs | k8s_daemon_set | k8s_daemon_sets | k8s_deployment | k8s_deployments | k8s_exec_file | k8s_job | k8s_jobs | k8s_namespace | k8s_namespaces | k8s_network_policies | k8s_network_policy | k8s_node | k8s_nodes | k8s_pod | k8s_pods | k8s_rbac_cluster_role | k8s_rbac_cluster_roles | k8sobject | k8sobjects

Chef SaaS

Overview | Get Started | AWS OpsWorks Migration | Configure SSO | Redirect nodes

Chef Workstation

Overview | Install | Setup | Configure | Troubleshooting | Privacy and Telemetry

Chef Workstation Tools

Berkshelf

chef (executable) : chef executable (full page) | chef capture | chef env | chef exec | chef gem | chef generate attribute | chef generate cookbook | chef generate file | chef generate input | chef generate profile | chef generate recipe | chef generate repo | chef generate resource | chef generate template | chef generate waiver | chef report cookbooks | chef report nodes | chef shell-init

| chef-run (executable) | chef-shell (executable) | chef-vault (executable) | ChefSpec | Chef Workstation App | config.rb (knife.rb) | Optional config.rb Settings

Cookstyle : About Cookstyle | All Cookstyle Cops | Correctness Cops | Chef Deprecation Cops | Effortless Cops | Modernization Cops | Redundant Code Cops | Security Cops | Sharing Cops | Style Cops | InSpec Deprecations Cops

Test Kitchen : About Test Kitchen | kitchen (executable) | kitchen.yml | kitchen-vagrant

Knife : About Knife | Setting up Knife | Knife Common Options | config.rb (knife.rb) | knife azurerm | 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 org | 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 windows | knife winrm | knife xargs

| Upgrade Lab

Extension APIs

Knife Plugins : Cloud Plugins | Writing Custom Plugins

Effortless Pattern

Effortless Overview | Quick Start | Effortless Audit | Effortless Config | Variables and Config | What is Scaffolding

Supermarket

About Supermarket | Share Cookbooks

Private Supermarket

About Private Supermarket | Install | Configure | Backup and Restore | Monitor | Log Files | Upgrades

Reference

supermarket-ctl | Supermarket API

Release Notes

Chef Automate | Chef 360 Platform | Chef Backend | Chef Download APIs | Chef Habitat | Chef Infra Client | Chef Infra Server | Chef InSpec | Chef Local License Service | Chef Manage | Chef Supermarket | Chef Workstation

Chef Compliance

Chef Compliance Audit Profiles | Chef Compliance Remediation

Chef Cloud Resource Packs

AWS Cloud Resources | Azure Cloud Resources

Legacy

Chef Manage

About the Management Console | Uninstall | manage.rb | chef-manage-ctl | Active Directory & LDAP | Configure SAML | Clients | Cookbooks | Data Bags | Environments | Nodes | Roles | Organizations & Groups | Users | Uninstall Send Feedback

×