Skip to main content

habitat_package Resource

This page is generated from the Chef Infra Client source code.
To suggest a change, edit the habitat_package.rb file and submit a pull request to the Chef Infra Client repository.

All Infra resources page


Use the habitat_package to install or remove Chef Habitat packages from Habitat Builder.

New in Chef Infra Client 17.3.

Syntax


The full syntax for all of the properties that are available to the habitat_package resource is:

habitat_package 'name' do
  auth_token        String
  binlink           true, false, force # default value: false
  bldr_url          String # default value: "https://bldr.habitat.sh"
  channel           String # default value: "stable"
  exclude           String
  keep_latest       String
  no_deps           true, false # default value: false
  options           String
  package_name      String, Array
  source            String
  timeout           String, Integer
  version           String, Array
  action            Symbol # defaults to :install if not specified
end

where:

  • habitat_package is the resource.
  • name is the name given to the resource block.
  • action identifies which steps Chef Infra Client will take to bring the node into the desired state.
  • auth_token, binlink, bldr_url, channel, exclude, keep_latest, no_deps, options, package_name, source, timeout, and version are the properties available to this resource.

Actions


The habitat_package resource has the following actions:

:install
Install a package. If a version is specified, install the specified version of the package. (default)
:nothing
This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of a Chef Infra Client run.
:purge
Purge a package. This action typically removes the configuration files as well as the package.
:reconfig
Change the installed package
:remove
Remove a package.
:upgrade
Install a package and ensure that a package is the latest version.

Properties


The habitat_package resource has the following properties:

auth_token
Ruby Type: String

Auth token for installing a package from a private organization on Habitat builder.

binlink
Ruby Type: true, false, force | Default Value: false

If habitat should attempt to binlink the package. Acceptable values: true, false, :force. Will fail on binlinking if set to true and binary or binlink exists.

bldr_url
Ruby Type: String | Default Value: https://bldr.habitat.sh

The habitat builder url where packages will be downloaded from. Defaults to public Habitat Builder

channel
Ruby Type: String | Default Value: stable

The release channel to install your package from.

exclude
Ruby Type: String

Identifier of one or more packages that should not be uninstalled. (ex: core/redis, core/busybox-static/1.42.2/21120102031201)

keep_latest
Ruby Type: String

Ability to uninstall while retaining a specified version This feature only works in Habitat 1.5.86+.

no_deps
Ruby Type: true, false | Default Value: false

Remove package but retain dependencies.

options
Ruby Type: String

Pass any additional parameters to the habitat package command.

package_name
Ruby Type: String, Array

An optional property to set the package name if it differs from the resource block’s name.

source
Ruby Type: String

The optional path to a package on the local file system.

timeout
Ruby Type: String, Integer

The amount of time (in seconds) to wait before timing out.

version
Ruby Type: String, Array

The version of a package to be installed or upgraded.


Common Resource Functionality


Chef resources include common properties, notifications, and resource guards.

Common Properties

The following properties are common to every resource:

compile_time

Ruby Type: true, false | Default Value: false

Control the phase during which the resource is run on the node. Set to true to run while the resource collection is being built (the compile phase). Set to false to run while Chef Infra Client is configuring the node (the converge phase).

ignore_failure

Ruby Type: true, false, :quiet | Default Value: false

Continue running a recipe if a resource fails for any reason. :quiet will not display the full stack trace and the recipe will continue to run if a resource fails.

retries

Ruby Type: Integer | Default Value: 0

The number of attempts to catch exceptions and retry the resource.

retry_delay

Ruby Type: Integer | Default Value: 2

The delay in seconds between retry attempts.

sensitive

Ruby Type: true, false | Default Value: false

Ensure that sensitive resource data is not logged by Chef Infra Client.

Notifications

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 notify more than one resource; use a notifies statement for each resource to be notified.

If the referenced resource does not exist, an error is raised. In contrast, subscribes will not fail if the source resource is not found.

A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:

:before

Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.

:delayed

Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.

:immediate, :immediately

Specifies that a notification should be run immediately, for each resource notified.

The syntax for notifies is:

notifies :action, 'resource[name]', :timer
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.

Note that subscribes does not apply the specified action to the resource that it listens to - for example:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

In this case the subscribes property reloads the nginx service whenever its certificate file, located under /etc/nginx/ssl/example.crt, is updated. subscribes does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the :reload action for its resource (in this example nginx) when a change is detected.

If the other resource does not exist, the subscription will not raise an error. Contrast this with the stricter semantics of notifies, which will raise an error if the other resource does not exist.

A timer specifies the point during a Chef Infra Client run at which a notification is run. The following timers are available:

:before

Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.

:delayed

Default. Specifies that a notification should be queued up, and then executed at the end of a Chef Infra Client run.

:immediate, :immediately

Specifies that a notification should be run immediately, for each resource notified.

The syntax for subscribes is:

subscribes :action, 'resource[name]', :timer

Guards

A guard property can be used to evaluate the state of a node during the execution phase of a Chef Infra Client run. Based on the results of this evaluation, a guard property is then used to tell Chef Infra Client if it should continue executing a resource. A guard property accepts either a string value or a Ruby block value:

  • A string is executed as a shell command. If the command returns 0, the guard is applied. If the command returns any other value, then the guard property is not applied. String guards in a powershell_script run Windows PowerShell commands and may return true in addition to 0.
  • A block is executed as Ruby code that must return either true or false. If the block returns true, the guard property is applied. If the block returns false, the guard property is not applied.

A guard property is useful for ensuring that a resource is idempotent by allowing that resource to test for the desired state as it is being executed, and then if the desired state is present, for Chef Infra Client to do nothing.

Properties

The following properties can be used to define a guard that is evaluated during the execution phase of a Chef Infra Client run:

not_if

Prevent a resource from executing when the condition returns true.

only_if

Allow a resource to execute only if the condition returns true.

Examples


The following examples demonstrate various approaches for using the habitat_package resource in recipes:

Install core/redis

habitat_package 'core/redis'

Install specific version of a package from the unstable channel

habitat_package 'core/redis' do
  version '3.2.3'
  channel 'unstable'
end

Install a package with specific version and revision

habitat_package 'core/redis' do
  version '3.2.3/20160920131015'
end

Install a package and force linking it’s binary files to the system path

habitat_package 'core/nginx' do
  binlink :force
end

Install a package and link it’s binary files to the system path

habitat_package 'core/nginx' do
  options '--binlink'
end

Remove package and all of it’s versions

habitat_package 'core/nginx'
  action :remove
end

Remove specified version of a package

habitat_package 'core/nginx/3.2.3'
  action :remove
end

Remove package but retain some versions Note: Only available as of Habitat 1.5.86

habitat_package 'core/nginx'
  keep_latest '2'
  action :remove
end
**Remove package but keep dependencies**
habitat_package 'core/nginx'
  no_deps false
  action :remove
end
Edit this page on GitHub

Thank you for your feedback!

×









Search Results