chef 18.9.4 → 18.11.11

data/lib/chef/resource/selinux_boolean.rb

@@ -25,21 +25,21 @@ class Chef
       description "Use **selinux_boolean** resource to set SELinux boolean values."
       introduced "18.0"
       examples <<~DOC
-      **Set ssh_keysign to true**:
+        **Set ssh_keysign to true**:
 
-      ```ruby
-      selinux_boolean 'ssh_keysign' do
-        value true
-      end
-      ```
+        ```ruby
+        selinux_boolean 'ssh_keysign' do
+          value true
+        end
+        ```
 
-      **Set ssh_sysadm_login to 'on'**:
+        **Set ssh_sysadm_login to 'on'**:
 
-      ```ruby
-      selinux_boolean 'ssh_sysadm_login' do
-        value 'on'
-      end
-      ```
+        ```ruby
+        selinux_boolean 'ssh_sysadm_login' do
+          value 'on'
+        end
+        ```
       DOC
 
       property :boolean, String,

data/lib/chef/resource/selinux_fcontext.rb

@@ -25,36 +25,36 @@ class Chef
       description "Use the **selinux_fcontext** resource to set the SELinux context of files using the `semanage fcontext` command."
       introduced "18.0"
       examples <<~DOC
-      **Allow http servers (e.g. nginx/apache) to modify moodle files**:
+        **Allow http servers (e.g. nginx/apache) to modify moodle files**:
 
-      ```ruby
-      selinux_fcontext '/var/www/moodle(/.*)?' do
-        secontext 'httpd_sys_rw_content_t'
-      end
-      ```
+        ```ruby
+        selinux_fcontext '/var/www/moodle(/.*)?' do
+          secontext 'httpd_sys_rw_content_t'
+        end
+        ```
 
-      **Adapt a symbolic link**:
+        **Adapt a symbolic link**:
 
-      ```ruby
-      selinux_fcontext '/var/www/symlink_to_webroot' do
-        secontext 'httpd_sys_rw_content_t'
-        file_type 'l'
-      end
-      ```
+        ```ruby
+        selinux_fcontext '/var/www/symlink_to_webroot' do
+          secontext 'httpd_sys_rw_content_t'
+          file_type 'l'
+        end
+        ```
       DOC
 
       property :file_spec, String,
-                name_property: true,
-                description: "Path to or regex matching the files or directories to label."
+        name_property: true,
+        description: "Path to or regex matching the files or directories to label."
 
       property :secontext, String,
-                required: %i{add modify manage},
-                description: "SELinux context to assign."
+        required: %i{add modify manage},
+        description: "SELinux context to assign."
 
       property :file_type, String,
-                default: "a",
-                equal_to: %w{a f d c b s l p},
-                description: "The type of the file being labeled."
+        default: "a",
+        equal_to: %w{a f d c b s l p},
+        description: "The type of the file being labeled."
 
       action_class do
         include Chef::SELinux::CommonHelpers
@@ -157,4 +157,4 @@ class Chef
       end
     end
   end
-end
+end

data/lib/chef/resource/selinux_install.rb

@@ -23,31 +23,31 @@ class Chef
       description "Use **selinux_install** resource to encapsulates the set of selinux packages to install in order to manage selinux. It also ensures the directory `/etc/selinux` is created."
       introduced "18.0"
       examples <<~DOC
-      **Default installation**:
+        **Default installation**:
 
-      ```ruby
-      selinux_install 'example'
-      ```
+        ```ruby
+        selinux_install 'example'
+        ```
 
-      **Install with custom packages**:
+        **Install with custom packages**:
 
-      ```ruby
-      selinux_install 'example' do
-        packages %w(policycoreutils selinux-policy selinux-policy-targeted)
-      end
-      ```
+        ```ruby
+        selinux_install 'example' do
+          packages %w(policycoreutils selinux-policy selinux-policy-targeted)
+        end
+        ```
 
-      **Uninstall**
-      ```ruby
-      selinux_install 'example' do
-        action :remove
-      end
-      ```
+        **Uninstall**
+        ```ruby
+        selinux_install 'example' do
+          action :remove
+        end
+        ```
       DOC
 
       property :packages, [String, Array],
-                default: lazy { default_install_packages },
-                description: "SELinux packages for system."
+        default: lazy { default_install_packages },
+        description: "SELinux packages for system."
 
       action_class do
         def do_package_action(action)

data/lib/chef/resource/selinux_login.rb

@@ -24,25 +24,25 @@ class Chef
       description "Use the **selinux_login** resource to add, update, or remove SELinux user to OS login mappings."
       introduced "18.1"
       examples <<~DOC
