ohai

DESCRIPTION:

Ohai detects data about your operating system. It can be used standalone, but its primary purpose is to provide node data to Chef.

Ohai will print out a JSON data blob for all the known data about your system. When used with Chef, that data is reported back via node attributes.

Chef distributes ohai as a RubyGem. This README is for developers who want to modify the Ohai source code. For users who want to write plugins for Ohai, see the docs:

General documentation: https://docs.chef.io/ohai.html
Custom plugin documentation: https://docs.chef.io/ohai_custom.html

DEVELOPMENT:

Before working on the code, if you plan to contribute your changes, you should read the contributing guidelines:

https://github.com/chef/ohai/blob/master/CONTRIBUTING.md

The basic process for contributing is:

Fork this repo on GitHub.
Create a feature branch for your work.
Make your change, including tests.
Submit a pull request.

ENVIRONMENT:

Ohai's development dependencies should be installed with bundler. Just run bundle install in the root of the repo.

Spec Testing:

We use RSpec for unit/spec tests. To run the full suite, run:

bundle exec rake spec

You can run individual test files by running the rspec executable:

bundle exec rspec spec/unit/FILE.rb

Rake Tasks

Ohai has some Rake tasks for doing various things.

rake -T
rake build          # Build the gem file ohai-$VERSION.gem
rake install        # install the gem locally
rake install:local  # install the gem locally without network access
rake release        # Create tag $VERSION, build gem, and push to Rubygems
rake spec           # Run RSpec tests

($VERSION is the current version, from the GemSpec in Rakefile)

LICENSE:

Ohai - system information application

Author:: Adam Jacob (adam@chef.io)
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.

acaiafa/ohai