diff options
author | Tim Smith <tsmith@chef.io> | 2018-07-13 21:30:46 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-09-25 11:46:16 -0700 |
commit | 3e0e62bef6400ab764cfaa8a2757b90fad92a0f6 (patch) | |
tree | 5ebaa1eb2e3b5346d2a45c2fdd907e27b489d438 | |
parent | 9f9ecd1b31193b617326d9d2bb2115b7af91bd96 (diff) | |
download | chef-3e0e62bef6400ab764cfaa8a2757b90fad92a0f6.tar.gz |
Add some yard / comments
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | lib/chef/knife/bootstrap.rb | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/chef/knife/bootstrap.rb b/lib/chef/knife/bootstrap.rb index 9decacce13..f06a45452a 100644 --- a/lib/chef/knife/bootstrap.rb +++ b/lib/chef/knife/bootstrap.rb @@ -424,6 +424,7 @@ class Chef end end + # make sure policyfile values are set correctly def validate_options! if incomplete_policyfile_options? ui.error("--policy-name and --policy-group must be specified together") @@ -435,6 +436,9 @@ class Chef true end + # setup a Chef::Knife::Ssh object using the passed config options + # + # @return Chef::Knife::Ssh def knife_ssh ssh = Chef::Knife::Ssh.new ssh.ui = ui @@ -452,6 +456,10 @@ class Chef ssh end + # prompt for a password then return a knife ssh object with that password set + # and with ssh_identity_file set to nil + # + # @return Chef::Knife::Ssh def knife_ssh_with_password_auth ssh = knife_ssh ssh.config[:ssh_identity_file] = nil @@ -459,6 +467,8 @@ class Chef ssh end + # build the ssh dommand for bootrapping + # @return String def ssh_command command = render_template |