chef 12.0.3-x86-mingw32 → 12.1.0.rc.0-x86-mingw32

data/distro/common/man/man8/chef-solo.8

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "CHEF-SOLO" "8" "Chef 11.16" "" "chef-solo"
+.TH "CHEF-SOLO" "8" "Chef 12.0" "" "chef-solo"
 .SH NAME
 chef-solo \- The man page for the chef-solo command line tool.
 .
@@ -77,13 +77,15 @@ This command has the following options:
 The configuration file to use.
 .TP
 .B \fB\-d\fP, \fB\-\-daemonize\fP
-Use to run the executable as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&.
+Use to run the executable as a daemon.  This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option.
+.sp
+This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&.
 .TP
 .B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP
 The name of the environment.
 .TP
 .B \fB\-f\fP, \fB\-\-[no\-]fork\fP
-Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&.
+Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&. This option may not be used in the same command with the \fB\-\-daemonize\fP and \fB\-\-interval\fP options.
 .TP
 .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
 The output format: \fBdoc\fP (default) or \fBmin\fP\&.
@@ -107,10 +109,81 @@ The name of the group that owns a process. This is required when starting any ex
 Shows help for the command.
 .TP
 .B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
-The frequency (in seconds) at which the chef\-client runs.
+The frequency (in seconds) at which the chef\-client runs. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option.
 .TP
 .B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
-The path to a file that contains JSON data. Use this option to override \fBnormal\fP attributes set elsewhere.
+The path to a file that contains JSON data.
+.sp
+Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+"run_list": [
+  "recipe[base]",
+  "recipe[foo]",
+  "recipe[bar]",
+  "role[webserver]"
+],
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+may be used by running \fBchef\-client \-j path/to/file.json\fP\&.
+.sp
+In certain situations this option may be used to update \fBnormal\fP attributes.
+.sp
+\fBWARNING:\fP
+.INDENT 7.0
+.INDENT 3.5
+Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  "name": "dev\-99",
+  "description": "Install some stuff",
+  "override_attributes": {
+    "apptastic": {
+      "enable_apptastic": "false",
+      "apptastic_tier_name": "dev\-99.bomb.com"
+    }
+  }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+will result in a node object similar to:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  "name": "maybe\-dev\-99",
+  "normal": {
+  "name": "dev\-99",
+    "description": "Install some stuff",
+    "override_attributes": {
+      "apptastic": {
+        "enable_apptastic": "false",
+        "apptastic_tier_name": "dev\-99.bomb.com"
+      }
+    }
+  }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
 .TP
 .B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
 The level of logging that will be stored in a log file.
@@ -134,7 +207,7 @@ The URL location from which a remote cookbook tar.gz will be downloaded.
 The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately.
 .TP
 .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
-A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time.
+A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run.
 .TP
 .B \fB\-u USER\fP, \fB\-\-user USER\fP
 The user that owns a process. This is required when starting any executable as a daemon.

data/distro/common/markdown/man1/knife-bootstrap.mkd

@@ -84,7 +84,7 @@ When this is complete, the bootstrapped node will have:
 
   - Latest Chef version installed from RubyGems or APT Packages from Opscode. This may be a later version than the local system.
   - Be validated with the configured Chef Server.
-  - Have run Chef with its default run list if one is specfied.
+  - Have run Chef with its default run list if one is specified.
 
 Additional custom bootstrap templates can be created and stored in
 `.chef/bootstrap/DISTRO.erb`, replacing __DISTRO__ with the value passed

data/distro/common/markdown/man1/knife-cookbook-site.mkd

@@ -26,7 +26,7 @@ repository. Running `knife cookbook site install` does the following:
    upstream;
 2. All existing cookbooks are removed from the branch;
 3. The cookbook is downloaded from the cookbook site in tarball form;
-4. The downloaded cookbook is untarred, and its contents commited via git;
+4. The downloaded cookbook is untarred, and its contents committed via git;
 5. The pristine copy branch is merged into the master branch.
 
 By installing cookbook with this process, you can locally modify the

data/distro/common/markdown/man1/knife-data-bag.mkd

@@ -90,7 +90,7 @@ formatted according to the --format option.
 
 ## ENCRYPTION SUPPORT
 Data Bag Items may be encrypted to keep their contents secret. This may
