diff options
| author | Tim Smith <tsmith84@gmail.com> | 2020-10-13 15:13:12 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2020-10-13 15:15:07 -0700 |
| commit | 2ab9752d928b5a78b417a8fc5a9b2ba81d08fe55 (patch) | |
| tree | 0a92e927289bdf245b8fe6b1832b25f114c6b090 /lib/chef/resource | |
| parent | 735b2cc7c834812215d6e2ced925d6b64709bf6b (diff) | |
| download | chef-2ab9752d928b5a78b417a8fc5a9b2ba81d08fe55.tar.gz | |
Improve descriptions in chef_client_config
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource')
| -rw-r--r-- | lib/chef/resource/chef_client_config.rb | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/chef/resource/chef_client_config.rb b/lib/chef/resource/chef_client_config.rb index 4a4e8e4b1e..fca51ee3fb 100644 --- a/lib/chef/resource/chef_client_config.rb +++ b/lib/chef/resource/chef_client_config.rb @@ -109,7 +109,8 @@ class Chef property :config_directory, String, description: "The directory to store the client.rb in.", - default: ChefConfig::Config.etc_chef_dir + default: ChefConfig::Config.etc_chef_dir, + default_description: "'/etc/chef/ on *nix-like systems and 'C:\chef' on Windows" property :user, String, description: "The user that should own the client.rb file and the configuration directory if it needs to be created. Note: The configuration directory will not be created if it already exists, which allows you to further control the setup of that directory outside of this resource." @@ -118,9 +119,9 @@ class Chef description: "The group that should own the client.rb file and the configuration directory if it needs to be created. Note: The configuration directory will not be created if it already exists, which allows you to further control the setup of that directory outside of this resource." property :node_name, [String, NilClass], # this accepts nil so people can disable the default - description: "The name of the node. This determines which configuration should be applied and sets the `client_name`, which is the name used when authenticating to a #{ChefUtils::Dist::Server::PRODUCT}. If this value is not provided #{ChefUtils::Dist::Infra::PRODUCT} will use the node's FQDN as the node name. Leaving this setting blank and letting the client assign the FQDN of the node as the node_name during each #{ChefUtils::Dist::Infra::PRODUCT} run is recommended.", + description: "The name of the node. This configuration sets the `node.name` value used in cookbooks and the `client_name` value used when authenticating to a #{ChefUtils::Dist::Server::PRODUCT} to determine what configuration to apply. Note: By default this configuration uses the `node.name` value which would be set during bootstrap. Hard coding this value in the `client.rb` config avoids logic within #{ChefUtils::Dist::Server::PRODUCT} that performs DNS lookups and may fail in the event of a DNS outage. To skip this default value and instead use the built-in #{ChefUtils::Dist::Server::PRODUCT} logic, set this property to `nil`", default: lazy { node.name }, - default_description: "The `node.name` value. Hard coding this value in the client.rb avoids logic within #{ChefUtils::Dist::Server::PRODUCT} that performs DNS lookups and may fail in the event of a DNS outage. To skip this default value and instead use the built-in #{ChefUtils::Dist::Server::PRODUCT} logic, set this property to `nil`" + default_description: "The `node.name` value reported by #{ChefUtils::Dist::Infra::PRODUCT}." property :chef_server_url, String, description: "The URL for the #{ChefUtils::Dist::Server::PRODUCT}.", |