dmg_package Resource
This page is generated from the Chef Infra Client source code.To suggest a change, edit the dmg_package.rb file and submit a pull request to the Chef Infra Client repository.
Use the dmg_package resource to install a package from a .dmg file. The resource will retrieve the dmg file from a remote URL, mount it using macOS’ hdidutil
, copy the application (.app directory) to the specified destination (/Applications
), and detach the image using hdiutil
. The dmg file will be stored in the Chef::Config[:file_cache_path]
.
New in Chef Infra Client 14.0.
Syntax
The full syntax for all of the properties that are available to the dmg_package resource is:
dmg_package 'name' do
accept_eula true, false # default value: false
allow_untrusted true, false # default value: false
app String # default value: 'name' unless specified
checksum String
destination String # default value: "/Applications"
dmg_name String # default value: The value passed for the application name.
dmg_passphrase String
file String
headers Hash
owner String, Integer
package_id String
source String
type String # default value: "app"
volumes_dir String # default value: The value passed for the application name.
action Symbol # defaults to :install if not specified
end
where:
dmg_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.accept_eula
,allow_untrusted
,app
,checksum
,destination
,dmg_name
,dmg_passphrase
,file
,headers
,owner
,package_id
,source
,type
, andvolumes_dir
are the properties available to this resource.
Actions
The dmg_package resource has the following actions:
:install
- Installs the application. (default)
Properties
The dmg_package resource has the following properties:
accept_eula
- Ruby Type: true, false | Default Value:
false
Specify whether to accept the EULA. Certain dmg files require acceptance of EULA before mounting.
allow_untrusted
- Ruby Type: true, false | Default Value:
false
Allow installation of packages that do not have trusted certificates.
app
- Ruby Type: String | Default Value:
The resource block's name
The name of the application as it appears in the
/Volumes
directory if it differs from the resource block’s name.
checksum
- Ruby Type: String
The sha256 checksum of the
.dmg
file to download.
destination
- Ruby Type: String | Default Value:
/Applications
The directory to copy the
.app
into.
dmg_name
- Ruby Type: String | Default Value:
The value passed for the application name.
The name of the
.dmg
file if it differs from that of the app, or if the name has spaces.
dmg_passphrase
- Ruby Type: String
Specify a passphrase to be used to decrypt the
.dmg
file during the mount process.
file
- Ruby Type: String
The absolute path to the
.dmg
file on the local system.
headers
- Ruby Type: Hash
Allows custom HTTP headers (like cookies) to be set on the
remote_file
resource.
owner
- Ruby Type: String, Integer
The user that should own the package installation.
package_id
- Ruby Type: String
The package ID that is registered with
pkgutil
when apkg
ormpkg
is installed.
source
- Ruby Type: String
The remote URL that is used to download the
.dmg
file, if specified.
type
- Ruby Type: String | Default Value:
app
Allowed Values:"app", "mpkg", "pkg"
The type of package.
volumes_dir
- Ruby Type: String | Default Value:
The value passed for the application name.
The directory under
/Volumes
where thedmg
is mounted if it differs from the name of the.dmg
file.
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 (theconverge 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 anotifies
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 returntrue
in addition to0
. - A block is executed as Ruby code that must return either
true
orfalse
. If the block returnstrue
, the guard property is applied. If the block returnsfalse
, 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.
PropertiesThe 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 dmg_package resource in recipes:
Install Google Chrome via the DMG package:
dmg_package 'Google Chrome' do
dmg_name 'googlechrome'
source 'https://dl-ssl.google.com/chrome/mac/stable/GGRM/googlechrome.dmg'
checksum '7daa2dc5c46d9bfb14f1d7ff4b33884325e5e63e694810adc58f14795165c91a'
action :install
end
Install VirtualBox from the .mpkg:
dmg_package 'Virtualbox' do
source 'http://dlc.sun.com.edgesuite.net/virtualbox/4.0.8/VirtualBox-4.0.8-71778-OSX.dmg'
type 'mpkg'
end
Install pgAdmin and automatically accept the EULA:
dmg_package 'pgAdmin3' do
source 'http://wwwmaster.postgresql.org/redir/198/h/pgadmin3/release/v1.12.3/osx/pgadmin3-1.12.3.dmg'
checksum '9435f79d5b52d0febeddfad392adf82db9df159196f496c1ab139a6957242ce9'
accept_eula true
end