-      **Manage test OS user mapping with a range of s0 and associated SELinux user test_u**:
+        **Manage test OS user mapping with a range of s0 and associated SELinux user test_u**:
 
-      ```ruby
-      selinux_login 'test' do
-        user 'test_u'
-        range 's0'
-      end
-      ```
+        ```ruby
+        selinux_login 'test' do
+          user 'test_u'
+          range 's0'
+        end
+        ```
       DOC
 
       property :login, String,
-                name_property: true,
-                description: "An optional property to set the OS user login value if it differs from the resource block's name."
+        name_property: true,
+        description: "An optional property to set the OS user login value if it differs from the resource block's name."
 
       property :user, String,
-                description: "SELinux user to be mapped."
+        description: "SELinux user to be mapped."
 
       property :range, String,
-                description: "MLS/MCS security range for the SELinux user."
+        description: "MLS/MCS security range for the SELinux user."
 
       load_current_value do |new_resource|
         logins = shell_out!("semanage login -l").stdout.split("\n")

data/lib/chef/resource/selinux_module.rb

@@ -23,33 +23,33 @@ class Chef
       description "Use **selinux_module** module resource to create an SELinux policy module from a cookbook file or content provided as a string."
       introduced "18.0"
       examples <<~DOC
-      **Creating SElinux module from .te file located at `files` directory of your cookbook.**:
+        **Creating SElinux module from .te file located at `files` directory of your cookbook.**:
 
-      ```ruby
-      selinux_module 'my_policy_module' do
-        source 'my_policy_module.te'
-        action :create
-      end
-      ```
+        ```ruby
+        selinux_module 'my_policy_module' do
+          source 'my_policy_module.te'
+          action :create
+        end
+        ```
       DOC
 
       property :module_name, String,
-                name_property: true,
-                description: "Override the module name."
+        name_property: true,
+        description: "Override the module name."
 
       property :source, String,
-                description: "Module source file name."
+        description: "Module source file name."
 
       property :content, String,
-                description: "Module source as String."
+        description: "Module source as String."
 
       property :cookbook, String,
-                description: "Cookbook to source from module source file from(if it is not located in the current cookbook). The default value is the current cookbook.",
-                desired_state: false
+        description: "Cookbook to source from module source file from(if it is not located in the current cookbook). The default value is the current cookbook.",
+        desired_state: false
 
       property :base_dir, String,
-                default: "/etc/selinux/local",
-                description: "Directory to create module source file in."
+        default: "/etc/selinux/local",
+        description: "Directory to create module source file in."
 
       action_class do
         def selinux_module_filepath(type)
@@ -140,4 +140,4 @@ class Chef
       end
     end
   end
-end
+end

data/lib/chef/resource/selinux_permissive.rb

@@ -23,18 +23,18 @@ class Chef
       description "Use the **selinux_permissive** resource to allow some domains to misbehave without stopping them. This is not as good as setting specific policies, but better than disabling SELinux entirely."
       introduced "18.0"
       examples <<~DOC
-      **Disable enforcement on Apache**:
+        **Disable enforcement on Apache**:
 
-      ```ruby
-      selinux_permissive 'httpd_t' do
-        notifies :restart, 'service[httpd]'
-      end
-      ```
+        ```ruby
+        selinux_permissive 'httpd_t' do
+          notifies :restart, 'service[httpd]'
+        end
+        ```
       DOC
 
       property :context, String,
-                name_property: true,
-                description: "The SELinux context to permit."
+        name_property: true,
+        description: "The SELinux context to permit."
 
       action_class do
         def current_permissives
@@ -61,4 +61,4 @@ class Chef
       end
     end
   end
-end
+end

data/lib/chef/resource/selinux_port.rb

@@ -24,29 +24,29 @@ class Chef
       description "Use the **selinux_port** resource to assign a network port to a specific SELinux context. For example, running a web server on a non-standard port."
       introduced "18.0"
       examples <<~DOC
-      **Allow nginx/apache to bind to port 5678 by giving it the http_port_t context**:
+        **Allow nginx/apache to bind to port 5678 by giving it the http_port_t context**:
 
-      ```ruby
-      selinux_port '5678' do
-       protocol 'tcp'
-       secontext 'http_port_t'
-      end
-      ```
+        ```ruby
+        selinux_port '5678' do
+         protocol 'tcp'
+         secontext 'http_port_t'
+        end
+        ```
       DOC
 
       property :port, [Integer, String],
-                name_property: true,
-                regex: /^\d+$/,
-                description: "Port to modify."
+        name_property: true,
+        regex: /^\d+$/,
+        description: "Port to modify."
 
       property :protocol, String,
