# # Author:: Lamont Granquist () # Copyright:: Copyright (c) 2015 Opscode, Inc. # License:: Apache License, Version 2.0 # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # require 'chef/node' require 'chef/rest' require 'chef/api_client/registration' require 'chef/api_client' require 'tmpdir' class Chef class Knife class Bootstrap < Knife class ClientBuilder # @return [Hash] knife merged config, typically @config attr_accessor :knife_config # @return [Hash] chef config object attr_accessor :chef_config # @return [Chef::Knife::UI] ui object for output attr_accessor :ui # @param knife_config [Hash] Hash of knife config settings # @param chef_config [Hash] Hash of chef config settings # @param ui [Chef::Knife::UI] UI object for output def initialize(knife_config: {}, chef_config: {}, ui: nil) @knife_config = knife_config @chef_config = chef_config @ui = ui end # Main entry. Prompt the user to clean up any old client or node objects. Then create # the new client, then create the new node. def run sanity_check ui.info("Creating new client for #{node_name}") create_client! ui.info("Creating new node for #{node_name}") create_node! end # Tempfile to use to write newly created client credentials to. # # This method is public so that the knife bootstrapper can read then and pass the value into # the handler for chef vault which needs the client cert we create here. # # We hang onto the tmpdir as an ivar as well so that it will not get GC'd and removed # # @return [String] path to the generated client.pem def client_path @client_path ||= begin @tmpdir = Dir.mktmpdir File.join(@tmpdir, "#{node_name}.pem") end end private # @return [String] node name from the knife_config def node_name knife_config[:chef_node_name] end # @return [String] environment from the knife_config or first_boot_attributes, if none specified by knife_config def environment # prefer environment from cli over environment from first-boot attributes knife_config[:environment] || (first_boot_attributes['chef_environment'] if first_boot_attributes) || chef_config[:environment] end # @return [String] run_list from the knife_config def run_list knife_config[:run_list] end # @return [Hash,Array] Object representation of json first-boot attributes from the knife_config def first_boot_attributes knife_config[:first_boot_attributes] end # @return [String] chef server url from the Chef::Config def chef_server_url chef_config[:chef_server_url] end # Accesses the run_list and coerces it into an Array, changing nils into # the empty Array, and splitting strings representations of run_lists into # Arrays. # # @return [Array] run_list coerced into an array def normalized_run_list case run_list when nil [] when String run_list.split(/\s*,\s*/) when Array run_list end end # Create the client object and save it to the Chef API def create_client! Chef::ApiClient::Registration.new(node_name, client_path, http_api: rest).run end # Create the node object (via the lazy accessor) and save it to the Chef API def create_node! node.save end # Create a new Chef::Node. Supports creating the node with its name, run_list, attributes # and environment. This injects a rest object into the Chef::Node which uses the client key # for authentication so that the client creates the node and therefore we get the acls setup # correctly. # # @return [Chef::Node] new chef node to create def node @node ||= begin node = Chef::Node.new(chef_server_rest: client_rest) node.name(node_name) node.run_list(normalized_run_list) if first_boot_attributes scrubbed_first_boot_attributes = first_boot_attributes.dup scrubbed_first_boot_attributes.delete('chef_environment') unless scrubbed_first_boot_attributes.empty? node.normal_attrs = scrubbed_first_boot_attributes end end node.environment(environment) if environment node end end # Check for the existence of a node and/or client already on the server. If the node # already exists, we must delete it in order to proceed so that we can create a new node # object with the permissions of the new client. There is a use case for creating a new # client and wiring it up to a precreated node object, but we do currently support that. # # We prompt the user about what to do and will fail hard if we do not get confirmation to # delete any prior node/client objects. def sanity_check if resource_exists?("nodes/#{node_name}") ui.confirm("Node #{node_name} exists, overwrite it") rest.delete("nodes/#{node_name}") end if resource_exists?("clients/#{node_name}") ui.confirm("Client #{node_name} exists, overwrite it") rest.delete("clients/#{node_name}") end end # Check if an relative path exists on the chef server # # @param relative_path [String] URI path relative to the chef organization # @return [Boolean] if the relative path exists or returns a 404 def resource_exists?(relative_path) rest.get_rest(relative_path) true rescue Net::HTTPServerException => e raise unless e.response.code == "404" false end # @return [Chef::REST] REST client using the client credentials def client_rest @client_rest ||= Chef::REST.new(chef_server_url, node_name, client_path) end # @return [Chef::REST] REST client using the cli user's knife credentials # this uses the users's credentials def rest @rest ||= Chef::REST.new(chef_server_url) end end end end end