chef 18.9.4 → 18.11.11

data/lib/chef/resource/cron/cron.rb

@@ -33,76 +33,76 @@ class Chef
       description "Use the **cron** resource to manage cron entries for time-based job scheduling. Properties for a schedule will default to * if not provided. The cron resource requires access to a crontab program, typically cron. Warning: The cron resource should only be used to modify an entry in a crontab file. The `cron_d` resource directly manages `cron.d` files. This resource ships in #{ChefUtils::Dist::Infra::PRODUCT} 14.4 or later and can also be found in the [cron](https://github.com/chef-cookbooks/cron) cookbook) for previous #{ChefUtils::Dist::Infra::PRODUCT} releases."
 
       examples <<~'DOC'
-      **Run a program at a specified interval**
-
-      ```ruby
-      cron 'noop' do
-        hour '5'
-        minute '0'
-        command '/bin/true'
-      end
-      ```
-
-      **Run an entry if a folder exists**
-
-      ```ruby
-      cron 'ganglia_tomcat_thread_max' do
-        command "/usr/bin/gmetric
-          -n 'tomcat threads max'
-          -t uint32
-          -v '/usr/local/bin/tomcat-stat --thread-max'"
-        only_if { ::File.exist?('/home/jboss') }
-      end
-      ```
-
-      **Run every Saturday, 8:00 AM**
-
-      The following example shows a schedule that will run every hour at 8:00 each Saturday morning, and will then send an email to “admin@example.com” after each run.
-
-      ```ruby
-      cron 'name_of_cron_entry' do
-        minute '0'
-        hour '8'
-        weekday '6'
-        mailto 'admin@example.com'
-        action :create
-      end
-      ```
-
-      **Run once a week**
-
-      ```ruby
-      cron 'cookbooks_report' do
-        minute '0'
-        hour '0'
-        weekday '1'
-        user 'chefio'
-        mailto 'sysadmin@example.com'
-        home '/srv/supermarket/shared/system'
-        command %W{
-          cd /srv/supermarket/current &&
-          env RUBYLIB="/srv/supermarket/current/lib"
-          RAILS_ASSET_ID=`git rev-parse HEAD` RAILS_ENV="#{rails_env}"
-          bundle exec rake cookbooks_report
-        }.join(' ')
-        action :create
-      end
-      ```
-
-      **Run only in November**
-
-      The following example shows a schedule that will run at 8:00 PM, every weekday (Monday through Friday), but only in November:
-
-      ```ruby
-      cron 'name_of_cron_entry' do
-        minute '0'
-        hour '20'
-        day '*'
-        month '11'
-        weekday '1-5'
-        action :create
-      end
-      ```
+        **Run a program at a specified interval**
+
+        ```ruby
+        cron 'noop' do
+          hour '5'
+          minute '0'
+          command '/bin/true'
+        end
+        ```
+
+        **Run an entry if a folder exists**
+
+        ```ruby
+        cron 'ganglia_tomcat_thread_max' do
+          command "/usr/bin/gmetric
+            -n 'tomcat threads max'
+            -t uint32
+            -v '/usr/local/bin/tomcat-stat --thread-max'"
+          only_if { ::File.exist?('/home/jboss') }
+        end
+        ```
+
+        **Run every Saturday, 8:00 AM**
+
+        The following example shows a schedule that will run every hour at 8:00 each Saturday morning, and will then send an email to “admin@example.com” after each run.
+
+        ```ruby
+        cron 'name_of_cron_entry' do
+          minute '0'
+          hour '8'
+          weekday '6'
+          mailto 'admin@example.com'
+          action :create
+        end
+        ```
+
+        **Run once a week**
+
+        ```ruby
+        cron 'cookbooks_report' do
+          minute '0'
+          hour '0'
+          weekday '1'
+          user 'chefio'
+          mailto 'sysadmin@example.com'
+          home '/srv/supermarket/shared/system'
+          command %W{
+            cd /srv/supermarket/current &&
+            env RUBYLIB="/srv/supermarket/current/lib"
+            RAILS_ASSET_ID=`git rev-parse HEAD` RAILS_ENV="#{rails_env}"
+            bundle exec rake cookbooks_report
+          }.join(' ')
+          action :create
+        end
+        ```
+
+        **Run only in November**
+
+        The following example shows a schedule that will run at 8:00 PM, every weekday (Monday through Friday), but only in November:
+
+        ```ruby
+        cron 'name_of_cron_entry' do
+          minute '0'
+          hour '20'
+          day '*'
+          month '11'
+          weekday '1-5'
+          action :create
+        end
+        ```
       DOC
 
       state_attrs :minute, :hour, :day, :month, :weekday, :user

