Skip to main content

chocolatey_installer Resource

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

All Infra resources page


Use the chocolatey_installer resource to install the Chocolatey package manager. Use the chocolatey_feature resource to customize your install and the chocolatey_package resource to install packages.

New in Chef Infra Client 18.4.

Syntax

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

chocolatey_installer 'name' do
  chocolatey_version      String
  download_url            String
  ignore_proxy            true, false # default value: false
  proxy_password          String
  proxy_url               String
  proxy_user              String
  use_native_unzip        true, false # default value: false
  action                  Symbol # defaults to :install if not specified
end

where:

  • chocolatey_installer 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.
  • chocolatey_version, download_url, ignore_proxy, proxy_password, proxy_url, proxy_user, and use_native_unzip are the properties available to this resource.

Actions

The chocolatey_installer resource has the following actions:

:install
Installs Chocolatey package manager (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.
:uninstall
Uninstall Chocolatey package manager.
:upgrade
Upgrades the Chocolatey package manager.

Properties

The chocolatey_installer resource has the following properties:

chocolatey_version
Ruby Type: String

Specifies a target version of Chocolatey to install. By default, the latest stable version is installed. This will use the value in $env:ChocolateyVersion by default if that environment variable is present. This parameter is ignored if you set download_url.

download_url
Ruby Type: String

The URL to download Chocolatey from. This sets the value of $env:ChocolateyDownloadUrl and causes the installer to choose an alternate download location. If this is not set, this resource downloads Chocolatey from the official Chocolatey community repository. You can set a path to a chocolatey.nupkg file for offline installation.

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

If set, this overrides any configured proxy, proxy environment variables, or parameters. This is enabled if set to a value other than ‘false’ or ‘0’.

proxy_password
Ruby Type: String

The password used to connect to the proxy server with. If set, you must also set proxy_user.

proxy_url
Ruby Type: String

Specifies the proxy URL to use during the download.

proxy_user
Ruby Type: String

The username used to connect to the proxy server with. If set, you must also set proxy_password.

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

If true, this resource uses built-in Windows decompression tools instead of 7zip when unpacking the downloaded NuPkg file. This parameter is ignored in PowerShell 5+ in favour of using the Expand-Archive built-in PowerShell cmdlet directly.

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 chocolatey_installer resource in recipes:

Install Chocolatey

chocolatey_installer 'latest' do
  action :install
end

Uninstall Chocolatey

chocolatey_installer 'Some random verbiage' do
  action :uninstall
end

Install Chocolatey with Parameters

chocolatey_installer 'latest' do
  action :install
  download_url "https://www.contoso.com/foo"
  chocolatey_version '2.12.24'
end
chocolatey_installer 'latest' do
  action :install
  download_url "c:\foooo.nupkg"
  chocolatey_version '2.12.24'
end

Upgrade Chocolatey with Parameters

chocolatey_installer 'latest' do
  action :upgrade
  chocolatey_version '2.12.24'
end
Edit this page on GitHub

Thank you for your feedback!

×









Search Results