Puppet Function: simplib::validate_sysctl_value

Defined in:
lib/puppet/functions/simplib/validate_sysctl_value.rb
Function type:
Ruby 4.x API

Overview

simplib::validate_sysctl_value(String $key, NotUndef $value) ⇒ Nil

Validate that the passed value is correct for the passed ‘sysctl` key.

  • If a key is not known, assumes the value is valid.

  • Terminates catalog compilation if validation fails.

Examples:

Passing validation

validate_sysctl_value('kernel.core_pattern','/var/core/%u_%g_%p_%t_%h_%e.core')

Parameters:

  • key (String) —

    sysctl setting whose value is to be validated

  • value (NotUndef) —

    Value to be validated

Returns:

  • (Nil)

Raises:

  • (RuntimeError) —

    upon validation failure



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/puppet/functions/simplib/validate_sysctl_value.rb', line 6

Puppet::Functions.create_function(:'simplib::validate_sysctl_value') do
  # @param key sysctl setting whose value is to be validated
  # @param value Value to be validated
  # @return [Nil]
  # @raise [RuntimeError] upon validation failure
  # @example Passing validation
  #   validate_sysctl_value('kernel.core_pattern','/var/core/%u_%g_%p_%t_%h_%e.core')

  dispatch :validate_sysctl_value do
    required_param 'String', :key
    required_param 'NotUndef', :value
  end

  def validate_sysctl_value(key, value)
    key_method_name = key.to_s.gsub('.', '__')

    send(key_method_name, key, value) if respond_to?(key_method_name)
  end

  # Below are the recognized validation methods

  def kernel__core_pattern(key, value)
    unless value.is_a?(String)
      validate_sysctl_err("Values for #{key} must be Strings")
    end

    if value.length > 128
      validate_sysctl_err("Values for #{key} must be less than 129 characters")
    end

    return unless value =~ %r{\|\s*(\S*)}
    require 'puppet/util'
    return if Puppet::Util.absolute_path?(Regexp.last_match(1), :posix)
    validate_sysctl_err("Piped commands for #{key} must have an absolute path")
  end

  def fs__inotify__max_user_watches(key, value)
    if !value.respond_to?('to_i') || value.to_i == 0
      validate_sysctl_err("#{key} cannot be #{value}")
    end

    system_ram_mb = closure_scope['facts'].dig('memory', 'system', 'total_bytes').to_i >> 20

    size_multiplier = 512
    size_multiplier = 1024 if closure_scope['facts'].dig('os', 'architecture') == 'x86_64'

    inode_ram_mb = (value.to_i * size_multiplier) / 1024 / 1024

    return unless inode_ram_mb >= system_ram_mb
    validate_sysctl_err("#{key} set to #{value} would exceed system RAM")
  end

  def validate_sysctl_err(msg)
    raise("simplib::validate_sysctl_value(): #{msg}")
  end
end