chef 14.6.47-universal-mingw32 → 14.7.17-universal-mingw32

data/lib/chef/resource/group.rb

@@ -36,7 +36,7 @@ class Chef
 
       property :members, [String, Array], default: lazy { [] },
                coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
-               description: "Which users should be set or appended to a group. This can be either an array or a comma separated list."
+               description: "Which users should be set or appended to a group. When more than one group member is identified, the list of members should be an array: members ['user1', 'user2']."
 
       property :excluded_members, [String, Array], default: lazy { [] },
                coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
@@ -46,7 +46,7 @@ class Chef
                description: "How members should be appended and/or removed from a group. When true, members are appended and excluded_members are removed. When false, group members are reset to the value of the members property."
 
       property :system, [ TrueClass, FalseClass ], default: false,
-               description: "Sets the group to belong to the system group."
+               description: "Set if a group belongs to a system group. Set to true if the group belongs to a system group."
 
       property :non_unique, [ TrueClass, FalseClass ], default: false,
                description: "Allow gid duplication. May only be used with the Groupadd provider."

data/lib/chef/resource/homebrew_cask.rb

@@ -34,10 +34,11 @@ class Chef
       property :cask_name, String,
                description: "The name of the Homebrew cask, if it differs from the resource block name.",
                regex: %r{^[\w/-]+$},
+               validation_message: "The provided Homebrew cask name is not valid. Cask names can contain alphanumeric characters, _, -, or / only!",
                name_property: true
 
       property :options, String,
-               description: "Options to pass to the brew CLI during installation."
+               description: "Options to pass to the brew command during installation."
 
       property :install_cask, [TrueClass, FalseClass],
                description: "Automatically install the Homebrew cask tap, if necessary.",
@@ -48,7 +49,7 @@ class Chef
                default: "/usr/local/bin/brew"
 
       property :owner, String,
-               description: "The owner of the homebrew installation.",
+               description: "The owner of the Homebrew installation.",
                default: lazy { find_homebrew_username }
 
       action :install do

data/lib/chef/resource/homebrew_tap.rb

@@ -33,12 +33,12 @@ class Chef
 
       property :tap_name, String,
                description: "Optional tap name to override the resource name",
-               validation_message: "Homebrew tap names must be in the form REPO/TAP",
+               validation_message: "Homebrew tap names must be in the form REPO/TAP format!",
                regex: %r{^[\w-]+(?:\/[\w-]+)+$},
                name_property: true
 
       property :url, String,
-               description: "URL to the tap."
+               description: "The URL of the tap."
 
       property :full, [TrueClass, FalseClass],
                description: "Perform a full clone on the tap, as opposed to a shallow clone.",

data/lib/chef/resource/hostname.rb

@@ -27,12 +27,12 @@ class Chef
       introduced "14.0"
 
       property :hostname, String,
-               description: "Used to specify the hostname if it is different than the resource’s name.",
+               description: "Used to specify the hostname if it is different than the resource's name.",
                name_property: true
 
       property :compile_time, [ TrueClass, FalseClass ],
                description: "Determines whether or not the resource shoul be run at compile time.",
-               default: true
+               default: true, desired_state: false
 
       property :ipaddress, String,
                description: "The IP address to use when configuring the hosts file.",

data/lib/chef/resource/kernel_module.rb

@@ -41,12 +41,14 @@ class Chef
 
         file "#{new_resource.load_dir}/#{new_resource.modname}.conf" do
           content "#{new_resource.modname}\n"
-          notifies :run, "execute[update initramfs]"
+          notifies :run, "execute[update initramfs]", :delayed
         end
 
-        execute "update initramfs" do
-          command initramfs_command
-          action :nothing
+        with_run_context :root do
+          find_resource(:execute, "update initramfs") do
+            command initramfs_command
+            action :nothing
+          end
         end
       end
 
@@ -55,17 +57,19 @@ class Chef
 
         file "#{new_resource.load_dir}/#{new_resource.modname}.conf" do
           action :delete
-          notifies :run, "execute[update initramfs]"
+          notifies :run, "execute[update initramfs]", :delayed
         end
 
         file "#{new_resource.unload_dir}/blacklist_#{new_resource.modname}.conf" do
           action :delete
