chef 13.6.4 → 13.7.16

data/lib/chef/resource/gem_package.rb

@@ -20,6 +20,8 @@ require "chef/resource/package"
 
 class Chef
   class Resource
+    # Use the gem_package resource to manage gem packages that are only included in recipes. When a package is installed
+    # from a local file, it must be added to the node using the remote_file or cookbook_file resources.
     class GemPackage < Chef::Resource::Package
       resource_name :gem_package
 

data/lib/chef/resource/git.rb

@@ -20,6 +20,8 @@ require "chef/resource/scm"
 
 class Chef
   class Resource
+    # 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.
     class Git < Chef::Resource::Scm
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/group.rb

@@ -19,6 +19,7 @@
 
 class Chef
   class Resource
+    # Use the group resource to manage a local group.
     class Group < Chef::Resource
 
       identity_attr :group_name

data/lib/chef/resource/homebrew_package.rb

@@ -23,6 +23,9 @@ require "chef/resource/package"
 
 class Chef
   class Resource
+    # Use the homebrew_package resource to manage packages for the macOS platform.
+    #
+    # @since 12.0
     class HomebrewPackage < Chef::Resource::Package
       resource_name :homebrew_package
       provides :package, os: "darwin"

data/lib/chef/resource/http_request.rb

@@ -22,6 +22,8 @@ require "chef/provider/http_request"
 
 class Chef
   class Resource
+    # 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.
     class HttpRequest < Chef::Resource
 
       identity_attr :url

data/lib/chef/resource/ifconfig.rb

@@ -21,163 +21,36 @@ require "chef/resource"
 
 class Chef
   class Resource
+    # use the ifconfig resource to manage interfaces on *nix systems
+    #
+    # @example set a static ip on eth1
+    #   ifconfig '33.33.33.80' do
+    #     device 'eth1'
+    #   end
     class Ifconfig < Chef::Resource
-
-      identity_attr :device
+      resource_name :ifconfig
 
       state_attrs :inet_addr, :mask
 
       default_action :add
       allowed_actions :add, :delete, :enable, :disable
 
