diff options
author | Tim Smith <tsmith@chef.io> | 2020-10-15 17:30:07 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-15 17:30:07 -0700 |
commit | 7ff05d87654f5661a107b0473f24c963843b732e (patch) | |
tree | b80dad8051d9af552186a7ffba8cc8cc5883fc57 /lib/chef | |
parent | 74c527a3f6e63dc127d9ff023b07458378bac14f (diff) | |
parent | 789f072384e1b2416fd3a6ddd17e411cc7529d84 (diff) | |
download | chef-7ff05d87654f5661a107b0473f24c963843b732e.tar.gz |
Merge pull request #10510 from chef/more_resource_docs
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef')
-rw-r--r-- | lib/chef/resource/breakpoint.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/execute.rb | 6 |
2 files changed, 6 insertions, 4 deletions
diff --git a/lib/chef/resource/breakpoint.rb b/lib/chef/resource/breakpoint.rb index d73a82a6e8..50e2d06391 100644 --- a/lib/chef/resource/breakpoint.rb +++ b/lib/chef/resource/breakpoint.rb @@ -49,6 +49,8 @@ class Chef **The same recipe with breakpoints** + In the following example, the name of each breakpoint is an arbitrary string. + ```ruby breakpoint "before yum_key node['yum']['repo_name']['key']" do action :break @@ -81,7 +83,7 @@ class Chef end ``` - where the name of each breakpoint is an arbitrary string. In the previous examples, the names are used to indicate if the breakpoint is before or after a resource, and then also to specify which resource. + In the previous examples, the names are used to indicate if the breakpoint is before or after a resource and also to specify which resource it is before or after. DOC default_action :break diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb index 11d1c2fc40..db6b84dfda 100644 --- a/lib/chef/resource/execute.rb +++ b/lib/chef/resource/execute.rb @@ -549,11 +549,11 @@ class Chef desired_state: false property :user, [ String, Integer ], - description: "The user name of the user identity with which to launch the new process. The user name may optionally be specified with a domain, i.e. domainuser or user@my.dns.domain.com via Universal Principal Name (UPN)format. It can also be specified without a domain simply as user if the domain is instead specified using the domain property. On Windows only, if this property is specified, the password property must be specified." + description: "The user name of the user identity with which to launch the new process. The user name may optionally be specified with a domain, i.e. `domainuser` or `user@my.dns.domain.com` via Universal Principal Name (UPN)format. It can also be specified without a domain simply as user if the domain is instead specified using the domain property. On Windows only, if this property is specified, the password property must be specified." property :domain, String, introduced: "12.21", - description: "Windows only: The domain of the user user specified by the user property. If not specified, the user name and password specified by the user and password properties will be used to resolve that user against the domain in which the system running #{ChefUtils::Dist::Infra::PRODUCT} is joined, or if that system is not joined to a domain it will resolve the user as a local account on that system. An alternative way to specify the domain is to leave this property unspecified and specify the domain as part of the user property." + description: "Windows only: The domain of the user user specified by the user property. If not specified, the username and password specified by the `user` and `password` properties will be used to resolve that user against the domain in which the system running #{ChefUtils::Dist::Infra::PRODUCT} is joined, or if that system is not joined to a domain it will resolve the user as a local account on that system. An alternative way to specify the domain is to leave this property unspecified and specify the domain as part of the user property." property :password, String, sensitive: true, introduced: "12.21", @@ -565,7 +565,7 @@ class Chef default: lazy { password ? true : false }, default_description: "True if the password property is set. False otherwise." property :elevated, [ TrueClass, FalseClass ], default: false, - description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running #{ChefUtils::Dist::Infra::CLIENT} needs the 'Replace a process level token' and 'Adjust Memory Quotas for a process' permissions. The user that is running the command needs the 'Log on as a batch job' permission.\nBecause this requires a login, the user and password properties are required.", + description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) from interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running #{ChefUtils::Dist::Infra::CLIENT} needs the 'Replace a process level token' and 'Adjust Memory Quotas for a process' permissions. The user that is running the command needs the 'Log on as a batch job' permission.\nBecause this requires a login, the user and password properties are required.", introduced: "13.3" property :input, [String], |