data/lib/chef/resource/csh.rb

@@ -24,11 +24,11 @@ class Chef
 
       provides :csh
 
-      description "Use the **csh** resource to execute scripts using the csh interpreter."\
-                  " This resource may also use any of 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`"\
+      description "Use the **csh** resource to execute scripts using the csh interpreter." \
+                  " This resource may also use any of 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."
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/directory.rb

@@ -27,11 +27,11 @@ class Chef
 
       provides :directory
 
-      description "Use the **directory** resource to manage a directory, which is a hierarchy"\
-                  " of folders that comprises all of the information stored on a computer."\
-                  " The root directory is the top-level, under which the rest of the directory"\
-                  " is organized. The directory resource uses the name property to specify the"\
-                  " path to a location in a directory. Typically, permission to access that"\
+      description "Use the **directory** resource to manage a directory, which is a hierarchy" \
+                  " of folders that comprises all of the information stored on a computer." \
+                  " The root directory is the top-level, under which the rest of the directory" \
+                  " is organized. The directory resource uses the name property to specify the" \
+                  " path to a location in a directory. Typically, permission to access that" \
                   " location in the directory is required."
 
       state_attrs :group, :mode, :owner
@@ -42,7 +42,7 @@ class Chef
       allowed_actions :create, :delete
 
       property :path, String, name_property: true,
-               description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
+        description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
 
       property :recursive, [ TrueClass, FalseClass ],
         description: "Create parent directories recursively, or delete directory and all children recursively. For the owner, group, and mode properties, the value of this property applies only to the leaf directory.",

data/lib/chef/resource/dpkg_package.rb

@@ -38,9 +38,9 @@ class Chef
         default: {}, desired_state: false
 
       property :allow_downgrade, [ TrueClass, FalseClass ],
-              description: "Allow downgrading a package to satisfy requested version requirements.",
-              default: true,
-              desired_state: false
+        description: "Allow downgrading a package to satisfy requested version requirements.",
+        default: true,
+        desired_state: false
 
       property :environment, Hash,
         introduced: "18.8",

data/lib/chef/resource/group.rb

@@ -25,27 +25,27 @@ class Chef
       description "Use the **group** resource to manage a local group."
 
       examples <<~EXAMPLES
-      The following examples demonstrate various approaches for using the **group** resource in recipes:
-
-      Append users to groups:
-
-      ```ruby
-      group 'www-data' do
-        action :modify
-        members 'maintenance'
-        append true
-      end
-      ```
-
-      Add a user to group on the Windows platform:
-
-      ```ruby
-      group 'Administrators' do
-        members ['domain\\foo']
-        append true
-        action :modify
-      end
-      ```
+        The following examples demonstrate various approaches for using the **group** resource in recipes:
+
+        Append users to groups:
+
+        ```ruby
+        group 'www-data' do
+          action :modify
+          members 'maintenance'
+          append true
+        end
+        ```
+
+        Add a user to group on the Windows platform:
+
+        ```ruby
+        group 'Administrators' do
+          members ['domain\\foo']
+          append true
+          action :modify
+        end
+        ```
       EXAMPLES
 
       provides :group
@@ -61,21 +61,21 @@ class Chef
         description: "The identifier for the group."
 
       property :members, [String, Array], default: [],
-               coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
-               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']`."
+        coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
+        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: [],
-               coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
-               description: "Remove users from a group. May only be used when `append` is set to `true`."
+        coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
+        description: "Remove users from a group. May only be used when `append` is set to `true`."
 
       property :append, [ TrueClass, FalseClass ], default: false,
-               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."
+        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: "Set to `true` if the group belongs to a system group."
+        description: "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` user resource provider."
+        description: "Allow gid duplication. May only be used with the `Groupadd` user resource provider."
 
       property :comment, String,
         introduced: "14.9",

data/lib/chef/resource/habitat/habitat_package.rb

@@ -27,102 +27,102 @@ class Chef
       description "Use the **habitat_package** to install or remove Chef Habitat packages from Habitat Builder."
       introduced "17.3"
       examples <<~DOC