-be desireable when storing sensitive information such as database
+be desirable when storing sensitive information such as database
 passwords, API keys, etc.
 
 Data Bag Item encryption uses the AES-256 CBC symmetric key algorithm.

data/distro/common/markdown/man1/knife-environment.mkd

@@ -73,7 +73,7 @@ represented as a single JSON object, like this:
 
     {"apache2": ">= 1.5.0"}
 
-In the Ruby format, the cookbook version contraints for an environment
+In the Ruby format, the cookbook version constraints for an environment
 are represented as a Ruby Hash, like this:
 
     {"apache2" => ">= 1.5.0"}

data/distro/common/markdown/man1/knife.mkd

@@ -174,7 +174,7 @@ recommended though, and git fits with a lot of the workflow paradigms.
 ## ENVIRONMENT
   * `EDITOR`:
     The text editor to use for editing data. The --editor option takes
-    precedence over this value, and the --disable-editing option supresses
+    precedence over this value, and the --disable-editing option suppresses
     data editing entirely.
 
 ## SEE ALSO

data/lib/chef.rb

@@ -32,10 +32,3 @@ require 'chef/run_status'
 require 'chef/handler'
 require 'chef/handler/json_file'
 
-require 'chef/monkey_patches/tempfile'
-require 'chef/monkey_patches/string'
-require 'chef/monkey_patches/numeric'
-require 'chef/monkey_patches/object'
-require 'chef/monkey_patches/file'
-require 'chef/monkey_patches/uri'
-

data/lib/chef/api_client.rb

@@ -96,7 +96,7 @@ class Chef
       set_or_return(
         :private_key,
         arg,
-        :kind_of => String
+        :kind_of => [String, FalseClass]
       )
     end
 
@@ -124,7 +124,7 @@ class Chef
       Chef::JSONCompat.to_json(to_hash, *a)
     end
 
-    def self.json_create(o)
+    def self.from_hash(o)
       client = Chef::ApiClient.new
       client.name(o["name"] || o["clientname"])
       client.private_key(o["private_key"]) if o.key?("private_key")
@@ -134,6 +134,14 @@ class Chef
       client
     end
 
+    def self.json_create(data)
+      from_hash(data)
+    end
+
+    def self.from_json(j)
+      from_hash(Chef::JSONCompat.parse(j))
+    end
+
     def self.http_api
       Chef::REST.new(Chef::Config[:chef_server_url])
     end

data/lib/chef/api_client/registration.rb

@@ -33,9 +33,10 @@ class Chef
       attr_reader :destination
       attr_reader :name
 
-      def initialize(name, destination)
-        @name = name
-        @destination = destination
+      def initialize(name, destination, http_api: nil)
+        @name                         = name
+        @destination                  = destination
+        @http_api                     = http_api
         @server_generated_private_key = nil
       end
 
@@ -120,11 +121,10 @@ class Chef
         post_data
       end
 
-
       def http_api
-        @http_api_as_validator ||= Chef::REST.new(Chef::Config[:chef_server_url],
-                                                  Chef::Config[:validation_client_name],
-                                                  Chef::Config[:validation_key])
+        @http_api ||= Chef::REST.new(Chef::Config[:chef_server_url],
+                                     Chef::Config[:validation_client_name],
+                                     Chef::Config[:validation_key])
       end
 
       # Whether or not to generate keys locally and post the public key to the
@@ -161,5 +161,3 @@ class Chef
     end
   end
 end
-
-

data/lib/chef/application.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 
 require 'pp'
+require 'uri'
 require 'socket'
 require 'chef/config'
 require 'chef/config_fetcher'
@@ -48,6 +49,7 @@ class Chef
       configure_logging
       configure_proxy_environment_variables
       configure_encoding
+      emit_warnings
     end
 
     # Get this party started
@@ -102,6 +104,12 @@ class Chef
       Chef::Config.merge!(config)
     end
 
+    def set_specific_recipes
+      Chef::Config[:specific_recipes] =
+        cli_arguments.map { |file| File.expand_path(file) } if
+        cli_arguments.respond_to?(:map)
+    end
+
     # Initialize and configure the logger.
     # === Loggers and Formatters
     # In Chef 10.x and previous, the Logger was the primary/only way that Chef
