chef 18.9.4 → 18.11.11

data/lib/chef/resource/sudo.rb

@@ -27,73 +27,73 @@ class Chef
 
       provides(:sudo) { true }
 
-      description "Use the **sudo** resource to add or remove individual sudo entries using sudoers.d files."\
-                  " Sudo version 1.7.2 or newer is required to use the sudo resource, as it relies on the"\
-                  " `#includedir` directive introduced in version 1.7.2. This resource does not enforce"\
-                  " installation of the required sudo version. Chef-supported releases of Ubuntu, SuSE, Debian,"\
+      description "Use the **sudo** resource to add or remove individual sudo entries using sudoers.d files." \
+                  " Sudo version 1.7.2 or newer is required to use the sudo resource, as it relies on the" \
+                  " `#includedir` directive introduced in version 1.7.2. This resource does not enforce" \
+                  " installation of the required sudo version. Chef-supported releases of Ubuntu, SuSE, Debian," \
                   " and RHEL (6+) all support this feature."
       introduced "14.0"
       examples <<~DOC
-      **Grant a user sudo privileges for any command**
+        **Grant a user sudo privileges for any command**
 
-      ```ruby
-      sudo 'admin' do
-        user 'admin'
-      end
-      ```
+        ```ruby
+        sudo 'admin' do
+          user 'admin'
+        end
+        ```
 
-      **Grant a user and groups sudo privileges for any command**
+        **Grant a user and groups sudo privileges for any command**
 
-      ```ruby
-      sudo 'admins' do
-        users 'bob'
-        groups 'sysadmins, superusers'
-      end
-      ```
+        ```ruby
+        sudo 'admins' do
+          users 'bob'
+          groups 'sysadmins, superusers'
+        end
+        ```
 
-      **Grant passwordless sudo privileges for specific commands**
+        **Grant passwordless sudo privileges for specific commands**
 
-      ```ruby
-      sudo 'passwordless-access' do
-        commands ['/bin/systemctl restart httpd', '/bin/systemctl restart mysql']
-        nopasswd true
-      end
-      ```
-
-      **Create command aliases and assign them to a group**
-
-      ```ruby
-      sudo 'webteam' do
-        command_aliases [
-          {
-            'name': 'WEBTEAM_SYSTEMD_JBOSS',
-            'command_list': [
-              '/usr/bin/systemctl start eap7-standalone.service',
-              '/usr/bin/systemctl start jbcs-httpd24-httpd.service', \
-              '/usr/bin/systemctl stop eap7-standalone.service', \
-              '/usr/bin/systemctl stop jbcs-httpd24-httpd.service', \
-              '/usr/bin/systemctl restart eap7-standalone.service', \
-              '/usr/bin/systemctl restart jbcs-httpd24-httpd.service', \
-              '/usr/bin/systemctl --full edit eap7-standalone.service', \
-              '/usr/bin/systemctl --full edit jbcs-httpd24-httpd.service', \
-              '/usr/bin/systemctl daemon-reload',
-            ]
-          },
-          {
-            'name': 'GENERIC_SYSTEMD',
-            'command_list': [
-              '/usr/sbin/systemctl list-unit-files',
-              '/usr/sbin/systemctl list-timers', \
-              '/usr/sbin/systemctl is-active *', \
-              '/usr/sbin/systemctl is-enabled *',
+        ```ruby
+        sudo 'passwordless-access' do
+          commands ['/bin/systemctl restart httpd', '/bin/systemctl restart mysql']
+          nopasswd true
+        end
+        ```
+
+        **Create command aliases and assign them to a group**
+
+        ```ruby
+        sudo 'webteam' do
+          command_aliases [
+            {
+              'name': 'WEBTEAM_SYSTEMD_JBOSS',
+              'command_list': [
+                '/usr/bin/systemctl start eap7-standalone.service',
+                '/usr/bin/systemctl start jbcs-httpd24-httpd.service', \
+                '/usr/bin/systemctl stop eap7-standalone.service', \
+                '/usr/bin/systemctl stop jbcs-httpd24-httpd.service', \
+                '/usr/bin/systemctl restart eap7-standalone.service', \
+                '/usr/bin/systemctl restart jbcs-httpd24-httpd.service', \
+                '/usr/bin/systemctl --full edit eap7-standalone.service', \
+                '/usr/bin/systemctl --full edit jbcs-httpd24-httpd.service', \
+                '/usr/bin/systemctl daemon-reload',
               ]
-          }
-        ]
-        nopasswd true
-        users '%webteam'
-        commands [ 'WEBTEAM_SYSTEMD_JBOSS', 'GENERIC_SYSTEMD' ]
-      end
-      ```
+            },
+            {
+              'name': 'GENERIC_SYSTEMD',
+              'command_list': [
+                '/usr/sbin/systemctl list-unit-files',
+                '/usr/sbin/systemctl list-timers', \
+                '/usr/sbin/systemctl is-active *', \
+                '/usr/sbin/systemctl is-enabled *',
+                ]
+            }
+          ]
+          nopasswd true
+          users '%webteam'
+          commands [ 'WEBTEAM_SYSTEMD_JBOSS', 'GENERIC_SYSTEMD' ]
+        end
+        ```
       DOC
 
       # According to the sudo man pages sudo will ignore files in an include dir that have a `.` or `~`