-          notifies :run, "execute[update initramfs]"
+          notifies :run, "execute[update initramfs]", :delayed
         end
 
-        execute "update initramfs" do
-          command initramfs_command
-          action :nothing
+        with_run_context :root do
+          find_resource(:execute, "update initramfs") do
+            command initramfs_command
+            action :nothing
+          end
         end
 
         new_resource.run_action(:unload)
@@ -76,12 +80,14 @@ class Chef
 
         file "#{new_resource.unload_dir}/blacklist_#{new_resource.modname}.conf" do
           content "blacklist #{new_resource.modname}"
-          notifies :run, "execute[update initramfs]"
+          notifies :run, "execute[update initramfs]", :delayed
         end
 
-        execute "update initramfs" do
-          command initramfs_command
-          action :nothing
+        with_run_context :root do
+          find_resource(:execute, "update initramfs") do
+            command initramfs_command
+            action :nothing
+          end
         end
 
         new_resource.run_action(:unload)

data/lib/chef/resource/locale.rb

@@ -29,6 +29,7 @@ class Chef
       property :lang, String,
                default: "en_US.utf8",
                description: "Sets the default system language."
+
       property :lc_all, String,
                default: "en_US.utf8",
                description: "Sets the fallback system language."

data/lib/chef/resource/macos_userdefaults.rb

@@ -29,11 +29,11 @@ class Chef
       introduced "14.0"
 
       property :domain, String,
-               description: "The domain the defaults belong to.",
+               description: "The domain that the user defaults belong to.",
                required: true
 
       property :global, [TrueClass, FalseClass],
-               description: "Whether the domain is global.",
+               description: "Determines whether or not the domain is global.",
                default: false
 
       property :key, String,
@@ -44,21 +44,22 @@ class Chef
                required: true
 
       property :type, String,
-               description: "Value type of the preference key.",
+               description: "The value type of the preference key.",
                default: ""
 
       property :user, String,
-               description: "User for which to set the default."
+               description: "The system user that the default will be applied to."
 
       property :sudo, [TrueClass, FalseClass],
-               description: "Set to true if the setting requires privileged access to modify.",
+               description: "Set to true if the setting you wish to modify requires privileged access.",
                default: false,
                desired_state: false
 
       # @todo this should get refactored away: https://github.com/chef/chef/issues/7622
       property :is_set, [TrueClass, FalseClass],
                default: false,
-               desired_state: false
+               desired_state: false,
+               skip_docs: true
 
        # coerce various ways of representing a boolean into either 0 (false) or 1 (true)
        # which is what the defaults CLI expects. Why? Well defaults itself accepts a few

data/lib/chef/resource/mdadm.rb

@@ -40,9 +40,10 @@ class Chef
                default: lazy { [] },
                description: "The devices to be part of a RAID array."
 
+      # @todo this should get refactored away
       property :exists, [ TrueClass, FalseClass ],
                default: false,
-               description: "Indicates whether the RAID array exists."
+               skip_docs: true
 
       property :level, Integer,
                default: 1,
@@ -57,7 +58,7 @@ class Chef
 
       property :raid_device, String,
                identity: true, name_property: true,
-               description: "The name of the RAID device. We'll use the resource's name if this isn't specified."
+               description: "An optional property to specify the name of the RAID device if it differs from the resource block's name."
 
       property :layout, String,
                description: "The RAID5 parity algorithm. Possible values: left-asymmetric (or la), left-symmetric (or ls), right-asymmetric (or ra), or right-symmetric (or rs)."

