Use the easy_install_package resource to manage packages for the Python platform.
Note
In many cases, it is better to use the package resource instead of this one. This is because when the package resource is used in a recipe, the chef-client will use details that are collected by Ohai at the start of the chef-client run to determine the correct package application. Using the package resource allows a recipe to be authored in a way that allows it to be used across many platforms.
A easy_install_package resource block manages a package on a node, typically by installing it. The simplest use of the easy_install_package resource is:
easy_install_package 'package_name'
which will install the named package using all of the default options and the default action (:install
).
The full syntax for all of the properties that are available to the easy_install_package resource is:
easy_install_package 'name' do easy_install_binary String module_name String notifies # see description options String package_name String, Array # defaults to 'name' if not specified provider Chef::Provider::Package::EasyInstall python_binary String source String subscribes # see description timeout String, Integer version String, Array action Symbol # defaults to :install if not specified end
where
easy_install_package
tells the chef-client to manage a package'name'
is the name of the package:action
identifies which steps the chef-client will take to bring the node into the desired stateeasy_install_binary
, module_name
, options
, package_name
, provider
, python_binary
, source
, timeout
, and version
are properties of this resource, with the Ruby type shown. See “Properties” section below for more information about all of the properties that may be used with this resource.This resource has the following actions:
:install
:nothing
:purge
:remove
:upgrade
This resource has the following properties:
easy_install_binary
Ruby Type: String
The location of the Easy Install binary.
ignore_failure
Ruby Types: TrueClass, FalseClass
Continue running a recipe if a resource fails for any reason. Default value: false
.
module_name
Ruby Type: String
The name of the module.
notifies
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may notify another resource to take action when its state changes. Specify a 'resource[name]'
, the :action
that resource should take, and then the :timer
for that action. A resource may notifiy more than one resource; use a notifies
statement for each resource to be notified.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for notifies
is:
notifies :action, 'resource[name]', :timer
options
Ruby Type: String
One (or more) additional options that are passed to the command.
package_name
Ruby Types: String, Array
The name of the package. Default value: the name
of the resource block See “Syntax” section above for more information.
provider
Ruby Type: Chef Class
Optional. Explicitly specifies a provider. See “Providers” section below for more information.
python_binary
Ruby Type: String
The location of the Python binary.
retries
Ruby Type: Integer
The number of times to catch exceptions and retry the resource. Default value: 0
.
retry_delay
Ruby Type: Integer
The retry delay (in seconds). Default value: 2
.
subscribes
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]'
, the :action
to be taken, and then the :timer
for that action.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for subscribes
is:
subscribes :action, 'resource[name]', :timer
source
Ruby Type: String
Optional. The path to a package in the local file system.
timeout
Ruby Types: String, Integer
The amount of time (in seconds) to wait before timing out.
version
Ruby Types: String, Array
The version of a package to be installed or upgraded.
Where a resource represents a piece of the system (and its desired state), a provider defines the steps that are needed to bring that piece of the system from its current state into the desired state.
The chef-client will determine the correct provider based on configuration data collected by Ohai at the start of the chef-client run. This configuration data is then mapped to a platform and an associated list of providers.
Generally, it’s best to let the chef-client choose the provider, and this is (by far) the most common approach. However, in some cases, specifying a provider may be desirable. There are two approaches:
yum_package "foo" do
instead of package "foo" do
, script "foo" do
instead of bash "foo" do
, and so on—when availableprovider
property within the resource block to specify the long name of the provider as a property of a resource. For example: provider Chef::Provider::Long::Name
This resource has the following providers:
Chef::Provider::Package
, package
Chef::Provider::Package::EasyInstall
, easy_install_package
The following examples demonstrate various approaches for using resources in recipes. If you want to see examples of how Chef uses resources in recipes, take a closer look at the cookbooks that Chef authors and maintains: https://github.com/chef-cookbooks.
Install a package
easy_install_package 'name of package' do action :install end
© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs-archive.chef.io/release/12-13/resource_easy_install_package.html