diff options
| author | Tim Smith <tsmith84@gmail.com> | 2020-10-13 11:51:36 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2020-10-13 11:51:36 -0700 |
| commit | 7101c1afb46335fa71388dbf808aadc27477dc07 (patch) | |
| tree | ef3a6c21caf689afd3a602d44f9bf9268b04b619 /lib/chef/resource | |
| parent | f7845f0f23eeaa30a31670335e2d01b8f82439c1 (diff) | |
| download | chef-7101c1afb46335fa71388dbf808aadc27477dc07.tar.gz | |
Improve example descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource')
| -rw-r--r-- | lib/chef/resource/chef_client_config.rb | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/chef/resource/chef_client_config.rb b/lib/chef/resource/chef_client_config.rb index e23079eea8..f7b16d07a5 100644 --- a/lib/chef/resource/chef_client_config.rb +++ b/lib/chef/resource/chef_client_config.rb @@ -29,6 +29,8 @@ class Chef examples <<~DOC **Bare minimum #{ChefUtils::Dist::Infra::PRODUCT} client.rb**: + The absolute minimum configuration necessary for a node to communicate with the Infra Server is the URL of the Infra Server. All other configuration options either have values at the server side (Policyfiles, Roles, Environments, etc) or have default values determined at client startup. + ```ruby chef_client_config 'Create client.rb' do chef_server_url 'https://chef.example.dmz' @@ -50,6 +52,8 @@ class Chef **Adding additional config content to the client.rb**: + This resource aims to provide common configuration options. Some configuration options are missing and some users may want to use arbitrary Ruby code within their configuration. For this we offer an `additional_config` property that can be used to add any configuration or code to the bottom of the `client.rb` file. Also keep in mind that within the configuration directory is a `client.d` directory where you can stick additional `.rb` files containing configuration options. These can be dropped off using `file` or `template` resources witin your cookbooks as necessary. + ```ruby chef_client_config 'Create client.rb' do chef_server_url 'https://chef.example.dmz' |