@@ -235,16 +235,16 @@ class Chef
             local true
             mode "0440"
             variables sudoer:            (new_resource.groups + new_resource.users).join(","),
-                      host:               new_resource.host,
-                      runas:              new_resource.runas,
-                      nopasswd:           new_resource.nopasswd,
-                      noexec:             new_resource.noexec,
-                      commands:           new_resource.commands,
-                      command_aliases:    new_resource.command_aliases,
-                      defaults:           new_resource.defaults,
-                      setenv:             new_resource.setenv,
-                      env_keep_add:       new_resource.env_keep_add,
-                      env_keep_subtract:  new_resource.env_keep_subtract
+              host:               new_resource.host,
+              runas:              new_resource.runas,
+              nopasswd:           new_resource.nopasswd,
+              noexec:             new_resource.noexec,
+              commands:           new_resource.commands,
+              command_aliases:    new_resource.command_aliases,
+              defaults:           new_resource.defaults,
+              setenv:             new_resource.setenv,
+              env_keep_add:       new_resource.env_keep_add,
+              env_keep_subtract:  new_resource.env_keep_subtract
             verify visudo_content(file_path) if visudo_present?
             action :create
           end

data/lib/chef/resource/swap_file.rb

@@ -26,21 +26,21 @@ class Chef
       description "Use the **swap_file** resource to create or delete swap files on Linux systems, and optionally to manage the swappiness configuration for a host."
       introduced "14.0"
       examples <<~DOC
-      **Create a swap file**
+        **Create a swap file**
 
-      ```ruby
-      swap_file '/dev/sda1' do
-        size 1024
-      end
-      ```
+        ```ruby
+        swap_file '/dev/sda1' do
+          size 1024
+        end
+        ```
 
-      **Remove a swap file**
+        **Remove a swap file**
 
-      ```ruby
-      swap_file '/dev/sda1' do
-        action :remove
-      end
-      ```
+        ```ruby
+        swap_file '/dev/sda1' do
+          action :remove
+        end
+        ```
       DOC
 
       property :path, String,

data/lib/chef/resource/sysctl.rb

@@ -26,63 +26,63 @@ class Chef
 
       description "Use the **sysctl** resource to set or remove kernel parameters using the `sysctl` command line tool and configuration files in the system's `sysctl.d` directory. Configuration files managed by this resource are named `99-chef-KEYNAME.conf`."
       examples <<~DOC
-      **Set vm.swappiness**:
+        **Set vm.swappiness**:
 
-      ```ruby
-      sysctl 'vm.swappiness' do
-        value 19
-      end
-      ```
+        ```ruby
+        sysctl 'vm.swappiness' do
+          value 19
+        end
+        ```
 
-      **Remove kernel.msgmax**:
+        **Remove kernel.msgmax**:
 
-      **Note**: This only removes the sysctl.d config for kernel.msgmax. The value will be set back to the kernel default value.
+        **Note**: This only removes the sysctl.d config for kernel.msgmax. The value will be set back to the kernel default value.
 
-      ```ruby
-      sysctl 'kernel.msgmax' do
-        action :remove
-      end
-      ```
+        ```ruby
+        sysctl 'kernel.msgmax' do
+          action :remove
+        end
+        ```
 
-      **Adding Comments to sysctl configuration files**:
+        **Adding Comments to sysctl configuration files**:
 
-      ```ruby
-      sysctl 'vm.swappiness' do
-        value 19
-        comment "define how aggressively the kernel will swap memory pages."
-      end
-      ```
+        ```ruby
+        sysctl 'vm.swappiness' do
+          value 19
+          comment "define how aggressively the kernel will swap memory pages."
+        end
+        ```
 
-      This produces /etc/sysctl.d/99-chef-vm.swappiness.conf as follows:
+        This produces /etc/sysctl.d/99-chef-vm.swappiness.conf as follows:
 