@@ -198,16 +206,18 @@ class Chef
 
     # Initializes Chef::Client instance and runs it
     def run_chef_client(specific_recipes = [])
+      unless specific_recipes.respond_to?(:size)
+        raise ArgumentError, 'received non-Array like specific_recipes argument'
+      end
+
       Chef::LocalMode.with_server_connectivity do
         override_runlist = config[:override_runlist]
-        if specific_recipes.size > 0
-          override_runlist ||= []
-        end
+        override_runlist ||= [] if specific_recipes.size > 0
         @chef_client = Chef::Client.new(
           @chef_client_json,
-          :override_runlist => config[:override_runlist],
-          :specific_recipes => specific_recipes,
-          :runlist => config[:runlist]
+          override_runlist: override_runlist,
+          specific_recipes: specific_recipes,
+          runlist: config[:runlist]
         )
         @chef_client_json = nil
 
@@ -226,7 +236,7 @@ class Chef
     private
     def can_fork?
       # win32-process gem exposes some form of :fork for Process
-      # class. So we are seperately ensuring that the platform we're
+      # class. So we are separately ensuring that the platform we're
       # running on is not windows before forking.
       Chef::Config[:client_fork] && Process.respond_to?(:fork) && !Chef::Platform.windows?
     end
@@ -237,7 +247,7 @@ class Chef
       # Override the TERM signal.
       trap('TERM') do
         Chef::Log.debug("SIGTERM received during converge," +
-                        " finishing converge to exit normally (send SIGINT to terminate immediately)")
+          " finishing converge to exit normally (send SIGINT to terminate immediately)")
       end
 
       @chef_client.run
@@ -251,7 +261,7 @@ class Chef
         # TERM singal is received (exit gracefully)
         trap('TERM') do
           Chef::Log.debug("SIGTERM received during converge," +
-                          " finishing converge to exit normally (send SIGINT to terminate immediately)")
+            " finishing converge to exit normally (send SIGINT to terminate immediately)")
         end
 
         client_solo = Chef::Config[:solo] ? "chef-solo" : "chef-client"
@@ -297,7 +307,7 @@ class Chef
     def configure_http_proxy
       if http_proxy = Chef::Config[:http_proxy]
         http_proxy_string = configure_proxy("http", http_proxy,
-                                            Chef::Config[:http_proxy_user], Chef::Config[:http_proxy_pass])
+          Chef::Config[:http_proxy_user], Chef::Config[:http_proxy_pass])
         env['http_proxy'] = http_proxy_string unless env['http_proxy']
         env['HTTP_PROXY'] = http_proxy_string unless env['HTTP_PROXY']
       end
@@ -307,7 +317,7 @@ class Chef
     def configure_https_proxy
       if https_proxy = Chef::Config[:https_proxy]
         https_proxy_string = configure_proxy("https", https_proxy,
-                                             Chef::Config[:https_proxy_user], Chef::Config[:https_proxy_pass])
+          Chef::Config[:https_proxy_user], Chef::Config[:https_proxy_pass])
         env['https_proxy'] = https_proxy_string unless env['https_proxy']
         env['HTTPS_PROXY'] = https_proxy_string unless env['HTTPS_PROXY']
       end
@@ -317,7 +327,7 @@ class Chef
     def configure_ftp_proxy
       if ftp_proxy = Chef::Config[:ftp_proxy]
         ftp_proxy_string = configure_proxy("ftp", ftp_proxy,
-                                           Chef::Config[:ftp_proxy_user], Chef::Config[:ftp_proxy_pass])
+          Chef::Config[:ftp_proxy_user], Chef::Config[:ftp_proxy_pass])
         env['ftp_proxy'] = ftp_proxy_string unless env['ftp_proxy']
         env['FTP_PROXY'] = ftp_proxy_string unless env['FTP_PROXY']
       end
@@ -371,6 +381,12 @@ class Chef
       ENV
     end
 
+    def emit_warnings
+      if Chef::Config[:chef_gem_compile_time]
+        Chef::Log.deprecation "setting chef_gem_compile_time to true is deprecated"
+      end
+    end
+
     class << self
       def debug_stacktrace(e)
         message = "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"

