chef_user Resource
This page is generated from the Chef Infra Client source code.To suggest a change, edit the chef_user.rb file and submit a pull request to the Chef Infra Client repository.
Use the chef_user resource to manage users.
Syntax
The syntax for using the chef_user resource in a recipe is as follows:
chef_user 'value' # see properties section below
...
action :action # see actions section below
end
where:
chef_user
tells Chef Infra Client to use theChef::Provider::ChefUser
provider during a Chef Infra Client runname
is the name of the resource block; when thename
property is not specified as part of a recipe,name
is also the name of the userattribute
is zero (or more) of the properties that are available for this resourceaction
identifies which steps Chef Infra Client will take to bring the node into the desired state
Actions
The chef_user resource has the following actions:
:create
- (default) Use to create a user.
:delete
- Use to delete a user.
: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.
Properties
The chef_user resource has the following properties:
admin
Create a client as an admin client. This is required for any user to access Chef as an administrator.
chef_server
The URL for the Chef Infra Server.
complete
Use to specify if this resource defines a user completely. When
true
, any property not specified by this resource will be reset to default property values.
email
The email address for the user.
external_authentication_uid
…
ignore_failure
- Ruby Type: true, false | Default Value:
false
Continue running a recipe if a resource fails for any reason.
name
The name of the user.
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
output_key_format
Use to specify the format of a public key. Possible values:
pem
,der
, oropenssh
. Default value:openssh
.
output_key_path
Use to specify the path to the location in which a public key will be written.
raw_json
The user as JSON data. For example:
{ "name": "Robert Forster" }
recovery_authentication_enabled
…
source_key
Use to copy a public or private key, but apply a different
format
andpassword
. Use in conjunction withsource_key_pass_phrase
andsource_key_path
.
source_key_pass_phrase
The pass phrase for the public key. Use in conjunction with
source_key
andsource_key_path
.
source_key_path
The path to the public key. Use in conjunction with
source_key
andsource_key_pass_phrase
.
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.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
Examples
This resource does not have any examples.