-      ```
-      # define how aggressively the kernel will swap memory pages.
-      vm.swappiness = 1
-      ```
+        ```
+        # define how aggressively the kernel will swap memory pages.
+        vm.swappiness = 1
+        ```
 
-      **Converting sysctl settings from shell scripts**:
+        **Converting sysctl settings from shell scripts**:
 
-      Example of existing settings:
+        Example of existing settings:
 
-      ```bash
-      fs.aio-max-nr = 1048576 net.ipv4.ip_local_port_range = 9000 65500 kernel.sem = 250 32000 100 128
-      ```
+        ```bash
+        fs.aio-max-nr = 1048576 net.ipv4.ip_local_port_range = 9000 65500 kernel.sem = 250 32000 100 128
+        ```
 
-      Converted to sysctl resources:
+        Converted to sysctl resources:
 
-      ```ruby
-      sysctl 'fs.aio-max-nr' do
-        value '1048576'
-      end
+        ```ruby
+        sysctl 'fs.aio-max-nr' do
+          value '1048576'
+        end
 
-      sysctl 'net.ipv4.ip_local_port_range' do
-        value '9000 65500'
-      end
+        sysctl 'net.ipv4.ip_local_port_range' do
+          value '9000 65500'
+        end
 
-      sysctl 'kernel.sem' do
-        value '250 32000 100 128'
-      end
-      ```
+        sysctl 'kernel.sem' do
+          value '250 32000 100 128'
+        end
+        ```
       DOC
 
       introduced "14.0"

data/lib/chef/resource/systemd_unit.rb

@@ -29,45 +29,45 @@ class Chef
       description "Use the **systemd_unit** resource to create, manage, and run [systemd units](https://www.freedesktop.org/software/systemd/man/systemd.html#Concepts)."
       introduced "12.11"
       examples <<~DOC
-      **Create systemd service unit file from a Hash**
-
-      ```ruby
-      systemd_unit 'etcd.service' do
-        content({ Unit: {
-                  Description: 'Etcd',
-                  Documentation: ['https://coreos.com/etcd', 'man:etcd(1)'],
-                  After: 'network.target',
-                },
-                Service: {
-                  Type: 'notify',
-                  ExecStart: '/usr/local/etcd',
-                  Restart: 'always',
-                },
-                Install: {
-                  WantedBy: 'multi-user.target',
-                } })
-        action [:create, :enable]
-      end
-      ```
+        **Create systemd service unit file from a Hash**
+
+        ```ruby
+        systemd_unit 'etcd.service' do
+          content({ Unit: {
+                    Description: 'Etcd',
+                    Documentation: ['https://coreos.com/etcd', 'man:etcd(1)'],
+                    After: 'network.target',
+                  },
+                  Service: {
+                    Type: 'notify',
+                    ExecStart: '/usr/local/etcd',
+                    Restart: 'always',
+                  },
+                  Install: {
+                    WantedBy: 'multi-user.target',
+                  } })
+          action [:create, :enable]
+        end
+        ```
 
-      **Create systemd service unit file from a String**
+        **Create systemd service unit file from a String**
 
-      ```ruby
-      systemd_unit 'sysstat-collect.timer' do
-        content <<~EOU
-        [Unit]
-        Description=Run system activity accounting tool every 10 minutes
+        ```ruby
+        systemd_unit 'sysstat-collect.timer' do
+          content <<~EOU
+          [Unit]
+          Description=Run system activity accounting tool every 10 minutes
 
-        [Timer]
-        OnCalendar=*:00/10
+          [Timer]
+          OnCalendar=*:00/10
 
-        [Install]
-        WantedBy=sysstat.service
-        EOU
+          [Install]
+          WantedBy=sysstat.service
+          EOU
 
-        action [:create, :enable]
-      end
-      ```
+          action [:create, :enable]
+        end
+        ```
       DOC
 
       default_action :nothing
@@ -89,7 +89,7 @@ class Chef
 
       # User-provided properties
       property :user, String, desired_state: false,
-               description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'."
+        description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'."
 
       property :content, [String, Hash],
         description: "A string or hash that contains a systemd [unit file](https://www.freedesktop.org/software/systemd/man/systemd.unit.html) definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In #{ChefUtils::Dist::Infra::PRODUCT} 14.4 or later, repeatable options can be implemented with an array."
@@ -103,9 +103,9 @@ class Chef
         description: "Specifies if the unit will be verified before installation. Systemd can be overly strict when verifying units, so in certain cases it is preferable not to verify the unit."
 
       property :unit_name, String, desired_state: false,
