/usr/share/doc/ohai/README.rdoc is in ohai 6.14.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | = ohai
= DESCRIPTION:
Ohai detects data about your operating system. It can be used standalone, but it's 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.
Opscode 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 wiki:
* http://wiki.opscode.com/display/chef/Ohai
= DEVELOPMENT:
Before working on the code, if you plan to contribute your changes, you need to read the Opscode Contributing document.
* http://wiki.opscode.com/display/chef/How+to+Contribute
You will also need to set up the repository with the appropriate branches. We document the process on the Chef Wiki.
* http://wiki.opscode.com/display/chef/Working+with+git
(Substitude 'ohai' for 'chef')
Once your repository is set up, you can start working on the code. We do use BDD/TDD with RSpec, and soon Cucumber for integration/feature testing, so you'll need to get those installed.
= ENVIRONMENT:
In order to have a dev environment where you can work on Ohai, you'll need to install a few additional gems after setting up the Git repository.
Install the following RubyGems.
* rake
* rspec
* extlib
* systemu
* json
gem install rake rspec extlib systemu json
== Rake Tasks
Ohai has some Rake tasks for doing various things.
rake -T
rake clobber_package # Remove package products
rake gem # Build the gem file ohai-$VERSION.gem
rake install # install the gem locally
rake make_spec # create a gemspec file
rake package # Build all the packages
rake repackage # Force a rebuild of the package files
rake spec # Run specs
($VERSION is the current version, from the GemSpec in Rakefile)
== Spec Testing:
We use RSpec for unit/spec tests.
rake spec
Because ohai gathers system information, and we don't know what kind of system we might be running on (yet), we're moving away from specs for integration testing and to cucumber.
= LINKS:
Source:
* http://github.com/opscode/ohai/tree/master
Tickets/Issues:
* http://tickets.opscode.com/
(Use the OHAI project)
Documentation:
* http://wiki.opscode.com/display/chef/Ohai
= LICENSE:
Ohai - system information application
Author:: Adam Jacob (<adam@opscode.com>)
Copyright:: Copyright (c) 2008 Opscode, 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.
|