chef 16.11.7 → 17.2.29

data/lib/chef/knife/config_list.rb

@@ -1,139 +0,0 @@
-#
-# Copyright:: Copyright (c) 2018, Noah Kantrowitz
-# 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_relative "../knife"
-
-class Chef
-  class Knife
-    class ConfigList < Knife
-      banner "knife config list (options)"
-
-      TABLE_HEADER ||= [" Profile", "Client", "Key", "Server"].freeze
-
-      deps do
-        require_relative "../workstation_config_loader"
-        require "tty-screen" unless defined?(TTY::Screen)
-        require "tty-table" unless defined?(TTY::Table)
-      end
-
-      option :ignore_knife_rb,
-        short: "-i",
-        long: "--ignore-knife-rb",
-        description: "Ignore the current config.rb/knife.rb configuration.",
-        default: false
-
-      def configure_chef
-        apply_computed_config
-      end
-
-      def run
-        credentials_data = self.class.config_loader.parse_credentials_file
-        if credentials_data.nil? || credentials_data.empty?
-          # Should this just show the ambient knife.rb config as "default" instead?
-          ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
-          exit 1
-        end
-
-        current_profile = self.class.config_loader.credentials_profile(config[:profile])
-        profiles = credentials_data.keys.map do |profile|
-          if config[:ignore_knife_rb]
-            # Don't do any fancy loading nonsense, just the raw data.
-            profile_data = credentials_data[profile]
-            {
-              profile: profile,
-              active: profile == current_profile,
-              client_name: profile_data["client_name"] || profile_data["node_name"],
-              client_key: profile_data["client_key"],
-              server_url: profile_data["chef_server_url"],
-            }
-          else
-            # Fancy loading nonsense so we get what the actual config would be.
-            # Note that this modifies the global config, after this, all bets are
-            # off as to whats in the config.
-            Chef::Config.reset
-            wcl = Chef::WorkstationConfigLoader.new(nil, Chef::Log, profile: profile)
-            wcl.load
-            {
-              profile: profile,
-              active: profile == current_profile,
-              client_name: Chef::Config[:node_name],
-              client_key: Chef::Config[:client_key],
-              server_url: Chef::Config[:chef_server_url],
-            }
-          end
-        end
-
-        # Try to reset the config.
-        unless config[:ignore_knife_rb]
-          Chef::Config.reset
-          apply_computed_config
-        end
-
-        if ui.interchange?
-          # Machine-readable output.
-          ui.output(profiles)
-        else
-          # Table output.
-          ui.output(render_table(profiles))
-        end
-      end
-
-      private
-
-      def render_table(profiles, padding: 1)
-        rows = []
-        # Render the data to a 2D array that will be used for the table.
-        profiles.each do |profile|
-          # Replace the home dir in the client key path with ~.
-          profile[:client_key] = profile[:client_key].to_s.gsub(/^#{Regexp.escape(Dir.home)}/, "~") if profile[:client_key]
-          profile[:profile] = "#{profile[:active] ? "*" : " "}#{profile[:profile]}"
-          rows << profile.values_at(:profile, :client_name, :client_key, :server_url)
-        end
-
-        table = TTY::Table.new(header: TABLE_HEADER, rows: rows)
-
-        # Rotate the table to vertical if the screen width is less than table width.
-        if table.width > TTY::Screen.width
-          table.orientation = :vertical
-          table.rotate
-          # Add a new line after each profile record.
-          table.render do |renderer|
-            renderer.border do
-              separator ->(row) { (row + 1) % TABLE_HEADER.size == 0 }
-            end
-            # Remove the leading space added of the first column.
-            renderer.filter = Proc.new do |val, row_index, col_index|
-              if col_index == 1 || (row_index) % TABLE_HEADER.size == 0
-                val.strip
-              else
-                val
-              end
-            end
-          end
-        else
-          table.render do |renderer|
-            renderer.border do
-              mid "-"
-            end
-            renderer.padding = [0, padding, 0, 0] # pad right with 2 characters
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/chef/knife/config_list_profiles.rb

@@ -1,37 +0,0 @@
-#
-# Copyright:: Copyright (c) 2018, Noah Kantrowitz
-# 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_relative "../knife"
-require_relative "./config_list"
-
-class Chef
-  class Knife
-    class ConfigListProfiles < ConfigList
-
-      # Handle the subclassing (knife doesn't do this :()
-      dependency_loaders.concat(superclass.dependency_loaders)
-
-      banner "knife config list-profiles (options)"
-      category "deprecated"
-
-      def run
-        Chef::Log.warn("knife config list-profiles has been deprecated in favor of knife config list. This will be removed in the major release version!")
-        super
-      end
-    end
-  end
-end

data/lib/chef/knife/config_show.rb

@@ -1,127 +0,0 @@
-#
-# Author:: Vivek Singh (<vsingh@chef.io>)
-# Copyright:: Copyright (c) Chef Software 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_relative "../knife"
-
-class Chef
-  class Knife
-    class ConfigShow < Knife
-      banner "knife config show [OPTION...] (options)\nDisplays the value of Chef::Config[OPTION] (or all config values)"
-
-      option :all,
-        short: "-a",
-        long: "--all",
-        description: "Include options that are not set in the configuration.",
-        default: false
-
-      option :raw,
-        short: "-r",
-        long: "--raw",
-        description: "Display a each value with no formatting.",
-        default: false
-
-      def run
-        if config[:format] == "summary" && !config[:raw]
-          # If using the default, human-readable output, also show which config files are being loaded.
-          # Some of this is a bit hacky since it duplicates
-          wcl = self.class.config_loader
-          if wcl.credentials_found
-            loading_from("credentials", ChefConfig::PathHelper.home(".chef", "credentials"))
-          end
-          if wcl.config_location
-            loading_from("configuration", wcl.config_location)
-          end
-
-          if Chef::Config[:config_d_dir]
-            wcl.find_dot_d(Chef::Config[:config_d_dir]).each do |path|
-              loading_from(".d/ configuration", path)
-            end
-          end
-        end
-
-        # Dump the whole config, including defaults is --all was given.
-        config_data = Chef::Config.save(config[:all])
-        # Two special cases, these are set during knife startup but we don't usually care about them.
-        unless config[:all]
-          config_data.delete(:color)
-          # Only keep these if true, false is much less important because it's the default.
-          config_data.delete(:local_mode) unless config_data[:local_mode]
-          config_data.delete(:enforce_default_paths) unless config_data[:enforce_default_paths]
-          config_data.delete(:enforce_path_sanity) unless config_data[:enforce_path_sanity]
-        end
-
-        # Extract the data to show.
-        output_data = {}
-        if @name_args.empty?
-          output_data = config_data
-        else
-          @name_args.each do |filter|
-            if filter =~ %r{^/(.*)/(i?)$}
-              # It's a regex.
-              filter_re = Regexp.new($1, $2 ? Regexp::IGNORECASE : 0)
-              config_data.each do |key, value|
-                output_data[key] = value if key.to_s&.match?(filter_re)
-              end
-            else
-              # It's a dotted path string.
-              filter_parts = filter.split(".")
-              extract = lambda do |memo, filter_part|
-                memo.is_a?(Hash) ? memo[filter_part.to_sym] : nil
-              end
-              # Check against both config_data and all of the data, so that even
-              # in non-all mode, if you ask for a key that isn't in the non-all
-              # data, it will check against the broader set.
-              output_data[filter] = filter_parts.inject(config_data, &extract) || filter_parts.inject(Chef::Config.save(true), &extract)
-            end
-          end
-        end
-
-        # Fix up some values.
-        output_data.each do |key, value|
-          if value == STDOUT
-            output_data[key] = "STDOUT"
-          elsif value == STDERR
-            output_data[key] = "STDERR"
-          end
-        end
-
-        # Show the data.
-        if config[:raw]
-          output_data.each_value do |value|
-            ui.msg(value)
-          end
-        else
-          ui.output(output_data)
-        end
-      end
-
-      private
-
-      # Display a banner about loading from a config file.
-      #
-      # @api private
-      # @param type_of_file [String] Description of the file for the banner.
-      # @param path [String] Path of the file.
-      # @return [nil]
-      def loading_from(type_of_file, path)
-        path = Pathname.new(path).realpath
-        ui.msg(ui.color("Loading from #{type_of_file} file #{path}", :yellow))
-      end
-    end
-  end
-end

data/lib/chef/knife/config_use.rb

@@ -1,61 +0,0 @@
-#
-# Author:: Vivek Singh (<vsingh@chef.io>)
-# Copyright:: Copyright (c) Chef Software 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_relative "../knife"
-
-class Chef
-  class Knife
-    class ConfigUse < Knife
-      banner "knife config use [PROFILE]"
-
-      deps do
-        require "fileutils" unless defined?(FileUtils)
-      end
-
-      # Disable normal config loading since this shouldn't fail if the profile
-      # doesn't exist of the config is otherwise corrupted.
-      def configure_chef
-        apply_computed_config
-      end
-
-      def run
-        profile = @name_args[0]&.strip
-        if profile.nil? || profile.empty?
-          ui.msg(self.class.config_loader.credentials_profile(config[:profile]))
-        else
-          credentials_data = self.class.config_loader.parse_credentials_file
-          context_file = ChefConfig::PathHelper.home(".chef", "context").freeze
-
-          if credentials_data.nil? || credentials_data.empty?
-            ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
-            exit 1
-          end
-
-          if credentials_data[profile].nil?
-            raise ChefConfig::ConfigurationError, "Profile #{profile} doesn't exist. Please add it to #{self.class.config_loader.credentials_file_path} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles."
-          else
-            # Ensure the .chef/ folder exists.
-            FileUtils.mkdir_p(File.dirname(context_file))
-            IO.write(context_file, "#{profile}\n")
-            ui.msg("Set default profile to #{profile}")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/chef/knife/config_use_profile.rb

@@ -1,47 +0,0 @@
-#
-# Copyright:: Copyright (c) 2018, Noah Kantrowitz
-# 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_relative "../knife"
-require_relative "./config_use"
-
-class Chef
-  class Knife
-    class ConfigUseProfile < ConfigUse
-
-      # Handle the subclassing (knife doesn't do this :()
-      dependency_loaders.concat(superclass.dependency_loaders)
-
-      banner "knife config use-profile PROFILE"
-      category "deprecated"
-
-      def run
-        Chef::Log.warn("knife config use-profile has been deprecated in favor of knife config use. This will be removed in the major release version!")
-
-        credentials_data = self.class.config_loader.parse_credentials_file
-        context_file = ChefConfig::PathHelper.home(".chef", "context").freeze
-        profile = @name_args[0]&.strip
-        if profile.nil? || profile.empty?
-          show_usage
-          ui.fatal("You must specify a profile")
-          exit 1
-        end
-
-        super
-      end
-    end
-  end
-end

data/lib/chef/knife/configure.rb

@@ -1,150 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) Chef Software 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_relative "../knife"
-require "chef-utils/dist" unless defined?(ChefUtils::Dist)
-
-class Chef
-  class Knife
-    class Configure < Knife
-      attr_reader :chef_server, :new_client_name, :admin_client_name, :admin_client_key
-      attr_reader :chef_repo, :new_client_key, :validation_client_name, :validation_key
-
-      deps do
-        require_relative "../util/path_helper"
-        require_relative "client_create"
-        require_relative "user_create"
-        require "ohai" unless defined?(Ohai::System)
-        Chef::Knife::ClientCreate.load_deps
-        Chef::Knife::UserCreate.load_deps
-      end
-
-      banner "knife configure (options)"
-
-      option :repository,
-        short: "-r REPO",
-        long: "--repository REPO",
-        description: "The path to the chef-repo."
-
-      option :initial,
-        short: "-i",
-        long: "--initial",
-        boolean: true,
-        description: "Use to create a API client, typically an administrator client on a freshly-installed server."
-
-      option :admin_client_name,
-        long: "--admin-client-name NAME",
-        description: "The name of the client, typically the name of the admin client."
-
-      option :admin_client_key,
-        long: "--admin-client-key PATH",
-        description: "The path to the private key used by the client, typically a file named admin.pem."
-
-      option :validation_client_name,
-        long: "--validation-client-name NAME",
-        description: "The name of the validation client, typically a client named chef-validator."
-
-      option :validation_key,
-        long: "--validation-key PATH",
-        description: "The path to the validation key used by the client, typically a file named validation.pem."
-
-      def configure_chef
-        # We are just faking out the system so that you can do this without a key specified
-        Chef::Config[:node_name] = "woot"
-        super
-        Chef::Config[:node_name] = nil
-      end
-
-      def run
-        FileUtils.mkdir_p(chef_config_path)
-
-        ask_user_for_config
-
-        confirm("Overwrite #{config_file_path}") if ::File.exist?(config_file_path)
-
-        ::File.open(config_file_path, "w") do |f|
-          f.puts <<~EOH
-            [default]
-            client_name     = '#{new_client_name}'
-            client_key      = '#{new_client_key}'
-            chef_server_url = '#{chef_server}'
-          EOH
-        end
-
-        if config[:initial]
-          ui.msg("Creating initial API user...")
-          Chef::Config[:chef_server_url] = chef_server
-          Chef::Config[:node_name] = admin_client_name
-          Chef::Config[:client_key] = admin_client_key
-          user_create = Chef::Knife::UserCreate.new
-          user_create.name_args = [ new_client_name ]
-          user_create.config[:user_password] = config[:user_password] ||
-            ui.ask("Please enter a password for the new user: ", echo: false)
-          user_create.config[:admin] = true
-          user_create.config[:file] = new_client_key
-          user_create.config[:yes] = true
-          user_create.config[:disable_editing] = true
-          user_create.run
-        else
-          ui.msg("*****")
-          ui.msg("")
-          ui.msg("You must place your client key in:")
-          ui.msg("  #{new_client_key}")
-          ui.msg("Before running commands with Knife")
-          ui.msg("")
-          ui.msg("*****")
-        end
-
-        ui.msg("Knife configuration file written to #{config_file_path}")
-      end
-
-      def ask_user_for_config
-        server_name = guess_servername
-        @chef_server = config[:chef_server_url] || ask_question("Please enter the chef server URL: ", default: "https://#{server_name}/organizations/myorg")
-        if config[:initial]
-          @new_client_name        = config[:node_name] || ask_question("Please enter a name for the new user: ", default: Etc.getlogin)
-          @admin_client_name      = config[:admin_client_name] || ask_question("Please enter the existing admin name: ", default: "admin")
-          @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin's private key: ", default: "#{ChefUtils::Dist::Server::CONF_DIR}/admin.pem")
-          @admin_client_key       = File.expand_path(@admin_client_key)
-        else
-          @new_client_name = config[:node_name] || ask_question("Please enter an existing username or clientname for the API: ", default: Etc.getlogin)
-        end
-
-        @new_client_key = config[:client_key] || File.join(chef_config_path, "#{@new_client_name}.pem")
-        @new_client_key = File.expand_path(@new_client_key)
-      end
-
-      # @return [String] our best guess at what the servername should be using Ohai data and falling back to localhost
-      def guess_servername
-        o = Ohai::System.new
-        o.all_plugins(%w{ os hostname fqdn })
-        o[:fqdn] || o[:machinename] || o[:hostname] || "localhost"
-      end
-
-      # @return [String] the path to the user's .chef directory
-      def chef_config_path
-        @chef_config_path ||= Chef::Util::PathHelper.home(".chef")
-      end
-
-      # @return [String] the full path to the config file (credential file)
-      def config_file_path
-        @config_file_path ||= ::File.expand_path(::File.join(chef_config_path, "credentials"))
-      end
-    end
-  end
-end