Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A systems integration framework, built to bring the benefits of configuration management to your entire infrastructure.
Ruby HTML Groff Other
branch: master
Failed to load latest commit information.
bin Remove all parts of 'shef'
chef-config Bump all version numbers
ci Enable integration tests.
distro/common Update man pages with links to the docs site
ext/win32-eventlog Added error
external_tests Add Chef::ResourceResolver.resolve
kitchen-tests Fix failing kitchen tests
lib Make audit comments nicer!
rubygems-pkg Run rubygems from master for perf improvements
spec Fix up deprecated_attr_*, add tests
tasks Use --local install for component tests
.gitattributes [OC-3564] move core Chef to the repo root \o/ \m/
.gitignore Add specs for many external dependent projects
.kitchen.yml Addressing review comments, adding documentation
.mailmap Use chef.io addresses for current Chef employees
.rspec Use RSpec documentation formatter.
.travis.yml Use descriptive constant names in tests to avoid conflict
.yardopts [OC-3564] move README to markdown format
CHANGELOG.md Update CHANGELOG for #3358, #3431
CHEF_MVPS.md Blog links use chef.io domain
CLA_ARCHIVE.md Add CLA_ARCHIVE -- List of CLAs from pre-supermarket times
CONTRIBUTING.md Clarify where issues should be filed
DOC_CHANGES.md Add Chef::ResourceResolver.resolve
Gemfile Move Chef::Config into a subproject
LICENSE Chef should have the license and notice at the top
MAINTAINERS.toml adding ksubrama to the people section
NOTICE changed Ohai -> Chef in NOTICE
README.md Add space so GFM recognizes the ordered list
RELEASE_NOTES.md Use multiple attributes in windows_package example
ROADMAP.md Add initial roadmap per RFC030
Rakefile Update rake tasks for componentization
VERSION Bump all version numbers
appveyor.yml Install bundler before upgrading rubygems
chef-windows.gemspec Switch over Windows builds to universal builds.
chef.gemspec Update rake tasks for componentization
pedant.gemfile Modify pedant to run w/o chef

README.md

Chef

Code Climate Build Status Master Build Status Master

Want to try Chef? Get started with learnchef

Chef is a configuration management tool designed to bring automation to your entire infrastructure.

This README focuses on developers who want to modify Chef source code. If you just want to use Chef, check out these resources:

Installing From Git

NOTE: Unless you have a specific reason to install from source (to try a new feature, contribute a patch, or run chef on an OS for which no package is available), you should head to the installer page to get a prebuilt package.

Prerequisites

Install these via your platform's preferred method (apt, yum, ports, emerge, etc.):

  • git
  • C compiler, header files, etc. On Ubuntu/Debian, use the build-essential package.
  • ruby 2.0.0 or later
  • rubygems
  • bundler

Chef Installation

Then get the source and install it:

# Clone this repo
git clone https://github.com/chef/chef.git

# cd into the source tree
cd chef

# Install dependencies with bundler
bundle install

# Build a gem
rake gem

# Install the gem you just built
gem install pkg/chef-VERSION.gem

Contributing/Development

Before working on the code, if you plan to contribute your changes, you need to read the Chef Contributions document.

The general development process is:

  1. Fork this repo and clone it to your workstation
  2. Create a feature branch for your change
  3. Write code and tests
  4. Push your feature branch to github and open a pull request against master

Once your repository is set up, you can start working on the code. We do use TDD with RSpec, so you'll need to get a development environment running. Follow the above procedure ("Installing from Git") to get your local copy of the source running.

Reporting Issues

Issues can be reported by using GitHub issues.

Full details on how to report issues can be found in the CONTRIBUTING doc.

Note that this repository is primarily for reporting chef-client issues. For reporting issues against other Chef projects, please look up the appropriate repository to report issues against in the Chef docs in the community contributions section. If you can't detemine the appropriate place to report an issue, then please open it against the repository you think best fits and it will be directed to the appropriate project.

Testing

We use RSpec for unit/spec tests. It is not necessary to start the development environment to run the specs--they are completely standalone.

# Run All the Tests
bundle exec rake spec

# Run a Single Test File
bundle exec rspec spec/PATH/TO/FILE_spec.rb

# Run a Subset of Tests
bundle exec rspec spec/PATH/TO/DIR

When you submit a pull request, we will automatically run the functional and unit tests in spec/functional/ and spec/unit/ respectively. These will be run on Ubuntu through Travis CI, and on Windows through AppVeyor. The status of these runs will be displayed with your pull request.

License

Chef - A configuration management system

Author: Adam Jacob (adam@chef.io)
Copyright: Copyright (c) 2008-2015 Chef Software, Inc.
License: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.