chef 14.4.56 → 14.5.27

data/lib/chef/resource/openssl_dhparam.rb

@@ -45,14 +45,14 @@ class Chef
                description: "The desired Diffie-Hellmann generator.",
                default: 2
 
-      property :owner, [String, nil],
-               description: "The owner of all files created by the resource."
+      property :owner, String,
+               description: "The owner applied to all files created by the resource."
 
-      property :group, [String, nil],
-               description: "The group of all files created by the resource."
+      property :group, String,
+               description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource.",
+               description: "The permission mode applied to all files created by the resource.",
                default: "0640"
 
       action :create do

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -27,7 +27,7 @@ class Chef
       preview_resource true
       resource_name :openssl_ec_private_key
 
-      description "Use the openssl_ec_private_key resource to generate generate elliptic curve (EC) private key files. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, it will be overwritten."
+      description "Use the openssl_ec_private_key resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
       introduced "14.4"
 
       property :path, String,
@@ -49,17 +49,17 @@ class Chef
                default: "des3"
 
       property :owner, String,
-               description: "The owner of all files created by the resource."
+               description: "The owner applied to all files created by the resource."
 
       property :group, String,
-               description: "The group of all files created by the resource."
+               description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource.",
+               description: "The permission mode applied to all files created by the resource.",
                default: "0600"
 
       property :force, [TrueClass, FalseClass],
-               description: "Force creating the key even if the existing key exists.",
+               description: "Force creation of the key even if the same key already exists on the node.",
                default: false, desired_state: false
 
       action :create do

data/lib/chef/resource/openssl_ec_public_key.rb

@@ -35,22 +35,22 @@ class Chef
                name_property: true
 
       property :private_key_path, String,
-               description: "The path to the private key."
+               description: "The path to the private key file."
 
       property :private_key_content, String,
-               description: "The content of the private key including new lines. Used instead 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 to avoid having to first write a key to disk."
 
       property :private_key_pass, String,
                description: "The passphrase of the provided private key."
 
       property :owner, String,
-               description: "The owner of all files created by the resource."
+               description: "The owner applied to all files created by the resource."
 
       property :group, String,
-               description: "The group of all files created by the resource."
+               description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource.",
+               description: "The permission mode applied to all files created by the resource.",
                default: "0640"
 
       action :create do

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -49,18 +49,18 @@ class Chef
                description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
                default: "des3"
 
-      property :owner, [String, nil],
-               description: "The owner of all files created by the resource."
+      property :owner, String,
+               description: "The owner applied to all files created by the resource."
 
-      property :group, [String, nil],
-               description: "The group of all files created by the resource."
+      property :group, String,
+               description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource.",
+               description: "The permission mode applied to all files created by the resource.",
                default: "0600"
 
       property :force, [TrueClass, FalseClass],
-               description: "Force creating the key even if the existing key exists.",
+               description: "Force creation of the key even if the same key already exists on the node.",
                default: false, desired_state: false
 
       action :create do

data/lib/chef/resource/openssl_rsa_public_key.rb

@@ -34,22 +34,22 @@ class Chef
                name_property: true
 
       property :private_key_path, String,
-               description: "The path to the private key."
+               description: "The path to the private key file."
 
       property :private_key_content, String,
-               description: "The content of the private key including new lines. Used instead 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 to avoid having to first write a key to disk."
 
       property :private_key_pass, String,
                description: "The passphrase of the provided private key."
 
-      property :owner, [String, nil],
-               description: "The owner of all files created by the resource."
+      property :owner, String,
+               description: "The owner applied to all files created by the resource."
 
-      property :group, [String, nil],
-               description: "The group of all files created by the resource."
+      property :group, String,
+               description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource.",
+               description: "The permission mode applied to all files created by the resource.",
                default: "0640"
 
       action :create do

data/lib/chef/resource/openssl_x509_certificate.rb

@@ -26,7 +26,7 @@ class Chef
 
       preview_resource true
       resource_name :openssl_x509_certificate
-      # provides(:openssl_x509) { true } # legacy cookbook name. Cookbook will win for now. @todo Uncomment this for Chef 15
+      provides(:openssl_x509) { true } # legacy cookbook name.
 
       description "Use the openssl_x509_certificate resource to generate signed or self-signed, PEM-formatted x509 certificates. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate. If a CA private key and certificate are provided, the certificate will be signed with them. Note: This resource was renamed from openssl_x509 to openssl_x509_certificate. The legacy name will continue to function, but cookbook code should be updated for the new resource name."
       introduced "14.4"
