homebrew_tap

[edit on GitHub]

Use the homebrew_tap resource to add formula repositories to the Homebrew package manager.

New in Chef Client 14.0.

Syntax

This resource has the following syntax:

homebrew_tap 'name' do
  full                       True, False # default value: 'false'
  homebrew_path              String # default value: '/usr/local/bin/brew'
  notifies                   # see description
  owner                      String # default value: lazy { find_homebrew_username }
  subscribes                 # see description
  tap_name                   String # default value: 'name'
  url                        String
  action                     Symbol # defaults to :tap if not specified
end

where:

  • homebrew_tap is the resource
  • 'name' is the name of the Homebrew formula repository, or the name of the resource block
  • full, homebrew_path, notifies, owner, subscribes, tap_name, and url are the properties available to this resource

Actions

:tap
Default. Add a Homebrew tap.
:untap
Remove a Homebrew tap.
:nothing
Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.

Properties

full

Ruby Type: True, False | Default Value: false

Perform a full clone on the tap, as opposed to a shallow clone.

homebrew_path

Ruby Type: String | Default Value: /usr/local/bin/brew

The path to the Homebrew binary.

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.

A timer specifies the point during the Chef 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 the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for notifies is:

notifies :action, 'resource[name]', :timer
owner

Ruby Type: String | Default Value: lazy { find_homebrew_username }

The owner of the Homebrew installation.

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.

A timer specifies the point during the Chef 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 the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for subscribes is:

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

Ruby Type: String | Default Value: 'name'

The name of the Homebrew tap, if it differs from the resource block name. Homebrew tap names must be in the form of REPO/TAP.

url

Ruby Type: String

The URL of the tap.