chocolatey_source resource¶
Use the chocolatey_source resource to add or remove Chocolatey sources.
New in Chef Client 14.3.
Syntax¶
The chocolatey_source resource has the following syntax:
chocolatey_source 'name' do
bypass_proxy true, false # default value: false
priority Integer # default value: 0
source String
source_name String # default value: 'name' unless specified
action Symbol # defaults to :add if not specified
end
where:
chocolatey_source
is the resource.name
is the name given to the resource block.action
identifies which steps the chef-client will take to bring the node into the desired state.bypass_proxy
,priority
,source
, andsource_name
are the properties available to this resource.
Actions¶
The chocolatey_source resource has the following actions:
:add
- Default. Adds a Chocolatey source.
:remove
- Removes a Chocolatey source.
: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¶
The chocolatey_source resource has the following properties:
bypass_proxy
Ruby Type: true, false | Default Value:
false
Whether or not to bypass the system’s proxy settings to access the source.
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.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
priority
Ruby Type: Integer | Default Value:
0
The priority level of the source.
source
Ruby Type: String
The source URL.
source_name
Ruby Type: String | Default Value:
'name'
The name of the source to add. The resource’s name will be used if this isn’t provided.
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 thenginx
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 examplenginx
) 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