@@ -36,20 +36,20 @@ class Chef
                name_property: true
 
       property :owner, String,
-               description: "The owner of all files created by the resource."
+               description: "The owner applied to all files created by the resource."
 
       property :group, String,
-               description: "The group of all files created by the resource."
+               description: "The group ownership applied to all files created by the resource."
 
       property :expire, Integer,
                description: "Value representing the number of days from now through which the issued certificate cert will remain valid. The certificate will expire after this period.",
                default: 365
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource."
+               description: "The permission mode applied to all files created by the resource."
 
       property :country, String,
-               description: "Value for the C ssl field."
+               description: "Value for the C certificate field."
 
       property :state, String,
                description: "Value for the ST certificate field."
@@ -67,7 +67,7 @@ class Chef
                description: "Value for the CN certificate field."
 
       property :email, String,
-               description: "Value for the email ssl field."
+               description: "Value for the email certificate field."
 
       property :extensions, Hash,
                description: "Hash of X509 Extensions entries, in format { 'keyUsage' => { 'values' => %w( keyEncipherment digitalSignature), 'critical' => true } }.",
@@ -78,7 +78,7 @@ class Chef
                default: lazy { [] }
 
       property :key_file, String,
-               description: "The path to a certificate key file on the filesystem. If the key_file attribute is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file attribute is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
+               description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
 
       property :key_pass, String,
                description: "The passphrase for an existing key's passphrase."
@@ -90,7 +90,7 @@ class Chef
 
       property :key_length, Integer,
                equal_to: [1024, 2048, 4096, 8192],
-               description: "The desired Bit Length of the generated key (if key_type is equal to 'rsa').",
+               description: "The desired bit length of the generated key (if key_type is equal to 'rsa').",
                default: 2048
 
       property :key_curve, String,
@@ -99,13 +99,13 @@ class Chef
                default: "prime256v1"
 
       property :csr_file, String,
-               description: "The path to a X509 Certificate Request (CSR) on the filesystem. If the csr_file attribute is specified, the resource will attempt to source a CSR from this location. If no CSR file is found, the resource will generate a Self-Signed Certificate and the certificate fields must be specified (common_name at last)."
+               description: "The path to a X509 Certificate Request (CSR) on the filesystem. If the csr_file property is specified, the resource will attempt to source a CSR from this location. If no CSR file is found, the resource will generate a Self-Signed Certificate and the certificate fields must be specified (common_name at last)."
 
       property :ca_cert_file, String,
-               description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file attribute is specified, the ca_key_file attribute must also be specified, the certificate will be signed with them."
+               description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file property is specified, the ca_key_file property must also be specified, the certificate will be signed with them."
 
       property :ca_key_file, String,
-               description: "The path to the CA private key on the filesystem. If the ca_key_file attribute is specified, the `ca_cert_file' attribute must also be specified, the certificate will be signed with them."
+               description: "The path to the CA private key on the filesystem. If the ca_key_file property is specified, the 'ca_cert_file' property must also be specified, the certificate will be signed with them."
 
       property :ca_key_pass, String,
                description: "The passphrase for CA private key's passphrase."

data/lib/chef/resource/openssl_x509_crl.rb

@@ -38,7 +38,7 @@ class Chef
                description: "Serial of the X509 Certificate to revoke."
 
       property :revocation_reason, Integer,
-               description: "Reason for the revokation.",
+               description: "Reason for the revocation.",
                default: 0
 
       property :expire, Integer,
@@ -50,7 +50,7 @@ class Chef
                default: 1
 
       property :ca_cert_file, String,
-               description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file attribute is specified, the ca_key_file attribute must also be specified, the CRL will be signed with them.",
+               description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file property is specified, the ca_key_file property must also be specified, the CRL will be signed with them.",
                required: true
 
       property :ca_key_file, String,

data/lib/chef/resource/openssl_x509_request.rb

@@ -34,16 +34,16 @@ class Chef
                description: "The optional path to write the file to if you'd like to specify it here instead of in the resource name."
 
       property :owner, String,
