The ohai cookbook has been deprecated

Author provided reason for deprecation:

The ohai cookbook has been deprecated and is no longer being maintained by its authors. Use of the ohai cookbook is no longer recommended.

RSS

ohai (40) Versions 5.3.1 Follow103

Provides custom resources for installing Ohai hints and plugins

Policyfile

Berkshelf

Knife

cookbook 'ohai', '~> 5.3.1', :supermarket

cookbook 'ohai', '~> 5.3.1'

knife supermarket install ohai

knife supermarket download ohai

README

Dependencies

Changelog

Quality 17%

ohai Cookbook

Contains custom resources for adding Ohai hints and installing custom Ohai plugins. Handles path creation as well as the reloading of Ohai so that new data will be available during the same run.

Deprecation

This cookbook has been deprecated as all functionality here is now built into the Chef Infra Client itself. The ohai_hint resource now ships in Chef Infra Client and any plugins can be installed by placing them in an ohai directory within a cookbook in your runlist.

Requirements

Platforms

Debian/Ubuntu
RHEL/CentOS/Scientific/Amazon/Oracle
openSUSE / SUSE Enterprise Linux
FreeBSD
Windows

Chef

Chef 13+

Cookbooks

none

Custom Resources

`ohai_hint`

Creates Ohai hint files, which are consumed by Ohai plugins in order to determine if they should run or not.

Resource Properties

hint_name - The name of hints file and key. Should be string, default is name of resource.
content - Values of hints. It will be used as automatic attributes. Should be Hash, default is empty Hash
compile_time - Should the resource run at compile time. This defaults to true

Examples

Hint file installed to the default directory:

ohai_hint 'ec2'

Hint file not installed at compile time:

ohai_hint 'ec2' do
  compile_time false
end

Hint file installed with content:

ohai_hint 'raid_present' do
  content Hash[:a, 'test_content']
end

ChefSpec Matchers

You can check for the creation or deletion of ohai hints with chefspec using these custom matches:

create_ohai_hint
delete_ohai_hint

`ohai_plugin`

Installs custom Ohai plugins.

Resource Properties

plugin_name - The name to give the plugin on the filesystem. Should be string, default is name of resource.
path - The path to your custom plugin directory. Defaults to a directory named 'plugins' under the directory 'ohai' in the Chef config dir.
source_file - The source file for the plugin in your cookbook if not NAME.rb.
cookbook - The cookbook where the source file exists if not the cookbook where the ohai_plugin resource is running from.
resource - The resource type for the plugin file. Either :cookbook_file or :template. Defaults to :cookbook_file.
variables - Usable only if resource is :template. Defines the template's variables.
compile_time - Should the resource run at compile time. This defaults to true.
load_single_plugin - Reload all plugins unless this value is set to true. Load only the named plugin.

examples

Simple Ohai plugin installation:

ohai_plugin 'my_custom_plugin'

Installation where the resource doesn't match the filename and you install to a custom plugins dir:

ohai_plugin 'My Ohai Plugin' do
  name 'my_custom_plugin'
  path '/my/custom/path/'
end

Installation using a template:

ohai_plugin 'My Templated Plugin' do
  name 'templated_plugin'
  resource :template
  variables node_type: :web_server
end

ChefSpec Matchers

You can check for the creation or deletion of ohai plugins with chefspec using these custom matches:

create_ohai_plugin
delete_ohai_plugin

Maintainers

This cookbook is maintained by Chef's Community Cookbook Engineering team. Our goal is to improve cookbook quality and to aid the community in contributing to cookbooks. To learn more about our team, process, and design goals see our team documentation. To learn more about contributing to cookbooks like this see our contributing documentation, or if you have general questions about this cookbook come chat with us in #cookbok-engineering on the Chef Community Slack

License

Copyright: 2011-2016, Chef Software, Inc.

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.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

ohai Cookbook CHANGELOG

This file is used to list changes made in each version of the ohai cookbook.

5.3.1 (2022-01-14)

Resolve bad notification syntax in the ohai_hint :delete action
resolved cookstyle error: libraries/plugin_helpers.rb:39:9 refactor: ChefCorrectness/ChefApplicationFatal

5.3.0 (2019-08-29)

Add code owners file - @tas50
Cookstyle fixes - @tas50
Require Chef 13 or later - @tas50
Remove the long_description metadata - @tas50
Add the load_single_plugin option to the ohai_plugin resource - @MarkGibbons
Update for Chef 15 license agreement and Chef Workstation - @tas50
Update the platforms we test on in Travis / Test Kitchen - @tas50

5.2.5 (2018-09-04)

Add note that ohai_hint will be removed April 2019 when Chef 13 goes EOL as this resource now ships in Chef 14+