-                equal_to: %w{tcp udp},
-                required: %i{manage add modify},
-                description: "Protocol to modify."
+        equal_to: %w{tcp udp},
+        required: %i{manage add modify},
+        description: "Protocol to modify."
 
       property :secontext, String,
-                required: %i{manage add modify},
-                description: "SELinux context to assign to the port."
+        required: %i{manage add modify},
+        description: "SELinux context to assign to the port."
 
       action_class do
         include Chef::SELinux::CommonHelpers
@@ -115,4 +115,4 @@ class Chef
 
     end
   end
-end
+end

data/lib/chef/resource/selinux_state.rb

@@ -24,48 +24,48 @@ class Chef
       description "Use **selinux_state** resource to manages the SELinux state on the system. It does this by using the `setenforce` command and rendering the `/etc/selinux/config` file from a template."
       introduced "18.0"
       examples <<~DOC
-      **Set SELinux state to permissive**:
+        **Set SELinux state to permissive**:
 
-      ```ruby
-      selinux_state 'permissive' do
-        action :permissive
-      end
-      ```
+        ```ruby
+        selinux_state 'permissive' do
+          action :permissive
+        end
+        ```
 
-      **Set SELinux state to enforcing**:
+        **Set SELinux state to enforcing**:
 
-      ```ruby
-      selinux_state 'enforcing' do
-        action :enforcing
-      end
-      ```
+        ```ruby
+        selinux_state 'enforcing' do
+          action :enforcing
+        end
+        ```
 
-      **Set SELinux state to disabled**:
-      ```ruby
-      selinux_state 'disabled' do
-        action :disabled
-      end
-      ```
+        **Set SELinux state to disabled**:
+        ```ruby
+        selinux_state 'disabled' do
+          action :disabled
+        end
+        ```
       DOC
 
       default_action :nothing
 
       property :config_file, String,
-                default: "/etc/selinux/config",
-                description: "Path to SELinux config file on disk."
+        default: "/etc/selinux/config",
+        description: "Path to SELinux config file on disk."
 
       property :persistent, [true, false],
-                default: true,
-                description: "Set the status update in the SELinux configuration file."
+        default: true,
+        description: "Set the status update in the SELinux configuration file."
 
       property :policy, String,
-                default: lazy { default_policy_platform },
-                equal_to: %w{default minimum mls src strict targeted},
-                description: "SELinux policy type."
+        default: lazy { default_policy_platform },
+        equal_to: %w{default minimum mls src strict targeted},
+        description: "SELinux policy type."
 
       property :automatic_reboot, [true, false, Symbol],
-                default: false,
-                description: "Perform an automatic node reboot if required for state change."
+        default: false,
+        description: "Perform an automatic node reboot if required for state change."
 
       deprecated_property_alias "temporary", "persistent", "The temporary property was renamed persistent in the 4.0 release of this cookbook. Please update your cookbooks to use the new property name."
 
@@ -163,4 +163,4 @@ class Chef
       end
     end
   end
-end
+end

data/lib/chef/resource/selinux_user.rb

@@ -24,30 +24,30 @@ class Chef
       description "Use the **selinux_user** resource to add, update, or remove SELinux users."
       introduced "18.1"
       examples <<~DOC
-      **Manage test_u SELinux user with a level and range of s0 and roles sysadm_r and staff_r**:
+        **Manage test_u SELinux user with a level and range of s0 and roles sysadm_r and staff_r**:
 
-      ```ruby
-      selinux_user 'test_u' do
-        level 's0'
-        range 's0'
-        roles %w(sysadm_r staff_r)
-      end
-      ```
+        ```ruby
+        selinux_user 'test_u' do
+          level 's0'
+          range 's0'
+          roles %w(sysadm_r staff_r)
+        end
+        ```
       DOC
 
       property :user, String,
-                name_property: true,
-                description: "An optional property to set the SELinux user value if it differs from the resource block's name."
+        name_property: true,
+        description: "An optional property to set the SELinux user value if it differs from the resource block's name."
 
       property :level, String,
-                description: "MLS/MCS security level for the SELinux user."
+        description: "MLS/MCS security level for the SELinux user."
 
       property :range, String,
-                description: "MLS/MCS security range for the SELinux user."
+        description: "MLS/MCS security range for the SELinux user."
 
       property :roles, Array,
-                description: "Associated SELinux roles for the user.",
-                coerce: proc { |r| Array(r).sort }
+        description: "Associated SELinux roles for the user.",
+        coerce: proc { |r| Array(r).sort }
 
       load_current_value do |new_resource|
         users = shell_out!("semanage user -l").stdout.split("\n")

data/lib/chef/resource/service.rb