-               description: "The owner of all files created by the resource."
+               description: "The owner applied to all files created by the resource."
 
       property :group, String,
-               description: "The group of all files created by the resource."
+               description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode of all files created by the resource."
+               description: "The permission mode applied to all files created by the resource."
 
       property :country, String,
-               description: "Value for the C ssl field."
+               description: "Value for the C certificate field."
 
       property :state, String,
                description: "Value for the ST certificate field."
@@ -62,10 +62,10 @@ class Chef
                description: "Value for the CN certificate field."
 
       property :email, String,
-               description: "Value for the email ssl field."
+               description: "Value for the email certificate field."
 
       property :key_file, String,
-               description: "The path to a certificate key file on the filesystem. If the key_file attribute is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file attribute is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
+               description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
 
       property :key_pass, String,
                description: "The passphrase for an existing key's passphrase."
@@ -76,7 +76,7 @@ class Chef
 
       property :key_length, Integer,
                equal_to: [1024, 2048, 4096, 8192], default: 2048,
-               description: "The desired Bit Length of the generated key (if key_type is equal to 'rsa')."
+               description: "The desired bit length of the generated key (if key_type is equal to 'rsa')."
 
       property :key_curve, String,
                equal_to: %w{secp384r1 secp521r1 prime256v1}, default: "prime256v1",

data/lib/chef/resource/osx_profile.rb

@@ -25,19 +25,24 @@ class Chef
       provides :osx_profile
       provides :osx_config_profile
 
-      description "Use the osx_profile resource to manage configuration profiles (.mobileconfig files)"\
-                  " on the macOS platform. The osx_profile resource installs profiles by using"\
-                  " the uuidgen library to generate a unique ProfileUUID, and then using the"\
-                  " profiles command to install the profile on the system."
+      description "Use the osx_profile resource to manage configuration profiles (.mobileconfig files) on the macOS platform. The osx_profile resource installs profiles by using the uuidgen library to generate a unique ProfileUUID, and then using the profiles command to install the profile on the system."
       introduced "12.7"
 
       default_action :install
       allowed_actions :install, :remove
 
-      property :profile_name, String, name_property: true, identity: true
-      property :profile, [ String, Hash ]
-      property :identifier, String
-      property :path, String
+      property :profile_name, String,
+               description: "Use to specify the name of the profile, if different from the name of the resource block.",
+               name_property: true, identity: true
+
+      property :profile, [ String, Hash ],
+               description: "Use to specify a profile. This may be the name of a profile contained in a cookbook or a Hash that contains the contents of the profile."
+
+      property :identifier, String,
+               description: "Use to specify the identifier for the profile, such as com.company.screensaver."
+
+      property :path, String,
+               description: "The path to write the profile to disk before loading it."
     end
   end
 end

data/lib/chef/resource/package.rb

@@ -41,14 +41,32 @@ class Chef
         super
       end
 
-      property :package_name, [ String, Array ], identity: true
-
-      property :version, [ String, Array ]
-      property :options, [ String, Array ], coerce: proc { |x| x.is_a?(String) ? x.shellsplit : x }
-      property :response_file, String, desired_state: false
-      property :response_file_variables, Hash, default: lazy { {} }, desired_state: false
-      property :source, String, desired_state: false
-      property :timeout, [ String, Integer ], desired_state: false
+      property :package_name, [ String, Array ],
+               description: "The name of the package. Defaults to the name of the resourse block unless specified.",
+               identity: true
+
+      property :version, [ String, Array ],
+               description: "The version of a package to be installed or upgraded."
+
+      property :options, [ String, Array ],
+               description: "One (or more) additional command options that are passed to the command.",
+               coerce: proc { |x| x.is_a?(String) ? x.shellsplit : x }
+
+      property :response_file, String,
+               description: "The direct path to the file used to pre-seed a package.",
+               desired_state: false
+
+      property :response_file_variables, Hash,
+               description: "A Hash of response file variables in the form of {'VARIABLE' => 'VALUE'}.",
+               default: lazy { Hash.new }, desired_state: false
+
+      property :source, String,
+               description: "The direct path to a the package on the host.",
+               desired_state: false
+
+      property :timeout, [ String, Integer ],
+               description: "The amount of time (in seconds) to wait before timing out.",
+               desired_state: false
 
     end
   end

data/lib/chef/resource/paludis_package.rb