5.2.4 (2018-08-28)

Avoid deprecation warnings in Chef 14.3+ by not loading resources already in Chef

5.2.3 (2018-06-08)

Make sure we properly compare a provided plugin path to the path on disk by stripping trailing slashes from the provided directory
Don't reload ohai when the plugin exists in a subdirectory of the config's set plugin path

5.2.2 (2018-02-15)

Remove ChefSpec matchers we no longer need since they're auto generated

5.2.1 (2018-01-25)

Switch from a .foodcritic file to an inline comments which resolve Supermarket warnings
Remove unused helper method

5.2.0 (2017-08-17)

Resolve multiple issues with Windows paths that caused the cookbook to converge on every run or fail
Move maintainer information to the readme
Add testing on Chef 12.7 in Travis
Move helpers to their own modules and add testing framework

5.1.0 (2017-05-06)

Workaround action_class bug by requiring Chef 12.7+

5.0.4 (2017-04-25)

Fix lack of .rb extension when deleting plugins.

5.0.3 (2017-04-06)

Use class_eval again in the custom resource to provide Chef 12.5/12.6 compatibility
Remove kind_of and use name_property not name_attribute
Fix failures on Chef 13

5.0.2 (2017-03-24)

Remove class_eval

5.0.1 (2017-03-14)

Test with Delivery Local Mode
Bump the dependency to 12.7+ due to failures on 12.5-12.6

5.0.0 (2017-02-23)

Require Chef 12.5+ and remove compat_resource dependency

4.2.3 (2016-12-02)

Prevent chef_version metadata from failing runs in Opsworks
Better explain how to resolve the plugin_path issue
Add suse as a supported platform
Require at least compat_resource 12.14.7

4.2.2 (2016-09-19)

Ignore case in plugin path check on Windows

4.2.1 (2016-09-08)

Fix typo in compile warning text
Depend on the latest compat_resource (12.14)
Remove Chef 11 compat in the metadata
Require Chef 12.1 not 12.0
Define ohai_plugin matcher for Chefspec

v4.2.0 (2016-07-19)

Added the ability to specify the source cookbook for the cookbook_file or template used in the ohai_plugin resource.
Added chef_version to the metadata
Added testing on openSUSE and switched from Rubocop to Cookstyle

v4.1.1 (2016-06-16)

Fixed error in notifies reload for the delete action
Bump the compat_resource requirement from 12.9+ to 12.10+ to prevent random failures

v4.1.0 (2016-05-26)

Added the ability to use templates and pass in variables with the plugin custom resource

v4.0.2 (2016-05-23)

Resolve failures on Windows nodes

v4.0.1 (2016-05-19)

Added .rb to the name of the plugins so they actually load
Added testing to ensure the plugins are being loaded in the chef run

v4.0.0 (2016-05-18)

BREAKING CHANGE:

The 4.0 release of the Ohai cookbook removes the previous cookbook_file behavior that required forking the cookbook and adding your own plugins. Instead the cookbook ships with a new ohai_plugin custom resource for installing plugins. In addition to this new custom resource the cookbook now requires Chef 12+. See the readme and test recipe for examples. If you require Chef 11 support you'll need to pin to version 3.0 in your environment.

v3.0.1 (2016-03-14)

Fixed the Chefspec matchers

v3.0.0 (2016-03-14)

Change the default value for node['ohai']['hints_path'] to use the Ohai config value. This should be the same value in most use cases, but if a custom path is specified in the chef client config this value will get used automatically by the cookbook.
Removed backwards compatibility with Chefspec < 4.1 in the matchers library
Fix bad link to the custom Ohai plugin documentation in the readme
Improve documentation for node['ohai']['plugin_path']

v2.1.0 (2016-01-26)

Properly handle creating ohai hints without specifying the content. Previously if the content wasn't specified a deprecation notice would be thrown and the file would not be created
Simplified the test suite and added inspec tests to ensure hints are created, especially if the content is not specified
Added FreeBSD and Windows as supported platform in the metadata and add them to the Test Kitchen config
Add Test Kitchen integration tests to Travis CI
Updated testing Gems to the latest releases in the Gemfile

v2.0.4 (2015-10-30)

Resolved deprecation warnings with the Chefspec matchers

v2.0.3 (2015-10-21)

Validate the hints before loading them to avoid failures
Added supported platforms to the metadata
Updated .gitignore file
Updated Test Kitchen config for the latest platforms
Added Chef standard Rubocop config
Added Travis CI testing
Added Berksfile
Updated contributing and testing docs
Added maintainers.md and maintainers.toml files
Added Travis and cookbook version badges to the readme
Expanded the requirements section in the readme and clarify the minimum supported Chef release is 11
Updated Opscode -> Chef Software
Added a Rakefile for simplified testing
Added a Chefignore file
Resolved Rubocop warnings
Added source_url and issues_url to the metadata
Added Chefspec matchers
Added basic convergence Chefspec test

