summaryrefslogtreecommitdiff
path: root/lib/chef
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef')
-rw-r--r--lib/chef/resource/chef_gem.rb5
-rw-r--r--lib/chef/resource/directory.rb8
-rw-r--r--lib/chef/resource/dmg_package.rb5
-rw-r--r--lib/chef/resource/dnf_package.rb43
-rw-r--r--lib/chef/resource/dpkg_package.rb4
-rw-r--r--lib/chef/resource/dsc_resource.rb5
-rw-r--r--lib/chef/resource/dsc_script.rb9
-rw-r--r--lib/chef/resource/execute.rb5
-rw-r--r--lib/chef/resource/git.rb8
-rw-r--r--lib/chef/resource/http_request.rb4
-rw-r--r--lib/chef/resource/macos_userdefaults.rb6
-rw-r--r--lib/chef/resource/macosx_service.rb5
-rw-r--r--lib/chef/resource/mount.rb63
-rw-r--r--lib/chef/resource/msu_package.rb17
-rw-r--r--lib/chef/resource/ohai.rb4
-rw-r--r--lib/chef/resource/osx_profile.rb21
-rw-r--r--lib/chef/resource/package.rb6
-rw-r--r--lib/chef/resource/portage_package.rb3
-rw-r--r--lib/chef/resource/powershell_package.rb26
-rw-r--r--lib/chef/resource/reboot.rb9
-rw-r--r--lib/chef/resource/yum_repository.rb2
-rw-r--r--lib/chef/resource/zypper_package.rb4
22 files changed, 148 insertions, 114 deletions
diff --git a/lib/chef/resource/chef_gem.rb b/lib/chef/resource/chef_gem.rb
index 3304690901..0a1b2ef736 100644
--- a/lib/chef/resource/chef_gem.rb
+++ b/lib/chef/resource/chef_gem.rb
@@ -37,10 +37,13 @@ class Chef
resource_name :chef_gem
property :gem_binary, default: "#{RbConfig::CONFIG['bindir']}/gem",
+ description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the chef-client will be installed.",
callbacks: {
"The chef_gem resource is restricted to the current gem environment, use gem_package to install to other environments." => proc { |v| v == "#{RbConfig::CONFIG['bindir']}/gem" },
}
- property :compile_time, [TrueClass, FalseClass], default: false, desired_state: false
+ property :compile_time, [TrueClass, FalseClass],
+ description: "Controls the phase during which a gem is installed on a node. Set to 'true' to install a gem while the resource collection is being built (the 'compile phase'). Set to 'false' to install a gem while the chef-client is configuring the node (the 'converge phase').",
+ default: false, desired_state: false
# force the resource to compile time if the compile time property has been set
def after_created
diff --git a/lib/chef/resource/directory.rb b/lib/chef/resource/directory.rb
index 1f18a4b951..c585985291 100644
--- a/lib/chef/resource/directory.rb
+++ b/lib/chef/resource/directory.rb
@@ -40,8 +40,12 @@ class Chef
default_action :create
allowed_actions :create, :delete
- property :path, String, name_property: true, identity: true
- property :recursive, [ TrueClass, FalseClass ], default: false
+ property :path, String, name_property: true, identity: true,
+ description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
+
+ property :recursive, [ TrueClass, FalseClass ],
+ description: "Create or delete parent directories recursively. For the owner, group, and mode properties, the value of this attribute applies only to the leaf directory.",
+ default: false
end
end
end
diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb
index af0bc341b4..7442a8f455 100644
--- a/lib/chef/resource/dmg_package.rb
+++ b/lib/chef/resource/dmg_package.rb
@@ -23,10 +23,7 @@ class Chef
resource_name :dmg_package
provides(:dmg_package) { true }
- description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the"\
- " dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory)"\
- " to the specified destination (/Applications), and detach the image using hdiutil. The dmg file"\
- " will be stored in the Chef::Config[:file_cache_path]."
+ description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory) to the specified destination (/Applications), and detach the image using hdiutil. The dmg file will be stored in the Chef::Config[:file_cache_path]."
introduced "14.0"
property :app, String,
diff --git a/lib/chef/resource/dnf_package.rb b/lib/chef/resource/dnf_package.rb
index 13bdc5065e..3b40a6dffb 100644
--- a/lib/chef/resource/dnf_package.rb
+++ b/lib/chef/resource/dnf_package.rb
@@ -40,36 +40,33 @@ class Chef
provides :dnf_package
- description "Use the dnf_package resource to install, upgrade, and remove packages"\
- " with DNF for Fedora platforms. The dnf_package resource is able to"\
- " resolve provides data for packages much like DNF can do when it is"\
- " run from the command line. This allows a variety of options for"\
- " installing packages, like minimum versions, virtual provides,"\
- " and library names."
+ description "Use the dnf_package resource to install, upgrade, and remove packages with DNF for Fedora platforms. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
introduced "12.18"
allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock, :flush_cache
# Install a specific arch
- property :arch, [String, Array], coerce: proc { |x| [x].flatten }
+ property :arch, [String, Array],
+ description: "The architecture of the package to be installed or upgraded. This value can also be passed as part of the package name.",
+ coerce: proc { |x| [x].flatten }
# Flush the in-memory available/installed cache, this does not flush the dnf caches on disk
- property :flush_cache,
- Hash,
- default: { before: false, after: false },
- coerce: proc { |v|
- if v.is_a?(Hash)
- v
- elsif v.is_a?(Array)
- v.each_with_object({}) { |arg, obj| obj[arg] = true }
- elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
- { before: v, after: v }
- elsif v == :before
- { before: true, after: false }
- elsif v == :after
- { after: true, before: false }
- end
- }
+ property :flush_cache, Hash,
+ description: "Flush the in-memory cache before or after a DNF operation that installs, upgrades, or removes a package. DNF automatically synchronizes remote metadata to a local cache. The chef-client creates a copy of the local cache, and then stores it in-memory during the chef-client run. The in-memory cache allows packages to be installed during the chef-client run without the need to continue synchronizing the remote metadata to the local cache while the chef-client run is in-progress.",
+ default: { before: false, after: false },
+ coerce: proc { |v|
+ if v.is_a?(Hash)
+ v
+ elsif v.is_a?(Array)
+ v.each_with_object({}) { |arg, obj| obj[arg] = true }
+ elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
+ { before: v, after: v }
+ elsif v == :before
+ { before: true, after: false }
+ elsif v == :after
+ { after: true, before: false }
+ end
+ }
def allow_downgrade(arg = nil)
if !arg.nil?
diff --git a/lib/chef/resource/dpkg_package.rb b/lib/chef/resource/dpkg_package.rb
index e60764ba8d..742b291508 100644
--- a/lib/chef/resource/dpkg_package.rb
+++ b/lib/chef/resource/dpkg_package.rb
@@ -24,9 +24,7 @@ class Chef
resource_name :dpkg_package
provides :dpkg_package
- description "Use the dpkg_package resource to manage packages for the dpkg platform."\
- " When a package is installed from a local file, it must be added to the"\
- " node using the remote_file or cookbook_file resources."
+ description "Use the dpkg_package resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
property :source, [ String, Array, nil ],
description: "The path to a package in the local file system."
diff --git a/lib/chef/resource/dsc_resource.rb b/lib/chef/resource/dsc_resource.rb
index 8381698dc1..bfa282fc11 100644
--- a/lib/chef/resource/dsc_resource.rb
+++ b/lib/chef/resource/dsc_resource.rb
@@ -23,10 +23,7 @@ class Chef
resource_name :dsc_resource
provides :dsc_resource
- description "The dsc_resource resource allows any DSC resource to be used in a"\
- " Chef recipe, as well as any custom resources that have been added"\
- " to your Windows PowerShell environment. Microsoft frequently adds"\
- " new resources to the DSC resource collection."
+ description "The dsc_resource resource allows any DSC resource to be used in a Chef recipe, as well as any custom resources that have been added to your Windows PowerShell environment. Microsoft frequently adds new resources to the DSC resource collection."
introduced "12.2"
# This class will check if the object responds to
diff --git a/lib/chef/resource/dsc_script.rb b/lib/chef/resource/dsc_script.rb
index e941e4e918..d98c74ccc3 100644
--- a/lib/chef/resource/dsc_script.rb
+++ b/lib/chef/resource/dsc_script.rb
@@ -28,14 +28,7 @@ class Chef
resource_name :dsc_script
provides :dsc_script
- description "Many DSC resources are comparable to built-in Chef resources. For"\
- " example, both DSC and Chef have file, package, and service resources."\
- " The dsc_script resource is most useful for those DSC resources that"\
- " do not have a direct comparison to a resource in Chef, such as the"\
- " Archive resource, a custom DSC resource, an existing DSC script"\
- " that performs an important task, and so on. Use the dsc_script resource"\
- " to embed the code that defines a DSC configuration directly within a"\
- " Chef recipe."
+ description "Many DSC resources are comparable to built-in Chef resources. For example, both DSC and Chef have file, package, and service resources. The dsc_script resource is most useful for those DSC resources that do not have a direct comparison to a resource in Chef, such as the Archive resource, a custom DSC resource, an existing DSC script that performs an important task, and so on. Use the dsc_script resource to embed the code that defines a DSC configuration directly within a Chef recipe."
default_action :run
diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb
index 93f8063d5d..1becbf50a7 100644
--- a/lib/chef/resource/execute.rb
+++ b/lib/chef/resource/execute.rb
@@ -98,9 +98,12 @@ class Chef
description: "Windows only: The password of the user specified by the user property. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
# lazy used to set default value of sensitive to true if password is set
- property :sensitive, [ TrueClass, FalseClass ], default: lazy { |r| r.password ? true : false }
+ property :sensitive, [ TrueClass, FalseClass ],
+ description: "Ensure that sensitive resource data is not logged by the chef-client.",
+ default: lazy { |r| r.password ? true : false }
property :elevated, [ TrueClass, FalseClass ], default: false,
+ description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running Chef needs the “Replace a process level token” and “Adjust Memory Quotas for a process” permissions. The user that is running the command needs the “Log on as a batch job” permission.\nBecause this requires a login, the user and password properties are required.",
introduced: "13.3"
def self.set_guard_inherited_attributes(*inherited_attributes)
diff --git a/lib/chef/resource/git.rb b/lib/chef/resource/git.rb
index 7e756db78f..d0a78adc0e 100644
--- a/lib/chef/resource/git.rb
+++ b/lib/chef/resource/git.rb
@@ -21,11 +21,11 @@ require "chef/resource/scm"
class Chef
class Resource
class Git < Chef::Resource::Scm
- description "Use the git resource to manage source control resources that exist"\
- " in a git repository. git version 1.6.5 (or higher) is required to"\
- " use all of the functionality in the git resource."
+ description "Use the git resource to manage source control resources that exist in a git repository. git version 1.6.5 (or higher) is required to use all of the functionality in the git resource."
- property :additional_remotes, Hash, default: lazy { Hash.new }
+ property :additional_remotes, Hash,
+ description: "A Hash of additional remotes that are added to the git repository configuration.",
+ default: lazy { Hash.new }
alias :branch :revision
alias :reference :revision
diff --git a/lib/chef/resource/http_request.rb b/lib/chef/resource/http_request.rb
index 6e92fb821c..455d032819 100644
--- a/lib/chef/resource/http_request.rb
+++ b/lib/chef/resource/http_request.rb
@@ -25,9 +25,7 @@ class Chef
resource_name :http_request
provides :http_request
- description "Use the http_request resource to send an HTTP request (GET, PUT,"\
- " POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This"\
- " resource is often useful when custom callbacks are necessary."
+ description "Use the http_request resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
default_action :get
allowed_actions :get, :patch, :put, :post, :delete, :head, :options
diff --git a/lib/chef/resource/macos_userdefaults.rb b/lib/chef/resource/macos_userdefaults.rb
index 3cf44eb161..f2ad5a0213 100644
--- a/lib/chef/resource/macos_userdefaults.rb
+++ b/lib/chef/resource/macos_userdefaults.rb
@@ -25,9 +25,7 @@ class Chef
provides(:mac_os_x_userdefaults) { true }
provides(:macos_userdefaults) { true }
- description "Use the macos_userdefaults resource to manage the macOS user defaults system. The properties"\
- " of this resource are passed to the defaults command, and the parameters follow the convention"\
- " of that command. See the defaults(1) man page for details on how the tool works."
+ description "Use the macos_userdefaults resource to manage the macOS user defaults system. The properties of this resource are passed to the defaults command, and the parameters follow the convention of that command. See the defaults(1) man page for details on how the tool works."
introduced "14.0"
property :domain, String,
@@ -57,8 +55,8 @@ class Chef
default: false,
desired_state: false
+ # @todo this should get refactored away: https://github.com/chef/chef/issues/7622
property :is_set, [TrueClass, FalseClass],
- description: "",
default: false,
desired_state: false
diff --git a/lib/chef/resource/macosx_service.rb b/lib/chef/resource/macosx_service.rb
index 8fa8fd7a36..deff6e1927 100644
--- a/lib/chef/resource/macosx_service.rb
+++ b/lib/chef/resource/macosx_service.rb
@@ -31,9 +31,8 @@ class Chef
state_attrs :enabled, :running
- # This will enable user to pass a plist in the case
- # that the filename and label for the service dont match
- property :plist, String
+ property :plist, String,
+ description: "A plist to use in the case where the filename and label for the service do not match."
property :session_type, String
diff --git a/lib/chef/resource/mount.rb b/lib/chef/resource/mount.rb
index dffb96cb53..68ecee2335 100644
--- a/lib/chef/resource/mount.rb
+++ b/lib/chef/resource/mount.rb
@@ -29,32 +29,59 @@ class Chef
# this is a poor API please do not re-use this pattern
property :supports, Hash,
- default: lazy { { remount: false } },
- coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
+ 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 }
- property :password, String, sensitive: true
+ property :password, String,
+ description: "Windows only:. Use to specify the password for username.",
+ sensitive: true
- property :mount_point, String, name_property: true
- property :device, String, identity: true
+ property :mount_point, String, name_property: true,
+ description: "The directory (or path) in which the device is to be mounted. Defaults to the name of the resource block if not provided."
+
+ property :device, String, identity: true,
+ description: "Required for :umount and :remount actions (for the purpose of checking the mount command output for presence). The special block device or remote node, a label, or a uuid to be mounted."
property :device_type, [String, Symbol],
- coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg },
- default: :device,
- equal_to: RUBY_PLATFORM =~ /solaris/i ? %i{ device } : %i{ device label uuid }
+ description: "The type of device: :device, :label, or :uuid",
+ coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg },
+ default: :device,
+ 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 :fsck_device, String, default: "-"
- property :fstype, [String, nil], default: "auto"
+ property :fsck_device, String,
+ description: "Solaris only: The fsck device.",
+ default: "-"
+
+ property :fstype, [String, nil],
+ description: "The file system type (fstype) of the device.",
+ default: "auto"
property :options, [Array, String, nil],
- coerce: proc { |arg| arg.kind_of?(String) ? arg.split(",") : arg },
- default: %w{defaults}
+ description: "An array or comma separated list of options for the mount.",
+ coerce: proc { |arg| arg.kind_of?(String) ? arg.split(",") : arg },
+ default: %w{defaults}
- property :dump, [Integer, FalseClass], default: 0
- property :pass, [Integer, FalseClass], default: 2
- property :mounted, [TrueClass, FalseClass], default: false
- property :enabled, [TrueClass, FalseClass], default: false
- property :username, String
- property :domain, String
+ property :dump, [Integer, FalseClass],
+ description: "The dump frequency (in days) used while creating a file systems table (fstab) entry.",
+ default: 0
+
+ property :pass, [Integer, FalseClass],
+ description: "The pass number used by the file system check (fsck) command while creating a file systems table (fstab) entry.",
+ default: 2
+
+ property :enabled, [TrueClass, FalseClass],
+ description: "Use to specify if a mounted file system is enabled.",
+ default: false
+
+ property :username, String,
+ description: "Windows only: Use to specify the user name."
+
+ property :domain, String,
+ description: "Windows only: Use to specify the domain in which the username and password are located."
private
diff --git a/lib/chef/resource/msu_package.rb b/lib/chef/resource/msu_package.rb
index 85ab170ee0..9fd39491c9 100644
--- a/lib/chef/resource/msu_package.rb
+++ b/lib/chef/resource/msu_package.rb
@@ -34,13 +34,16 @@ class Chef
default_action :install
property :source, String,
- coerce: (proc do |s|
- unless s.nil?
- uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false)
- end
- end),
- default: lazy { |r| r.package_name }
- property :checksum, String, desired_state: false
+ description: "The local file path or URL for the MSU package.",
+ coerce: (proc do |s|
+ unless s.nil?
+ uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false)
+ end
+ end),
+ default: lazy { |r| r.package_name }
+
+ property :checksum, String, desired_state: false,
+ description: "SHA-256 digest used to verify the checksum of the downloaded MSU package."
end
end
end
diff --git a/lib/chef/resource/ohai.rb b/lib/chef/resource/ohai.rb
index b286412434..291c82c7b7 100644
--- a/lib/chef/resource/ohai.rb
+++ b/lib/chef/resource/ohai.rb
@@ -25,9 +25,7 @@ class Chef
resource_name :ohai
provides :ohai
- description "Use the ohai resource to reload the Ohai configuration on a node."\
- " This allows recipes that change system attributes (like a recipe"\
- " that adds a user) to refer to those attributes later on during the chef-client run."
+ description "Use the ohai resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the chef-client run."
property :ohai_name, name_property: true
property :plugin, String
diff --git a/lib/chef/resource/osx_profile.rb b/lib/chef/resource/osx_profile.rb
index 612ff637e4..90166cc338 100644
--- a/lib/chef/resource/osx_profile.rb
+++ b/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
diff --git a/lib/chef/resource/package.rb b/lib/chef/resource/package.rb
index bbad5f7696..8954478ee3 100644
--- a/lib/chef/resource/package.rb
+++ b/lib/chef/resource/package.rb
@@ -53,12 +53,12 @@ class Chef
coerce: proc { |x| x.is_a?(String) ? x.shellsplit : x }
property :response_file, String,
- description: "",
+ description: "The direct path to the file used to pre-seed a package.",
desired_state: false
property :response_file_variables, Hash,
- description: "",
- default: lazy { {} }, desired_state: false
+ 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.",
diff --git a/lib/chef/resource/portage_package.rb b/lib/chef/resource/portage_package.rb
index 43b0cfc74d..5e954581c7 100644
--- a/lib/chef/resource/portage_package.rb
+++ b/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
diff --git a/lib/chef/resource/powershell_package.rb b/lib/chef/resource/powershell_package.rb
index ba5a03ef8b..93fc546357 100644
--- a/lib/chef/resource/powershell_package.rb
+++ b/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
diff --git a/lib/chef/resource/reboot.rb b/lib/chef/resource/reboot.rb
index bc649bee09..b9f748978f 100644
--- a/lib/chef/resource/reboot.rb
+++ b/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
diff --git a/lib/chef/resource/yum_repository.rb b/lib/chef/resource/yum_repository.rb
index ba7fb53ad1..df3bfb6454 100644
--- a/lib/chef/resource/yum_repository.rb
+++ b/lib/chef/resource/yum_repository.rb
@@ -143,7 +143,7 @@ class Chef
name_property: true
property :skip_if_unavailable, [TrueClass, FalseClass],
- description: ""
+ description: "Allow yum to continue if this repository cannot be contacted for any reason."
property :source, String,
description: "Use a custom template source instead of the default one."
diff --git a/lib/chef/resource/zypper_package.rb b/lib/chef/resource/zypper_package.rb
index b04668472f..6738b32eda 100644
--- a/lib/chef/resource/zypper_package.rb
+++ b/lib/chef/resource/zypper_package.rb
@@ -28,11 +28,11 @@ class Chef
description "Use the zypper_package resource to install, upgrade, and remove packages with Zypper for the SUSE Enterprise and OpenSUSE platforms."
property :gpg_check, [ TrueClass, FalseClass ],
- description: "Verify the package's GPG signature",
+ description: "Verify the package's GPG signature. Can also be controlled site-wide using the ``zypper_check_gpg`` config option.",
default: lazy { Chef::Config[:zypper_check_gpg] }
property :allow_downgrade, [ TrueClass, FalseClass ],
- description: "",
+ description: "Allow downgrading a package to satisfy requested version requirements.",
default: false
end
end
View Lorry Controller Status