-               name_property: true,
-               description: "The name of the unit file if it differs from the resource block's name.",
-               introduced: "13.7"
+        name_property: true,
+        description: "The name of the unit file if it differs from the resource block's name.",
+        introduced: "13.7"
 
       def to_ini
         case content

data/lib/chef/resource/timezone.rb

@@ -28,27 +28,27 @@ class Chef
       description "Use the **timezone** resource to change the system timezone on Windows, Linux, and macOS hosts. Timezones are specified in tz database format, with a complete list of available TZ values for Linux and macOS here: <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>. On Windows systems run `tzutil /l` for a complete list of valid timezones."
       introduced "14.6"
       examples <<~DOC
-      **Set the timezone to UTC**
+        **Set the timezone to UTC**
 
-      ```ruby
-      timezone 'UTC'
-      ```
+        ```ruby
+        timezone 'UTC'
+        ```
 
-      **Set the timezone to America/Los_Angeles with a friendly resource name on Linux/macOS**
+        **Set the timezone to America/Los_Angeles with a friendly resource name on Linux/macOS**
 
-      ```ruby
-      timezone "Set the host's timezone to America/Los_Angeles" do
-        timezone 'America/Los_Angeles'
-      end
-      ```
+        ```ruby
+        timezone "Set the host's timezone to America/Los_Angeles" do
+          timezone 'America/Los_Angeles'
+        end
+        ```
 
-      **Set the timezone to PST with a friendly resource name on Windows**
+        **Set the timezone to PST with a friendly resource name on Windows**
 
-      ```ruby
-      timezone "Set the host's timezone to PST" do
-        timezone 'Pacific Standard time'
-      end
-      ```
+        ```ruby
+        timezone "Set the host's timezone to PST" do
+          timezone 'Pacific Standard time'
+        end
+        ```
       DOC
 
       property :timezone, String,

data/lib/chef/resource/user/mac_user.rb

@@ -90,9 +90,9 @@ class Chef
 
           password
         },
-        callbacks: {
-          "Password length must be >= 4" => ->(password) { password.size >= 4 },
-        }
+          callbacks: {
+            "Password length must be >= 4" => ->(password) { password.size >= 4 },
+          }
 
         # Overload home so we set our default.
         property :home, String, description: "The user home directory", default: lazy { "/Users/#{name}" }

data/lib/chef/resource/user.rb

@@ -74,14 +74,14 @@ class Chef
       alias_method :group, :gid
 
       property :expire_date, [ String, NilClass ],
-               description: "(Linux) The date on which the user account will be disabled. The date is specified in YYYY-MM-DD format.",
-               introduced: "18.0",
-               desired_state: false
+        description: "(Linux) The date on which the user account will be disabled. The date is specified in YYYY-MM-DD format.",
+        introduced: "18.0",
+        desired_state: false
 
       property :inactive, [ String, Integer, NilClass ],
-               description: "(Linux) The number of days after a password expires until the account is permanently disabled. A value of `0` disables the account as soon as the password has expired, and a value of `-1` disables the feature.",
-               introduced: "18.0",
-               desired_state: false
+        description: "(Linux) The number of days after a password expires until the account is permanently disabled. A value of `0` disables the account as soon as the password has expired, and a value of `-1` disables the feature.",
+        introduced: "18.0",
+        desired_state: false
     end
   end
 end

data/lib/chef/resource/user_ulimit.rb

@@ -28,31 +28,31 @@ class Chef
       description "Use the **user_ulimit** resource to create individual ulimit files that are installed into the `/etc/security/limits.d/` directory."
       introduced "16.0"
       examples <<~DOC
-      **Set filehandle limit for the tomcat user**:
+        **Set filehandle limit for the tomcat user**:
 
-      ```ruby
-      user_ulimit 'tomcat' do
-        filehandle_limit 8192
-      end
-      ```
+        ```ruby
+        user_ulimit 'tomcat' do
+          filehandle_limit 8192
+        end
+        ```
 
-      **Specify a username that differs from the name given to the resource block**:
+        **Specify a username that differs from the name given to the resource block**:
 
-      ```ruby
-      user_ulimit 'Bump filehandle limits for tomcat user' do
-        username 'tomcat'
-        filehandle_limit 8192
-      end
-      ```
+        ```ruby
+        user_ulimit 'Bump filehandle limits for tomcat user' do
+          username 'tomcat'
+          filehandle_limit 8192
+        end
+        ```
 