data/lib/chef/resource/mount.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Joshua Timberman (<joshua@chef.io>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright 2009-2017, Chef Software Inc.
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,7 +28,7 @@ class Chef
       allowed_actions :mount, :umount, :unmount, :remount, :enable, :disable
 
       # this is a poor API please do not re-use this pattern
-      property :supports, Hash,
+      property :supports, [Array, Hash],
                description: "Specify a Hash of supported mount features.",
                default: lazy { { remount: false } },
                coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
@@ -50,7 +50,7 @@ class Chef
                equal_to: RUBY_PLATFORM =~ /solaris/i ? %i{ device } : %i{ device label uuid }
 
       # @todo this should get refactored away: https://github.com/chef/chef/issues/7621
-      property :mounted, [TrueClass, FalseClass], default: false
+      property :mounted, [TrueClass, FalseClass], default: false, skip_docs: true
 
       property :fsck_device, String,
                description: "Solaris only: The fsck device.",

data/lib/chef/resource/openssl_dhparam.rb

@@ -30,7 +30,7 @@ class Chef
       introduced "14.0"
 
       property :path, String,
-               description: "The path to write the file to if it's different than the resource name.",
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
                name_property: true
 
       property :key_length, Integer,

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -31,7 +31,7 @@ class Chef
       introduced "14.4"
 
       property :path, String,
-               description: "The path to write the file to it's different than the resource name.",
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
                name_property: true
 
       property :key_curve, String,

data/lib/chef/resource/openssl_ec_public_key.rb

@@ -27,18 +27,18 @@ class Chef
       preview_resource true
       resource_name :openssl_ec_public_key
 
-      description "Use the openssl_ec_public_key resource to generate elliptic curve (EC) public key files given a private key."
+      description "Use the openssl_ec_public_key resource to generate elliptic curve (EC) public key files from a given EC private key."
       introduced "14.4"
 
       property :path, String,
-               description: "The path to write the file to if different than the resource's name.",
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
                name_property: true
 
       property :private_key_path, String,
                description: "The path to the private key file."
 
       property :private_key_content, String,
-               description: "The content of the private key including new lines. This property is used in place of private_key_path to avoid having to first write a key to disk."
+               description: "The content of the private key including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk"
 
       property :private_key_pass, String,
                description: "The passphrase of the provided private key."

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -31,12 +31,12 @@ class Chef
       introduced "14.0"
 
       property :path, String,
-               description: "The path to write the file to it's different than the resource name.",
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
                name_property: true
 
       property :key_length, Integer,
                equal_to: [1024, 2048, 4096, 8192],
-               validation_message: "key_length (bits) must be 1024, 2048, 4096, or 8192.",
+               validation_message: "key_length (bits) must be 1024, 2048, 4096, or 8192!",
                description: "The desired bit length of the generated key.",
                default: 2048
 

data/lib/chef/resource/openssl_rsa_public_key.rb

@@ -26,18 +26,18 @@ class Chef
       resource_name :openssl_rsa_public_key
       provides(:openssl_rsa_public_key) { true }
 
-      description "Use the openssl_rsa_public_key resource to generate RSA public key files given a RSA private key."
+      description "Use the openssl_rsa_public_key resource to generate RSA public key files for a given RSA private key."
       introduced "14.0"
 
       property :path, String,
-               description: "The path to write the file to if different than the resource's name.",
+               description: "An optional property for specifying the path to the public key if it differs from the resource block's name.",
                name_property: true
 
       property :private_key_path, String,
                description: "The path to the private key file."
 
       property :private_key_content, String,
-               description: "The content of the private key including new lines. This property is used in place of private_key_path to avoid having to first write a key to disk."
+               description: "The content of the private key, including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk."
 
       property :private_key_pass, String,
                description: "The passphrase of the provided private key."

data/lib/chef/resource/openssl_x509_certificate.rb

@@ -32,7 +32,7 @@ class Chef
       introduced "14.4"
 
       property :path, String,
-               description: "Optional path to write the file to if you'd like to specify it here instead of in the resource name.",
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
                name_property: true
 
       property :owner, String,

data/lib/chef/resource/openssl_x509_crl.rb

@@ -31,7 +31,7 @@ class Chef
       introduced "14.4"
 
       property :path, String,
-               description: "Optional path to write the file to if you'd like to specify it here instead of in the resource name.",
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
                name_property: true
 
       property :serial_to_revoke, [Integer, String],

data/lib/chef/resource/openssl_x509_request.rb

@@ -31,7 +31,7 @@ class Chef
       introduced "14.4"
 
       property :path, String, name_property: true,
-               description: "The optional path to write the file to if you'd like to specify it here instead of in the resource name."
+               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name."
 
       property :owner, String,
                description: "The owner applied to all files created by the resource."

data/lib/chef/resource/package.rb

@@ -61,7 +61,7 @@ class Chef
                default: lazy { Hash.new }, desired_state: false
 
       property :source, String,
-               description: "The direct path to a the package on the host.",
+               description: "The optional path to a package on the local file system.",
                desired_state: false
 
       property :timeout, [ String, Integer ],

data/lib/chef/resource/powershell_package.rb

@@ -45,7 +45,7 @@ class Chef
 
       property :skip_publisher_check, [true, false],
                description: "Skip validating module author.",
-               default: false, introduced: "14.3"
+               default: false, introduced: "14.3", desired_state: false
 
     end
   end

data/lib/chef/resource/remote_directory.rb

@@ -56,8 +56,8 @@ class Chef
       property :source, String, default: lazy { ::File.basename(path) }
       property :files_backup, [ Integer, FalseClass ], default: 5, desired_state: false
       property :purge, [ TrueClass, FalseClass ], default: false, desired_state: false
-      property :overwrite, [ TrueClass, FalseClass ], default: true
-      property :cookbook, String
+      property :overwrite, [ TrueClass, FalseClass ], default: true, desired_state: false
+      property :cookbook, String, desired_state: false
 
       def files_group(arg = nil)
         set_or_return(

data/lib/chef/resource/rhsm_errata.rb

@@ -29,7 +29,7 @@ class Chef
       introduced "14.0"
 
       property :errata_id, String,
-               description: "An optional property for specifying the errata ID if not using the resource's name.",
+               description: "An optional property for specifying the errata ID if it differs from the resource block's name.",
                name_property: true
 
       action :install do

data/lib/chef/resource/rhsm_errata_level.rb

@@ -29,7 +29,7 @@ class Chef
       property :errata_level, String,
                coerce: proc { |x| x.downcase },
                equal_to: %w{critical moderate important low},
-               description: "The errata level of packages to install.",
+               description: "An optional property for specifying the errata level of packages to install if it differs from the resource block's name.",
                name_property: true
 
       action :install do

data/lib/chef/resource/rhsm_register.rb

@@ -30,22 +30,22 @@ class Chef
 
       property :activation_key, [String, Array],
                coerce: proc { |x| Array(x) },
-               description: "A String or array of the activation keys to use when registering. You must also specify the organization property if using activation_key."
+               description: "A string or array of activation keys to use when registering; you must also specify the 'organization' property when using this property."
 
       property :satellite_host, String,
-               description: "The FQDN of the Satellite host to register with. If not specified, the host will be registered with Red Hat's public RHSM service."
+               description: "The FQDN of the Satellite host to register with. If this property is not specified, the host will register with Red Hat's public RHSM service."
 
       property :organization, String,
-               description: "The organization to use when registering, required when using an activation key."
+               description: "The organization to use when registering; required when using the 'activation_key' property."
 
       property :environment, String,
-               description: "The environment to use when registering, required when using username and password."
+               description: "The environment to use when registering; required when using the username and password properties."
 
       property :username, String,
-               description: "The username to use when registering. Not applicable if using an activation key. If specified, password and environment are also required."
+               description: "The username to use when registering. This property is not applicable if using an activation key. If specified, password and environment properties are also required."
 
       property :password, String,
-               description: "The password to use when registering. Not applicable if using an activation key. If specified, username and environment are also required."
+               description: "The password to use when registering. This property is not applicable if using an activation key. If specified, username and environment are also required."
 
       property :auto_attach,
                [TrueClass, FalseClass],
@@ -57,7 +57,7 @@ class Chef
                default: true
 
       property :force, [TrueClass, FalseClass],
-               description: "If true, the system will be registered even if it is already registered. Normally, any register operations will fail if the machine is has already registered.",
+               description: "If true, the system will be registered even if it is already registered. Normally, any register operations will fail if the machine has already been registered.",
                default: false, desired_state: false
 
       action :register do

data/lib/chef/resource/rhsm_repo.rb

@@ -28,7 +28,7 @@ class Chef
       introduced "14.0"
 
       property :repo_name, String,
-               description: "An optional property for specifying the repository name if not using the resource's name.",
+               description: "An optional property for specifying the repository name if it differs from the resource block's name.",
                name_property: true
 
       action :enable do

data/lib/chef/resource/rhsm_subscription.rb

@@ -29,7 +29,7 @@ class Chef
       introduced "14.0"
 
       property :pool_id, String,
-               description: "An optional property for specifying the Pool ID if not using the resource's name.",
+               description: "An optional property for specifying the Pool ID if it differs from the resource block's name.",
                name_property: true
 
       action :attach do