v2.0.1 (2014-06-07)

[COOK-4683] Remove warnings about reopening resource

Please note, this changes the name of a remote_directory resource. It is not expected that anyone would be explicitly notifying this resource but, please review PR #16 for more info.

v2.0.0 (2014-02-25)

'[COOK-3865] - create lwrp ohai_hint'

v1.1.12

Dummy release due to a Community Site upload failure

v1.1.10

Bug

COOK-3091 - Fix checking Chef::Config[:config_file]

v1.1.8

[COOK-1918] - Ohai cookbook to distribute plugins fails on windows
[COOK-2096] - Ohai cookbook sets unix-only default path attribute

v1.1.6

[COOK-2057] - distribution from another cookbok fails if ohai attributes are loaded after the other cookbook

v1.1.4

[COOK-1128] - readme update, Replace reference to deprecated chef cookbook with one to chef-client

v1.1.2

[COOK-1424] - prevent plugin_path growth to infinity

v1.1.0

[COOK-1174] - custom_plugins is only conditionally available
[COOK-1383] - allow plugins from other cookbooks

v1.0.2

[COOK-463] ohai cookbook default recipe should only reload plugins if there were updates

Collaborator Number Metric

5.3.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

5.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric

5.3.1 failed this metric

Chef/Deprecations/ResourceUsesOnlyResourceName: Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourceusesonlyresourcename): ohai/resources/hint.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): ohai/resources/hint.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): ohai/resources/plugin.rb: 1

Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations

No Binaries Metric

5.3.1 passed this metric

Testing File Metric

5.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

5.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

The ohai cookbook has been deprecated

ohai (40) Versions 5.3.1 5.3.1 5.3.0 5.2.5 5.2.4 5.2.3 5.2.2 5.2.1 5.2.0 5.1.0 5.0.4 5.0.3 5.0.2 5.0.1 5.0.0 4.2.3 4.2.2 4.2.1 4.2.0 4.1.1 4.1.0 4.0.2 4.0.1 4.0.0 3.0.1 3.0.0 2.1.0 2.0.4 2.0.3 2.0.1 2.0.0 1.1.12 1.1.10 1.1.8 1.1.6 1.1.4 1.1.2 1.1.0 1.0.2 1.0.0 0.9.0 Follow103

ohai Cookbook

Deprecation

Requirements

Platforms

Chef

Cookbooks

Custom Resources

ohai_hint

Resource Properties

Examples

ChefSpec Matchers

ohai_plugin

Resource Properties

examples

ChefSpec Matchers

Maintainers

License

Dependent cookbooks

Contingent cookbooks

ohai Cookbook CHANGELOG

5.3.1 (2022-01-14)

5.3.0 (2019-08-29)

5.2.5 (2018-09-04)

5.2.4 (2018-08-28)

5.2.3 (2018-06-08)

5.2.2 (2018-02-15)

5.2.1 (2018-01-25)

5.2.0 (2017-08-17)

5.1.0 (2017-05-06)

5.0.4 (2017-04-25)

5.0.3 (2017-04-06)

5.0.2 (2017-03-24)

5.0.1 (2017-03-14)

5.0.0 (2017-02-23)

4.2.3 (2016-12-02)

4.2.2 (2016-09-19)

4.2.1 (2016-09-08)

v4.2.0 (2016-07-19)

v4.1.1 (2016-06-16)

v4.1.0 (2016-05-26)

v4.0.2 (2016-05-23)

v4.0.1 (2016-05-19)

v4.0.0 (2016-05-18)

BREAKING CHANGE:

v3.0.1 (2016-03-14)

v3.0.0 (2016-03-14)

v2.1.0 (2016-01-26)

v2.0.4 (2015-10-30)

v2.0.3 (2015-10-21)

v2.0.1 (2014-06-07)

v2.0.0 (2014-02-25)

v1.1.12

v1.1.10

Bug

v1.1.8

v1.1.6

v1.1.4

v1.1.2

v1.1.0

v1.0.2

Collaborator Number Metric 5.3.1 failed this metric Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric 5.3.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

No Binaries Metric 5.3.1 passed this metric

Testing File Metric 5.3.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 5.3.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated January 15, 2022 Created on September 19, 2010

Supported Platforms

License

ohai (40) Versions 5.3.1 Follow103

`ohai_hint`

`ohai_plugin`

Collaborator Number Metric

5.3.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

5.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

No Binaries Metric

5.3.1 passed this metric

Testing File Metric

5.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

5.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number