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
- Writing Ohai Plugins documentation: https://docs.chef.io/ohai_custom.html
Ohai's development dependencies should be installed with bundler. Just run
bundle install in the root of the repo.
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
Ohai has some Rake tasks for doing various things.
rake -T rake build # Build ohai-$VERSION.gem into the pkg directory rake clean # Remove any temporary products rake clobber # Remove any generated files rake docs # Generate YARD Documentation rake install # Build and install ohai-$VERSION.gem into system gems rake install:local # Build and install ohai-$VERSION.gem into system gems without network access rake release[remote] # Create tag $VERSION and build and push ohai-$VERSION.gem to rubygems.org rake spec # Run RSpec code examples rake style # Run Chefstyle tests rake style:auto_correct # Auto-correct RuboCop offenses ($VERSION is the current version, from the GemSpec in Rakefile)
For information on contributing to this project see https://github.com/chef/chef/blob/master/CONTRIBUTING.md
Ohai - system information application
- Author:: Adam Jacob ([email protected])
- Copyright:: Copyright (c) 2008-2018 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.