data/lib/chef/application/apply.rb

@@ -43,6 +43,12 @@ class Chef::Application::Apply < Chef::Application
     :description  => "Execute resources read from STDIN",
     :boolean      => true
 
+  option :json_attribs,
+    :short => "-j JSON_ATTRIBS",
+    :long => "--json-attributes JSON_ATTRIBS",
+    :description => "Load attributes from a JSON file or URL",
+    :proc => nil
+
   option :log_level,
     :short        => "-l LEVEL",
     :long         => "--log_level LEVEL",
@@ -79,6 +85,8 @@ class Chef::Application::Apply < Chef::Application
     :default      => !Chef::Platform.windows?,
     :description  => "Use colored output, defaults to enabled"
 
+  attr_reader :json_attribs
+
   def initialize
     super
   end
@@ -88,6 +96,14 @@ class Chef::Application::Apply < Chef::Application
     Chef::Config.merge!(config)
     configure_logging
     configure_proxy_environment_variables
+    parse_json
+  end
+
+  def parse_json
+    if Chef::Config[:json_attribs]
+      config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
+      @json_attribs = config_fetcher.fetch_json
+    end
   end
 
   def read_recipe_file(file_name)
@@ -106,7 +122,7 @@ class Chef::Application::Apply < Chef::Application
 
   def get_recipe_and_run_context
     Chef::Config[:solo] = true
-    @chef_client = Chef::Client.new
+    @chef_client = Chef::Client.new(@json_attribs)
     @chef_client.run_ohai
     @chef_client.load_node
     @chef_client.build_node

data/lib/chef/application/client.rb

@@ -27,6 +27,7 @@ require 'chef/handler/error_report'
 require 'chef/workstation_config_loader'
 
 class Chef::Application::Client < Chef::Application
+  include Chef::Mixin::ShellOut
 
   # Mimic self_pipe sleep from Unicorn to capture signals safely
   SELF_PIPE = []
@@ -63,7 +64,7 @@ class Chef::Application::Client < Chef::Application
   option :log_level,
     :short        => "-l LEVEL",
     :long         => "--log_level LEVEL",
-    :description  => "Set the log level (debug, info, warn, error, fatal)",
+    :description  => "Set the log level (auto, debug, info, warn, error, fatal)",
     :proc         => lambda { |l| l.to_sym }
 
   option :log_location,
@@ -104,7 +105,12 @@ class Chef::Application::Client < Chef::Application
   option :pid_file,
     :short        => "-P PID_FILE",
     :long         => "--pid PIDFILE",
-    :description  => "Set the PID file location, defaults to /tmp/chef-client.pid",
+    :description  => "Set the PID file location, for the chef-client daemon process. Defaults to /tmp/chef-client.pid",
+    :proc         => nil
+
+  option :lockfile,
+    :long         => "--lockfile LOCKFILE",
+    :description  => "Set the lockfile location. Prevents multiple client processes from converging at the same time",
     :proc         => nil
 
   option :interval,
@@ -200,6 +206,10 @@ class Chef::Application::Client < Chef::Application
     :description  => "Fork client",
     :boolean      => true
 
+  option :recipe_url,
+    :long         => "--recipe-url=RECIPE_URL",
+    :description  => "Pull down a remote archive of recipes and unpack it to the cookbook cache. Only used in local mode."
+
   option :enable_reporting,
     :short        => "-R",
     :long         => "--enable-reporting",
@@ -239,9 +249,9 @@ class Chef::Application::Client < Chef::Application
   end
 
   option :audit_mode,
-    :long           => "--[no-]audit-mode",
-    :description    => "If not specified, run converge and audit phase.  If true, run only audit phase.  If false, run only converge phase.",
-    :boolean        => true
+    :long           => "--audit-mode MODE",
+    :description    => "Enable audit-mode with `enabled`. Disable audit-mode with `disabled`. Skip converge and only perform audits with `audit-only`",
+    :proc           => lambda { |mo| mo.gsub("-", "_").to_sym }
 
   IMMEDIATE_RUN_SIGNAL = "1".freeze
 