-      **Set filehandle limit for the tomcat user with a non-default filename**:
+        **Set filehandle limit for the tomcat user with a non-default filename**:
 
-      ```ruby
-      user_ulimit 'tomcat' do
-        filehandle_limit 8192
-        filename 'tomcat_filehandle_limits.conf'
-      end
-      ```
+        ```ruby
+        user_ulimit 'tomcat' do
+          filehandle_limit 8192
+          filename 'tomcat_filehandle_limits.conf'
+        end
+        ```
       DOC
 
       property :username, String, name_property: true
@@ -93,8 +93,8 @@ class Chef
       property :rtprio_hard_limit, [String, Integer]
       property :virt_limit, [String, Integer]
       property :filename, String,
-               coerce: proc { |m| m.end_with?(".conf") ? m : m + ".conf" },
-               default: lazy { |r| r.username == "*" ? "00_all_limits.conf" : "#{r.username}_limits.conf" }
+        coerce: proc { |m| m.end_with?(".conf") ? m : m + ".conf" },
+        default: lazy { |r| r.username == "*" ? "00_all_limits.conf" : "#{r.username}_limits.conf" }
 
       action :create, description: "Create a ulimit configuration file." do
         template "/etc/security/limits.d/#{new_resource.filename}" do

data/lib/chef/resource/windows_ad_join.rb

@@ -26,33 +26,33 @@ class Chef
       description "Use the **windows_ad_join** resource to join a Windows Active Directory domain."
       introduced "14.0"
       examples <<~DOC
-      **Join a domain**
+        **Join a domain**
 
-      ```ruby
-      windows_ad_join 'ad.example.org' do
-        domain_user 'nick'
-        domain_password 'p@ssw0rd1'
-      end
-      ```
+        ```ruby
+        windows_ad_join 'ad.example.org' do
+          domain_user 'nick'
+          domain_password 'p@ssw0rd1'
+        end
+        ```
 
-      **Join a domain, as `win-workstation`**
+        **Join a domain, as `win-workstation`**
 
-      ```ruby
-      windows_ad_join 'ad.example.org' do
-        domain_user 'nick'
-        domain_password 'p@ssw0rd1'
-        new_hostname 'win-workstation'
-      end
-      ```
+        ```ruby
+        windows_ad_join 'ad.example.org' do
+          domain_user 'nick'
+          domain_password 'p@ssw0rd1'
+          new_hostname 'win-workstation'
+        end
+        ```
 
-      **Leave the current domain and re-join the `local` workgroup**
+        **Leave the current domain and re-join the `local` workgroup**
 
-      ```ruby
-      windows_ad_join 'Leave domain' do
-        action :leave
-        workgroup 'local'
-      end
-      ```
+        ```ruby
+        windows_ad_join 'Leave domain' do
+          action :leave
+          workgroup 'local'
+        end
+        ```
       DOC
 
       property :domain_name, String,
@@ -65,7 +65,7 @@ class Chef
         description: "The domain user that will be used to join the domain.",
         required: true
 
-      property :domain_password, String,
+      property :domain_password, String, sensitive: true,
         description: "The password for the domain user. Note that this resource is set to hide sensitive information by default. ",
         required: true
 
@@ -97,7 +97,7 @@ class Chef
 
       action :join, description: "Join the Active Directory domain." do
         unless on_desired_domain?
-          cmd = "$pswd = ConvertTo-SecureString \'#{new_resource.domain_password}\' -AsPlainText -Force;"
+          cmd = "$pswd = ConvertTo-SecureString '#{new_resource.domain_password}' -AsPlainText -Force;"
           cmd << "$credential = New-Object System.Management.Automation.PSCredential (\"#{sanitize_usename}\",$pswd);"
           cmd << "Add-Computer -DomainName #{new_resource.domain_name} -Credential $credential"
           cmd << " -OUPath \"#{new_resource.ou_path}\"" if new_resource.ou_path
@@ -128,7 +128,7 @@ class Chef
       action :leave, description: "Leave an Active Directory domain and re-join a workgroup." do
         if joined_to_domain?
           cmd = ""
-          cmd << "$pswd = ConvertTo-SecureString \'#{new_resource.domain_password}\' -AsPlainText -Force;"
+          cmd << "$pswd = ConvertTo-SecureString '#{new_resource.domain_password}' -AsPlainText -Force;"
           cmd << "$credential = New-Object System.Management.Automation.PSCredential (\"#{sanitize_usename}\",$pswd);"
           cmd << "Remove-Computer"
           cmd << " -UnjoinDomainCredential $credential"