@@ -38,8 +38,8 @@ class Chef
 
       # this is a poor API please do not re-use this pattern
       property :supports, Hash, default: { restart: nil, reload: nil, status: nil },
-               description: "A list of properties that controls how #{ChefUtils::Dist::Infra::PRODUCT} is to attempt to manage a service: :restart, :reload, :status. For :restart, the init script or other service provider can use a restart command; if :restart is not specified, the #{ChefUtils::Dist::Infra::CLIENT} attempts to stop and then start a service. For :reload, the init script or other service provider can use a reload command. For :status, the init script or other service provider can use a status command to determine if the service is running; if :status is not specified, the #{ChefUtils::Dist::Infra::CLIENT} attempts to match the service_name against the process table as a regular expression, unless a pattern is specified as a parameter property. Default value: { restart: false, reload: false, status: false } for all platforms (except for the Red Hat platform family, which defaults to { restart: false, reload: false, status: true }.)",
-               coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
+        description: "A list of properties that controls how #{ChefUtils::Dist::Infra::PRODUCT} is to attempt to manage a service: :restart, :reload, :status. For :restart, the init script or other service provider can use a restart command; if :restart is not specified, the #{ChefUtils::Dist::Infra::CLIENT} attempts to stop and then start a service. For :reload, the init script or other service provider can use a reload command. For :status, the init script or other service provider can use a status command to determine if the service is running; if :status is not specified, the #{ChefUtils::Dist::Infra::CLIENT} attempts to match the service_name against the process table as a regular expression, unless a pattern is specified as a parameter property. Default value: { restart: false, reload: false, status: false } for all platforms (except for the Red Hat platform family, which defaults to { restart: false, reload: false, status: true }.)",
+        coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
 
       property :service_name, String,
         description: "An optional property to set the service name if it differs from the resource block's name.",
@@ -117,9 +117,9 @@ class Chef
         description: "Debian platform only. The relative priority of the program for start and shutdown ordering. May be an integer or a Hash. An integer is used to define the start run levels; stop run levels are then 100-integer. A Hash is used to define values for specific run levels. For example, { 2 => [:start, 20], 3 => [:stop, 55] } will set a priority of twenty for run level two and a priority of fifty-five for run level three."
 
       property :timeout, Integer,
-      description: "The amount of time (in seconds) to wait before timing out.",
-      default: 900,
-      desired_state: false
+        description: "The amount of time (in seconds) to wait before timing out.",
+        default: 900,
+        desired_state: false
 
       property :parameters, Hash,
         description: "Upstart only: A hash of parameters to pass to the service command for use in the service definition."

data/lib/chef/resource/snap_package.rb

@@ -27,27 +27,27 @@ class Chef
       description "Use the **snap_package** resource to manage snap packages on Debian and Ubuntu platforms."
       introduced "15.0"
       examples <<~DOC
-      **Install a package**
+        **Install a package**
 
-      ```ruby
-      snap_package 'hello'
-      ```
+        ```ruby
+        snap_package 'hello'
+        ```
 
-      **Upgrade a package**
+        **Upgrade a package**
 
-      ```ruby
-      snap_package 'hello' do
-        action :upgrade
-      end
-      ```
+        ```ruby
+        snap_package 'hello' do
+          action :upgrade
+        end
+        ```
 
-      **Install a package with classic confinement**
+        **Install a package with classic confinement**
 
-      ```ruby
-      snap_package 'hello' do
-        options 'classic'
-      end
-      ```
+        ```ruby
+        snap_package 'hello' do
+          options 'classic'
+        end
+        ```
       DOC
 
       allowed_actions :install, :upgrade, :remove, :purge

data/lib/chef/resource/ssh_known_hosts_entry.rb

@@ -29,19 +29,19 @@ class Chef
       description "Use the **ssh_known_hosts_entry** resource to add an entry for the specified host in /etc/ssh/ssh_known_hosts or a user's known hosts file if specified."
       introduced "14.3"
       examples <<~DOC
-      **Add a single entry for github.com with the key auto detected**
+        **Add a single entry for github.com with the key auto detected**
 
-      ```ruby
-      ssh_known_hosts_entry 'github.com'
-      ```
+        ```ruby
+        ssh_known_hosts_entry 'github.com'
+        ```
 
-      **Add a single entry with your own provided key**
+        **Add a single entry with your own provided key**
 
-      ```ruby
-      ssh_known_hosts_entry 'github.com' do
-        key 'node.example.com ssh-rsa ...'
-      end
-      ```
+        ```ruby
+        ssh_known_hosts_entry 'github.com' do
+          key 'node.example.com ssh-rsa ...'
+        end
+        ```
       DOC
 
       property :host, String,