DOCSEARCHbyAlgolia
Submit Docs

Chef Web Docs

repository·main·Indexed 40 days ago

https://github.com/chef/chef-web-docs

The central source for Chef documentation published at docs.chef.io. This repository manages the documentation theme, configuration, and vendored content from various Chef product repositories using Hugo modules.

Tokens
408.6K
Snippets
1.3K
Records
1.8K
Agent score
49%

What's inside Chef Web Docs

  1. Overview of chef-shell executable

    main

    chef-shell is a recipe debugging tool that provides an Interactive Ruby (IRb) session. It allows you to use breakpoints within recipes and supports both recipe and attribute file syntax. It is primarily used to debug cookbooks and manipulate Chef Infra data interactively.

    chef-shell can be run in three distinct modes:

    • Standalone (Default): No cookbooks are loaded and the run-list is empty.
    • Solo (-s, --solo): Acts as a Chef Solo Client. It loads configuration from ~/.chef/config.rb and any provided JSON attributes. If the JSON attributes define a run_list, that run-list is used.
    • Client (-z, --client): Acts as a Chef Infra Client. It reads configuration from ~/.chef/client.rb and contacts the Chef Infra Server to retrieve the node's run_list, attributes, and cookbooks.

  3. Overview of Chef Automate capabilities

    main

    Chef Automate is an enterprise dashboard designed for continuous visibility into application, infrastructure, and security automation. It provides an auditable history of infrastructure changes and consolidates data from various Chef tools to provide actionable insights.

    Key Integrations

    Chef Automate integrates with:

    • Chef Infra Server and Chef Infra Client for infrastructure automation.
    • Chef InSpec for compliance and security automation.
    • Chef Habitat for application automation.

    Core Components

    • Web UI: A central interface for viewing Chef Infra Client nodes, runs, servers, policy groups, profiles, and Cookbooks. It includes filterable dashboards, trend graphs, and a rich query language to monitor configuration and compliance across data centers and cloud providers.
    • Compliance Monitoring: Uses Chef InSpec to identify security risks and outdated software. You can use built-in profiles (e.g., CIS benchmarks or DISA STIGs) or write custom rules to scan machines, VMs, and cloud environments.
    • Application Monitoring: An Application dashboard monitors the health of applications deployed via Chef Habitat.
    • Role-Based Access Control (RBAC): Manages user access to data and functions using pre-defined or custom roles. Supports authentication via SAML or LDAP.
    • API: Provides programmatic access to view and update the Automate deployment, including node management, compliance, events, secrets, and users.
    • High Availability: Supports configurations designed to limit downtime and scale with your infrastructure.
    • Notifications & Data Feeds:
      • Webhooks: Notify you of Chef Infra Client run failures or Chef InSpec compliance scan failures via Slack, ServiceNow, or custom services.
      • Data Feeds: Export Chef Infra Client run data and compliance scan data to 3rd-party services like ServiceNow, Splunk, and ELK/Kibana, or via custom feeds.

  4. Overview of Progress Chef Enterprise Edition

    main

    Progress Chef Enterprise Edition is a commercial version of Chef designed for large and medium-sized enterprises. It extends the open-source Community edition by providing enhanced features, verified supply chain integrity, and professional support services.

    Key differentiators include:

    • Verified Distributions: Bundled dependencies are verified with a signatory commitment of authenticity from Progress.
    • Security & Compliance: Adherence to standards like SOC, PCI, DSS, and ISO 90078, with prompt CVE reporting.
    • SLA-backed Support: Incident response and security fix SLAs, including proactive monitoring by the Chef Professional Services team.
    • High Availability: Access to Chef Automate HA (on-premises or AWS) and Chef SaaS for large-scale fleets.
    • Premium Content: Access to 100+ curated compliance profiles (CIS, DISA, STIGs).
    • Advanced Orchestration: Access to Chef Courier for job orchestration and node management via the Chef 360 platform.

  7. Overview of Chef Workstation tools

    main

    Chef Workstation is a package that bundles all the necessary tools for working with Chef Infra and Chef InSpec. Key tools included are:

    • Chef CLI: The primary workflow tool for Chef Infra.
    • knife: Used for managing systems and interacting with the Chef Infra Server.
    • Chef Infra Client: The agent installed on nodes to perform actual configuration.
    • Chef InSpec: A compliance-as-code tool used for compliance auditing and testing Chef Infra cookbooks.
    • Cookstyle: A linter that detects and automatically corrects style, syntax, and logic errors in cookbooks.
    • Test Kitchen: An integration testing framework that validates cookbooks across different platforms, cloud providers, and hypervisors.

  8. What is Chef Workstation?

    main

    Chef Workstation is an all-in-one package designed for Chef infrastructure engineers to automate infrastructure. It provides a unified toolkit for configuration management, compliance scanning, cookbook development, dependency resolution, and testing.

    Key capabilities include:

    • Defining automation: Writing configuration policy using declarative resources or using community cookbooks from Chef Supermarket.
    • Managing secrets: Using Chef Vault to encrypt and manage sensitive data like passwords and certificates.
    • Scanning for compliance: Running Chef InSpec profiles against remote systems to detect security and configuration issues.
    • Local testing: Validating cookbooks using Test Kitchen and Cookstyle before production deployment.

  9. What is Chef Desktop?

    main

    Chef Desktop is a deployment pattern designed to automate desktop and laptop management using code. It allows administrators to define device profiles using YAML, audit those profiles using curated CIS (Center for Internet Security) profiles, and deploy them using Chef Infra. Configuration status and fleet visibility are managed through Chef Automate.

    Key functions managed by Chef Desktop include:

    • Hard drive encryption
    • Screensaver password requirements
    • Password complexity policies
    • Creation of rescue or additional user accounts
    • Application management (deployment and management)
    • Update management (OS and patch control)
    • Desktop control (limiting access to specific features or services)

  10. What is Knife and how to use it

    main

    Knife is a command-line tool that provides an interface between a local chef-repo and Chef Infra Server. It is used to manage nodes, cookbooks, recipes, roles, environments, data bags, cloud resources, and to search indexed data on the Chef Infra Server.

    Command Syntax

    All knife subcommands follow this pattern:

    knife subcommand [ARGUMENT] (options)

    Note that in documentation examples, variables are represented in ALL_CAPS (e.g., -F FORMAT or -u PORT_LIST).