-      def initialize(name, run_context = nil)
-        super
-        @target = name
-        @hwaddr = nil
-        @mask = nil
-        @inet_addr = nil
-        @bcast = nil
-        @mtu = nil
-        @metric = nil
-        @device = nil
-        @onboot = nil
-        @network = nil
-        @bootproto = nil
-        @onparent = nil
-        @ethtool_opts = nil
-        @bonding_opts = nil
-        @master = nil
-        @slave = nil
-      end
-
-      def target(arg = nil)
-        set_or_return(
-          :target,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def device(arg = nil)
-        set_or_return(
-          :device,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def hwaddr(arg = nil)
-        set_or_return(
-          :hwaddr,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def inet_addr(arg = nil)
-        set_or_return(
-          :inet_addr,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def bcast(arg = nil)
-        set_or_return(
-          :bcast,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def mask(arg = nil)
-        set_or_return(
-          :mask,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def mtu(arg = nil)
-        set_or_return(
-          :mtu,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def metric(arg = nil)
-        set_or_return(
-          :metric,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def onboot(arg = nil)
-        set_or_return(
-          :onboot,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def network(arg = nil)
-        set_or_return(
-          :network,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def bootproto(arg = nil)
-        set_or_return(
-          :bootproto,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def onparent(arg = nil)
-        set_or_return(
-          :onparent,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def ethtool_opts(arg = nil)
-        set_or_return(
-          :ethtool_opts,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def bonding_opts(arg = nil)
-        set_or_return(
-          :bonding_opts,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def master(arg = nil)
-        set_or_return(
-          :master,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      def slave(arg = nil)
-        set_or_return(
-          :slave,
-          arg,
-          :kind_of => String
-        )
-      end
+      property :target, String, name_property: true
+      property :hwaddr, String
+      property :mask, String
+      property :inet_addr, String
+      property :bcast, String
+      property :mtu, String
+      property :metric, String
+      property :device, String, identity: true
+      property :onboot, String
+      property :network, String
+      property :bootproto, String
+      property :onparent, String
+      property :ethtool_opts, String
+      property :bonding_opts, String
+      property :master, String
+      property :slave, String
     end
-
   end
 end

data/lib/chef/resource/ips_package.rb

@@ -21,6 +21,7 @@ require "chef/provider/package/ips"
 
 class Chef
   class Resource
+    # Use the ips_package resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform.
     class IpsPackage < ::Chef::Resource::Package
       resource_name :ips_package
       provides :package, os: "solaris2"

data/lib/chef/resource/ksh.rb

@@ -20,6 +20,12 @@ require "chef/resource/script"
 
 class Chef
   class Resource
+    # Use the ksh resource to execute scripts using the Korn shell (ksh) interpreter. This resource may also use any
+    # f the actions and properties that are available to the execute resource. Commands that are executed with this
+    # resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are
+    # run. Use not_if and only_if to guard this resource for idempotence.
+    #
+    # @since 12.6
     class Ksh < Chef::Resource::Script
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/launchd.rb

@@ -17,19 +17,20 @@
 #
 
 require "chef/resource"
-require "chef/provider/launchd"
 
 class Chef
   class Resource
+    # Use the launchd resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform.
+    #
+    # @since 12.8
     class Launchd < Chef::Resource
+      resource_name :launchd
       provides :launchd, os: "darwin"
 
-      identity_attr :label
-
       default_action :create
       allowed_actions :create, :create_if_missing, :delete, :enable, :disable, :restart
 
-      property :label, String, default: lazy { name }, identity: true
+      property :label, String, identity: true, name_property: true
       property :backup, [Integer, FalseClass]
       property :cookbook, String
       property :group, [String, Integer]

data/lib/chef/resource/link.rb

@@ -22,6 +22,16 @@ require "chef/mixin/securable"
 
 class Chef
   class Resource
+    # Use the link resource to create symbolic or hard links.
+    #
+    # A symbolic link—sometimes referred to as a soft link—is a directory entry that associates a file name with a string
+    # that contains an absolute or relative path to a file on any file system. In other words, “a file that contains a path
+    # that points to another file.” A symbolic link creates a new file with a new inode that points to the inode location
+    # of the original file.
+    #
+    # A hard link is a directory entry that associates a file with another file in the same file system. In other words,
+    # “multiple directory entries to the same file.” A hard link creates a new file that points to the same inode as the
+    # original file.
     class Link < Chef::Resource
       include Chef::Mixin::Securable
 

data/lib/chef/resource/log.rb

@@ -18,59 +18,32 @@
 #
 
 require "chef/resource"
-require "chef/provider/log"
 
 class Chef
   class Resource
+    # Use the log resource to create log entries. The log resource behaves like any other resource: built into the resource
+    # collection during the compile phase, and then run during the execution phase. (To create a log entry that is not built
+    # into the resource collection, use Chef::Log instead of the log resource.)
+    #
+    # Allows logging a :debug, :info, :warn, and :error levels
+    # Defaults to :info level
+    #
+    # @example logging at default info level
+    #   log "your string to log"
+    #
+    # @example logging at specified debug level
+    #   log "a debug string" do
+    #     level :debug
+    #   end
+    #
     class Log < Chef::Resource
+      resource_name :log
 
-      identity_attr :message
+      property :message, String, name_property: true
+      property :level, Symbol, equal_to: [ :debug, :info, :warn, :error, :fatal ], default: :info
 
+      allowed_actions :write
       default_action :write
-
-      # Sends a string from a recipe to a log provider
-      #
-      # log "some string to log" do
-      #   level :info  # (default)  also supports :warn, :debug, and :error
-      # end
-      #
-      # === Example
-      # log "your string to log"
-      #
-      # or
-      #
-      # log "a debug string" { level :debug }
-      #
-
-      # Initialize log resource with a name as the string to log
-      #
-      # === Parameters
-      # name<String>:: Message to log
-      # collection<Array>:: Collection of included recipes
-      # node<Chef::Node>:: Node where resource will be used
-      def initialize(name, run_context = nil)
-        super
-        @level = :info
-        @message = name
-      end
-
-      def message(arg = nil)
-        set_or_return(
-          :message,
-          arg,
-          :kind_of => String
-        )
-      end
-
-      # <Symbol> Log level, one of :debug, :info, :warn, :error or :fatal
-      def level(arg = nil)
-        set_or_return(
-          :level,
-          arg,
-          :equal_to => [ :debug, :info, :warn, :error, :fatal ]
-        )
-      end
-
     end
   end
 end

data/lib/chef/resource/macports_package.rb

@@ -20,6 +20,7 @@ require "chef/resource/package"
 
 class Chef
   class Resource
+    # Use the macports_package resource to manage packages for the macOS platform.
     class MacportsPackage < Chef::Resource::Package
       resource_name :macports_package
     end

data/lib/chef/resource/mdadm.rb

@@ -21,6 +21,10 @@ require "chef/resource"
 
 class Chef
   class Resource
+    # Use the mdadm resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource
+    # will create and assemble an array, but it will not create the config file that is used to persist the array upon
+    # reboot. If the config file is required, it must be done by specifying a template with the correct array layout,
+    # and then by using the mount provider to create a file systems table (fstab) entry.
     class Mdadm < Chef::Resource
 
       identity_attr :raid_device

data/lib/chef/resource/mount.rb

@@ -21,6 +21,7 @@ require "chef/resource"
 
 class Chef
   class Resource
+    # Use the mount resource to manage a mounted file system.
     class Mount < Chef::Resource
 
       identity_attr :device

data/lib/chef/resource/msu_package.rb

@@ -21,26 +21,25 @@ require "chef/mixin/uris"
 
 class Chef
   class Resource
+    # Use the msu_package resource to install Microsoft Update(MSU) packages on Microsoft Windows machines.
+    #
+    # @since 12.17
     class MsuPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
 
+      resource_name :msu_package
       provides :msu_package, os: "windows"
 
       allowed_actions :install, :remove
-
-      def initialize(name, run_context = nil)
-        super
-        @resource_name = :msu_package
-        @source = name
-        @action = :install
-      end
+      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)
+                end),
+                default: lazy { |r| r.package_name }
       property :checksum, String, desired_state: false
     end
   end

data/lib/chef/resource/ohai.rb

@@ -19,6 +19,8 @@
 
 class Chef
   class Resource
+    # 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.
     class Ohai < Chef::Resource
       resource_name :ohai
       provides :ohai