-      **Install core/redis**
-
-      ```ruby
-      habitat_package 'core/redis'
-      ```
-
-      **Install specific version of a package from the unstable channel**
-
-      ```ruby
-      habitat_package 'core/redis' do
-        version '3.2.3'
-        channel 'unstable'
-      end
-      ```
-
-      **Install a package with specific version and revision**
-
-      ```ruby
-      habitat_package 'core/redis' do
-        version '3.2.3/20160920131015'
-      end
-      ```
-
-      **Install a package and force linking it's binary files to the system path**
-
-      ```ruby
-      habitat_package 'core/nginx' do
-        binlink :force
-      end
-      ```
-
-      **Install a package and link it's binary files to the system path**
-
-      ```ruby
-      habitat_package 'core/nginx' do
-        options '--binlink'
-      end
-      ```
-
-      **Remove package and all of it's versions**
-
-      ```ruby
-      habitat_package 'core/nginx'
-        action :remove
-      end
-      ```
-
-      **Remove specified version of a package**
-
-      ```ruby
-      habitat_package 'core/nginx/3.2.3'
-        action :remove
-      end
-      ```
-
-      **Remove package but retain some versions Note: Only available as of Habitat 1.5.86**
-
-      ```ruby
-      habitat_package 'core/nginx'
-        keep_latest '2'
-        action :remove
-      end
-      ```
-
-      ```ruby
-      **Remove package but keep dependencies**
-      habitat_package 'core/nginx'
-        no_deps false
-        action :remove
-      end
-      ```
+        **Install core/redis**
+
+        ```ruby
+        habitat_package 'core/redis'
+        ```
+
+        **Install specific version of a package from the unstable channel**
+
+        ```ruby
+        habitat_package 'core/redis' do
+          version '3.2.3'
+          channel 'unstable'
+        end
+        ```
+
+        **Install a package with specific version and revision**
+
+        ```ruby
+        habitat_package 'core/redis' do
+          version '3.2.3/20160920131015'
+        end
+        ```
+
+        **Install a package and force linking it's binary files to the system path**
+
+        ```ruby
+        habitat_package 'core/nginx' do
+          binlink :force
+        end
+        ```
+
+        **Install a package and link it's binary files to the system path**
+
+        ```ruby
+        habitat_package 'core/nginx' do
+          options '--binlink'
+        end
+        ```
+
+        **Remove package and all of it's versions**
+
+        ```ruby
+        habitat_package 'core/nginx'
+          action :remove
+        end
+        ```
+
+        **Remove specified version of a package**
+
+        ```ruby
+        habitat_package 'core/nginx/3.2.3'
+          action :remove
+        end
+        ```
+
+        **Remove package but retain some versions Note: Only available as of Habitat 1.5.86**
+
+        ```ruby
+        habitat_package 'core/nginx'
+          keep_latest '2'
+          action :remove
+        end
+        ```
+
+        ```ruby
+        **Remove package but keep dependencies**
+        habitat_package 'core/nginx'
+          no_deps false
+          action :remove
+        end
+        ```
       DOC
 
       property :bldr_url, String, default: "https://bldr.habitat.sh",
-      description: "The habitat builder url where packages will be downloaded from. **Defaults to public Habitat Builder**"
+        description: "The habitat builder url where packages will be downloaded from. **Defaults to public Habitat Builder**"
 
       property :channel, String, default: "stable",
-      description: "The release channel to install your package from."
+        description: "The release channel to install your package from."
 
-      property :auth_token, String,
-      description: "Auth token for installing a package from a private organization on Habitat builder."
+      property :auth_token, String, sensitive: true,
+        description: "Auth token for installing a package from a private organization on Habitat builder."
 
       property :binlink, [true, false, :force], default: false,
-      description: "If habitat should attempt to binlink the package. Acceptable values: `true`, `false`, `:force`. Will fail on binlinking if set to `true` and binary or binlink exists."
+        description: "If habitat should attempt to binlink the package. Acceptable values: `true`, `false`, `:force`. Will fail on binlinking if set to `true` and binary or binlink exists."
 
       property :options, String,
-      description: "Pass any additional parameters to the habitat package command."
+        description: "Pass any additional parameters to the habitat package command."
 
       property :keep_latest, String,
-      description: "Ability to uninstall while retaining a specified version **This feature only works in Habitat 1.5.86+.**"
+        description: "Ability to uninstall while retaining a specified version **This feature only works in Habitat 1.5.86+.**"
 
       property :exclude, String,
-      description: "Identifier of one or more packages that should not be uninstalled. (ex: core/redis, core/busybox-static/1.42.2/21120102031201)"
+        description: "Identifier of one or more packages that should not be uninstalled. (ex: core/redis, core/busybox-static/1.42.2/21120102031201)"
 
       property :no_deps, [true, false], default: false,
-      description: "Remove package but retain dependencies."
+        description: "Remove package but retain dependencies."
     end
   end
 end