@@ -30,7 +30,9 @@ class Chef
 
       allowed_actions :install, :remove, :upgrade
 
-      property :timeout, default: 3600
+      property :timeout, Integer,
+               description: "The amount of time (in seconds) to wait before timing out.",
+               default: 3600
     end
   end
 end

data/lib/chef/resource/portage_package.rb

@@ -26,7 +26,8 @@ class Chef
 
       description "Use the portage_package resource to manage packages for the Gentoo platform."
 
-      property :timeout, default: 3600
+      property :timeout, default: 3600,
+               description: "The amount of time (in seconds) to wait before timing out."
     end
   end
 end

data/lib/chef/resource/powershell_package.rb

@@ -26,19 +26,27 @@ class Chef
       resource_name :powershell_package
       provides :powershell_package
 
-      description "Use the powershell_package resource to install and manage packages via"\
-                  " the Powershell Package Manager for the Microsoft Windows platform. The"\
-                  " powershell_package resource requires administrative access, and a source"\
-                  " must be configured in the Powershell Package Manager via the Register-PackageSource command"
+      description "Use the powershell_package resource to install and manage packages via the PowerShell Package Manager for the Microsoft Windows platform. The powershell_package resource requires administrative access, and a source must be configured in the PowerShell Package Manager via the Register-PackageSource command"
       introduced "12.16"
 
       allowed_actions :install, :remove
 
-      property :package_name, [String, Array], coerce: proc { |x| [x].flatten }
-      property :version, [String, Array], coerce: proc { |x| [x].flatten }
-      property :source, [String]
-      property :skip_publisher_check, [true, false], default: false, introduced: "14.3",
-               description: "Skip validating module author."
+      property :package_name, [String, Array],
+               description: "The name of the package. Default value: the name of the resource block.",
+               coerce: proc { |x| [x].flatten }
+
+      property :version, [String, Array],
+               description: "The version of a package to be installed or upgraded.",
+               coerce: proc { |x| [x].flatten }
+
+      property :source, String,
+               description: "Specify the source of the package.",
+               introduced: "14.0"
+
+      property :skip_publisher_check, [true, false],
+               description: "Skip validating module author.",
+               default: false, introduced: "14.3"
+
     end
   end
 end

data/lib/chef/resource/powershell_package_source.rb

@@ -24,7 +24,7 @@ class Chef
       preview_resource true
       resource_name "powershell_package_source"
 
-      description "Use the powershell_package_source resource to register a powershell package repository."
+      description "Use the powershell_package_source resource to register a PowerShell package repository."
       introduced "14.3"
 
       property :source_name, String,

data/lib/chef/resource/reboot.rb

@@ -34,8 +34,13 @@ class Chef
       allowed_actions :request_reboot, :reboot_now, :cancel
       default_action :nothing # make sure people are quite clear what they want
 
-      property :reason, String, default: "Reboot by Chef"
-      property :delay_mins, Integer, default: 0
+      property :reason, String,
+               description: "A string that describes the reboot action.",
+               default: "Reboot by Chef"
+
+      property :delay_mins, Integer,
+               description: "The amount of time (in minutes) to delay a reboot request.",
+               default: 0
     end
   end
 end

data/lib/chef/resource/rhsm_errata_level.rb

@@ -23,9 +23,7 @@ class Chef
       resource_name :rhsm_errata_level
       provides(:rhsm_errata_level) { true }
 
-      description " Use the rhsm_errata_level resource to install all packages of a specified errata level"\
-                  " from the Red Hat Subscript Manager. For example, you can ensure that all packages associated"\
-                  " with errata marked at a 'Critical' security level are installed."
+      description "Use the rhsm_errata_level resource to install all packages of a specified errata level from the Red Hat Subscription Manager. For example, you can ensure that all packages associated with errata marked at a 'Critical' security level are installed."
       introduced "14.0"
 
       property :errata_level, String,

data/lib/chef/resource/route.rb

@@ -28,7 +28,7 @@ class Chef
       description "Use the route resource to manage the system routing table in a Linux environment."
 
       property :target, String, identity: true, name_property: true
-      property :comment, [String, nil]
+      property :comment, [String, nil], introduced: "14.0"
       property :metric, [Integer, nil]
       property :netmask, [String, nil]
       property :gateway, [String, nil]