@@ -252,7 +262,9 @@ class Chef::Application::Client < Chef::Application
   def reconfigure
     super
 
-    Chef::Config[:specific_recipes] = cli_arguments.map { |file| File.expand_path(file) }
+    raise Chef::Exceptions::PIDFileLockfileMatch if Chef::Util::PathHelper.paths_eql? (Chef::Config[:pid_file] || '' ), (Chef::Config[:lockfile] || '')
+
+    set_specific_recipes
 
     Chef::Config[:chef_server_url] = config[:chef_server_url] if config.has_key? :chef_server_url
 
@@ -260,6 +272,18 @@ class Chef::Application::Client < Chef::Application
     if Chef::Config.local_mode && !Chef::Config.has_key?(:cookbook_path) && !Chef::Config.has_key?(:chef_repo_path)
       Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
     end
+
+    if !Chef::Config.local_mode && Chef::Config.has_key?(:recipe_url)
+      Chef::Application.fatal!("chef-client recipe-url can be used only in local-mode", 1)
+    elsif Chef::Config.local_mode && Chef::Config.has_key?(:recipe_url)
+      Chef::Log.debug "Creating path #{Chef::Config.chef_repo_path} to extract recipes into"
+      FileUtils.mkdir_p(Chef::Config.chef_repo_path)
+      tarball_path = File.join(Chef::Config.chef_repo_path, 'recipes.tgz')
+      fetch_recipe_tarball(Chef::Config[:recipe_url], tarball_path)
+      result = shell_out!("tar zxvf #{tarball_path} -C #{Chef::Config.chef_repo_path}")
+      Chef::Log.debug "#{result.stdout}"
+    end
+
     Chef::Config.chef_zero.host = config[:chef_zero_host] if config[:chef_zero_host]
     Chef::Config.chef_zero.port = config[:chef_zero_port] if config[:chef_zero_port]
 
@@ -280,6 +304,19 @@ class Chef::Application::Client < Chef::Application
       config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
       @chef_client_json = config_fetcher.fetch_json
     end
+
+    if mode = config[:audit_mode] || Chef::Config[:audit_mode]
+      expected_modes = [:enabled, :disabled, :audit_only]
+      unless expected_modes.include?(mode)
+        Chef::Application.fatal!(unrecognized_audit_mode(mode))
+      end
+
+      unless mode == :disabled
+        # This should be removed when audit-mode is enabled by default/no longer
+        # an experimental feature.
+        Chef::Log.warn(audit_mode_experimental_message)
+      end
+    end
   end
 
   def load_config_file
@@ -400,4 +437,35 @@ class Chef::Application::Client < Chef::Application
     "#{"\n  interval  = #{Chef::Config[:interval]} seconds" if Chef::Config[:interval]}" +
     "\nEnable chef-client interval runs by setting `:client_fork = true` in your config file or adding `--fork` to your command line options."
   end
+
+  def audit_mode_settings_explaination
+    "\n* To enable audit mode after converge, use command line option `--audit-mode enabled` or set `:audit_mode = :enabled` in your config file." +
+    "\n* To disable audit mode, use command line option `--audit-mode disabled` or set `:audit_mode = :disabled` in your config file." +
+    "\n* To only run audit mode, use command line option `--audit-mode audit-only` or set `:audit_mode = :audit_only` in your config file." +
+    "\nAudit mode is disabled by default."
+  end
+
+  def unrecognized_audit_mode(mode)
+    "Unrecognized setting #{mode} for audit mode." + audit_mode_settings_explaination
+  end
+
+  def audit_mode_experimental_message
+    msg = if Chef::Config[:audit_mode] == :audit_only
+      "Chef-client has been configured to skip converge and run only audits."
+    else
+      "Chef-client has been configured to run audits after it converges."
+    end
+    msg += " Audit mode is an experimental feature currently under development. API changes may occur. Use at your own risk."
+    msg += audit_mode_settings_explaination
+    return msg
+  end
+
+  def fetch_recipe_tarball(url, path)
+    Chef::Log.debug("Download recipes tarball from #{url} to #{path}")
+    File.open(path, 'wb') do |f|
+      open(url) do |r|
+        f.write(r.read)
+      end
+    end
+  end
 end