Module: Puppet

Extended by:

Util, Util::Logging

Defined in:

lib/puppet/type.rb,
lib/puppet/http.rb,
lib/puppet/pops.rb,
lib/puppet/util.rb,
lib/puppet/error.rb,
lib/puppet/vendor.rb,
lib/puppet/loaders.rb,
lib/puppet/version.rb,
lib/puppet/defaults.rb,
lib/puppet/ffi/posix.rb,
lib/puppet/type/exec.rb,
lib/puppet/type/user.rb,
lib/puppet/type/group.rb,
lib/puppet/application.rb,
lib/puppet/facter_impl.rb,
lib/puppet/ffi/windows.rb,
lib/puppet/module_tool.rb,
lib/puppet/pal/pal_api.rb,
lib/puppet/type/notify.rb,
lib/puppet/pal/compiler.rb,
lib/puppet/pal/pal_impl.rb,
lib/puppet/type/package.rb,
lib/puppet/type/service.rb,
lib/puppet/generate/type.rb,
lib/puppet/property/list.rb,
lib/puppet/type/schedule.rb,
lib/puppet/util/classgen.rb,
lib/puppet/util/platform.rb,
lib/puppet/util/run_mode.rb,
lib/puppet/pops/model/ast.rb,
lib/puppet/type/file/mode.rb,
lib/puppet/type/file/type.rb,
lib/puppet/util/execution.rb,
lib/puppet/concurrent/lock.rb,
lib/puppet/resource/status.rb,
lib/puppet/type/file/ctime.rb,
lib/puppet/type/file/group.rb,
lib/puppet/type/file/mtime.rb,
lib/puppet/type/file/owner.rb,
lib/puppet/type/filebucket.rb,
lib/puppet/type/file/ensure.rb,
lib/puppet/type/file/source.rb,
lib/puppet/type/file/target.rb,
lib/puppet/pops/puppet_stack.rb,
lib/puppet/property/keyvalue.rb,
lib/puppet/type/file/content.rb,
lib/puppet/util/command_line.rb,
lib/puppet/network/authconfig.rb,
lib/puppet/pal/plan_signature.rb,
lib/puppet/pal/task_signature.rb,
lib/puppet/application_support.rb,
lib/puppet/pal/script_compiler.rb,
lib/puppet/pops/parser/eparser.rb,
lib/puppet/pops/parser/eparser.rb,
lib/puppet/type/file/data_sync.rb,
lib/puppet/util/windows/string.rb,
lib/puppet/pal/catalog_compiler.rb,
lib/puppet/type/file/selcontext.rb,
lib/puppet/parser/parser_factory.rb,
lib/puppet/property/ordered_list.rb,
lib/puppet/util/windows/eventlog.rb,
lib/puppet/pal/function_signature.rb,
lib/puppet/concurrent/synchronized.rb,
lib/puppet/network/http/api/server.rb,
lib/puppet/util/constant_inflector.rb,
lib/puppet/util/symbolic_file_mode.rb,
lib/puppet/pal/json_catalog_encoder.rb,
lib/puppet/parser/e4_parser_adapter.rb,
lib/puppet/type/file/checksum_value.rb,
lib/puppet/generate/models/type/type.rb,
lib/puppet/util/command_line/trollop.rb,
lib/puppet/network/http/api/server/v3.rb,
lib/puppet/generate/models/type/property.rb,
lib/puppet/module_tool/install_directory.rb,
lib/puppet/concurrent/thread_local_singleton.rb,
lib/puppet/util/command_line/puppet_option_parser.rb,
lib/puppet/network/http/api/server/v3/environments.rb,
lib/puppet.rb

Overview

Defines the ‘Puppet` module. There are different entry points into Puppet depending on your use case.

To use puppet as a library, see Pal.

To create a new application, see Application.

To create a new function, see Functions.

To access puppet’s REST APIs, see puppet.com/docs/puppet/latest/http_api/http_api_index.html.

Defined Under Namespace

Modules: ApplicationSupport, Coercion, CompilableResourceType, Concurrent, Confiner, DataSync, DataTypes, Environments, Etc, ExternalFileError, FFI, FileBucket, FileBucketFile, FileSystem, Functions, Generate, GettextConfig, Graph, HTTP, Indirector, InfoService, MetaType, ModuleTool, ModuleTranslations, Network, Pal, Parser, Plugins, Pops, SSL, Scheduler, SyntaxCheckers, Test, TrustedExternal, Util, X509 Classes: Agent, AlreadyImportedError, Application, Configurer, Confine, ConfineCollection, ConstantAlreadyDefined, Context, Daemon, DataBinding, DevError, Error, ErrorWithData, ExecutionFailure, FacterImpl, FileServing, Forge, ImportError, Interface, LexError, LockError, MissingCommand, Module, Node, Parameter, ParseError, ParseErrorWithIssue, PreformattedError, Property, Provider, Relationship, Reports, Resource, ResourceError, Runtime, SELFileContext, Settings, SubclassAlreadyDefined, ThreadLocal, Transaction, Type, Vendor

Constant Summary

PUPPETVERSION =

'8.10.0'

AS_DURATION =

NOTE: For information about the available values for the “:type” property of settings,

see the docs for Settings.define_settings

'This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y).'

Log =

This is for backward compatibility from when we changed the constant to Puppet::Util::Log because the reports include the constant name. It was considered for removal but left in due to risk of breakage (PUP-7502).

Puppet::Util::Log

ResourceType =

self

Face =

Puppet::Interface

OLDEST_RECOMMENDED_RUBY_VERSION =

'3.1.0'

@@settings =

the hash that determines how our system behaves

Puppet::Settings.new

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Class Attribute Summary

• .features ⇒ Object readonly

Class Method Summary

• .[](param) ⇒ Object

  Get the value for a setting.

• .[]=(param, value) ⇒ Object

  setting access and stuff.

• .base_context(settings) ⇒ Object private

  The bindings used for initialization of puppet.

• .bootstrap_context ⇒ Object private

  A simple set of bindings that is just enough to limp along to initialization where the Puppet.base_context bindings are put in place.

• .clear ⇒ Object
• .debug=(value) ⇒ Object
• .default_basemodulepath ⇒ Object
• .default_cadir ⇒ Object
• .default_diffargs ⇒ Object
• .default_digest_algorithm ⇒ Object

  If you modify this, update puppet/type/file/checksum.rb too.

• .default_file_checksum_types ⇒ Object
• .default_vendormoduledir ⇒ Object
• .ignore(name) ⇒ Object private
• .initialize_default_settings!(settings) ⇒ Object

  Void.

• .initialize_facts ⇒ Object

  Initialize puppet’s core facts.

• .initialize_settings(args = [], require_config = true, push_settings_globally = true, runtime_implementations = {}) ⇒ void

  Initialize puppet’s settings.

• .lookup(name, &block) ⇒ Object private

  Lookup a binding by name or return a default value provided by a passed block (if given).

• .mark_context(name) ⇒ Object private
• .minor_version ⇒ String

  Containing the puppet version to minor specificity, e.g.

• .override(bindings, description = "") { ... } ⇒ Object private
• .pop_context ⇒ Object private

  Return to the previous context.

• .push_context(overrides, description = "") ⇒ Object private
• .push_context_global(overrides, description = '') ⇒ Object private

  Push something onto the context and make it global across threads.

• .replace_settings_object(new_settings) ⇒ Object

  The puppetserver project has its own settings class that is thread-aware; this method is here to allow the puppetserver to define its own custom settings class for multithreaded puppet.

• .restore(name) ⇒ Object private
• .rollback_context(name) ⇒ Object private
• .run_mode ⇒ Object
• .runtime ⇒ Object
• .settings ⇒ Object

  Note: It’s important that these accessors (‘self.settings`, `self.[]`) are defined before we try to load any “features” (which happens a few lines below), because the implementation of the features loading may examine the values of settings.

• .valid_digest_algorithms ⇒ Object
• .valid_file_checksum_types ⇒ Object
• .version ⇒ String

  version is a public API method intended to always provide a fast and lightweight way to determine the version of Puppet.

• .version=(version) ⇒ Object

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Logging

clear_deprecation_warnings, debug, deprecation_warning, format_backtrace, format_exception, get_deprecation_offender, log_and_raise, log_deprecations_to_file, log_exception, puppet_deprecation_warning, send_log, setup_facter_logging!, warn_once

Class Attribute Details

.features ⇒ Object (readonly)

# File 'lib/puppet.rb', line 49

def features
  @features
end

Class Method Details

.[](param) ⇒ Object

Get the value for a setting

Parameters:

• param (Symbol) —

  the setting to retrieve

# File 'lib/puppet.rb', line 76

def self.[](param)
  if param == :debug
    Puppet::Util::Log.level == :debug
  else
    @@settings[param]
  end
end

.[]=(param, value) ⇒ Object

setting access and stuff

# File 'lib/puppet.rb', line 94

def self.[]=(param, value)
  @@settings[param] = value
end

.base_context(settings) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The bindings used for initialization of puppet

Parameters:

• settings (Puppet::Settings, Hash<Symbol,String>) —

  either a Puppet::Settings instance or a Hash of settings key/value pairs.

# File 'lib/puppet.rb', line 213

def self.base_context(settings)
  environmentpath = settings[:environmentpath]
  basemodulepath = Puppet::Node::Environment.split_path(settings[:basemodulepath])

  if environmentpath.nil? || environmentpath.empty?
    raise(Puppet::Error, _("The environmentpath setting cannot be empty or nil."))
  else
    loaders = Puppet::Environments::Directories.from_path(environmentpath, basemodulepath)
    # in case the configured environment (used for the default sometimes)
    # doesn't exist
    default_environment = Puppet[:environment].to_sym
    if default_environment == :production
      modulepath = settings[:modulepath]
      modulepath = (modulepath.nil? || '' == modulepath) ? basemodulepath : Puppet::Node::Environment.split_path(modulepath)
      loaders << Puppet::Environments::StaticPrivate.new(
        Puppet::Node::Environment.create(default_environment,
                                         modulepath,
                                         Puppet::Node::Environment::NO_MANIFEST)
      )
    end
  end

  {
    :environments => Puppet::Environments::Cached.new(Puppet::Environments::Combined.new(*loaders)),
    :ssl_context => proc { Puppet.runtime[:http].default_ssl_context },
    :http_session => proc { Puppet.runtime[:http].create_session },
    :plugins => proc { Puppet::Plugins::Configuration.load_plugins },
    :rich_data => Puppet[:rich_data],
    # `stringify_rich` controls whether `rich_data` is stringified into a lossy format
    # instead of a lossless format. Catalogs should not be stringified, though to_yaml
    # and the resource application have uses for a lossy, user friendly format.
    :stringify_rich => false
  }
end

.bootstrap_context ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A simple set of bindings that is just enough to limp along to initialization where the base_context bindings are put in place

# File 'lib/puppet.rb', line 251

def self.bootstrap_context
  root_environment = Puppet::Node::Environment.create(:'*root*', [], Puppet::Node::Environment::NO_MANIFEST)
  {
    :current_environment => root_environment,
    :root_environment => root_environment
  }
end

.clear ⇒ Object

# File 'lib/puppet.rb', line 98

def self.clear
  @@settings.clear
end

.debug=(value) ⇒ Object

# File 'lib/puppet.rb', line 102

def self.debug=(value)
  if value
    Puppet::Util::Log.level = (:debug)
  else
    Puppet::Util::Log.level = (:notice)
  end
end

.default_basemodulepath ⇒ Object

# File 'lib/puppet/defaults.rb', line 50

def self.default_basemodulepath
  path = ['$codedir/modules']
  if (run_mode_dir = Puppet.run_mode.common_module_dir)
    path << run_mode_dir
  end
  path.join(File::PATH_SEPARATOR)
end

.default_cadir ⇒ Object

# File 'lib/puppet/defaults.rb', line 33

def self.default_cadir
  return "" if Puppet::Util::Platform.windows?

  old_ca_dir = "#{Puppet[:ssldir]}/ca"
  new_ca_dir = "/etc/puppetlabs/puppetserver/ca"

  if File.exist?(old_ca_dir)
    if File.symlink?(old_ca_dir)
      File.readlink(old_ca_dir)
    else
      old_ca_dir
    end
  else
    new_ca_dir
  end
end

.default_diffargs ⇒ Object

# File 'lib/puppet/defaults.rb', line 6

def self.default_diffargs
  '-u'
end

.default_digest_algorithm ⇒ Object

If you modify this, update puppet/type/file/checksum.rb too

# File 'lib/puppet/defaults.rb', line 11

def self.default_digest_algorithm
  'sha256'
end

.default_file_checksum_types ⇒ Object

# File 'lib/puppet/defaults.rb', line 21

def self.default_file_checksum_types
  Puppet::Util::Platform.fips_enabled? ?
    %w[sha256 sha384 sha512 sha224] :
    %w[sha256 sha384 sha512 sha224 md5]
end

.default_vendormoduledir ⇒ Object

# File 'lib/puppet/defaults.rb', line 58

def self.default_vendormoduledir
  Puppet.run_mode.vendor_module_dir
end

.ignore(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

• name —

  The name of a context key to ignore; intended for test usage.

# File 'lib/puppet.rb', line 297

def self.ignore(name)
  @context.ignore(name)
end

.initialize_default_settings!(settings) ⇒ Object

Returns void.

Parameters:

• args (Puppet::Settings) —

  the settings object to define default settings for

Returns:

• void

# File 'lib/puppet/defaults.rb', line 72

def self.initialize_default_settings!(settings)
  settings.define_settings(:main,
  :confdir  => {
      :default  => nil,
      :type     => :directory,
      :desc     => "The main Puppet configuration directory.  The default for this setting
        is calculated based on the user.  If the process is running as root or
        the user that Puppet is supposed to run as, it defaults to a system
        directory, but if it's running as any other user, it defaults to being
        in the user's home directory.",
  },
  :codedir  => {
      :default  => nil,
      :type     => :directory,
      :desc     => "The main Puppet code directory.  The default for this setting
        is calculated based on the user.  If the process is running as root or
        the user that Puppet is supposed to run as, it defaults to a system
        directory, but if it's running as any other user, it defaults to being
        in the user's home directory.",
  },
  :vardir   => {
      :default  => nil,
      :type     => :directory,
      :owner    => "service",
      :group    => "service",
      :desc     => "Where Puppet stores dynamic and growing data.  The default for this
        setting is calculated specially, like `confdir`_.",
  },

  ### NOTE: this setting is usually being set to a symbol value.  We don't officially have a
  ###     setting type for that yet, but we might want to consider creating one.
  :name     => {
      :default  => nil,
      :desc     => "The name of the application, if we are running as one.  The
        default is essentially $0 without the path or `.rb`.",
  }
  )

settings.define_settings(:main,
  :logdir => {
      :default  => nil,
      :type     => :directory,
      :mode     => "0750",
      :owner    => "service",
      :group    => "service",
      :desc     => "The directory in which to store log files",
  },
  :log_level => {
    :default    => 'notice',
    :type       => :enum,
    :values     => %w[debug info notice warning err alert emerg crit],
    :desc       => "Default logging level for messages from Puppet. Allowed values are:

      * debug
      * info
      * notice
      * warning
      * err
      * alert
      * emerg
      * crit
      ",
    :hook => proc {|value| Puppet::Util::Log.level = value },
    :call_hook => :on_initialize_and_write,
  },
  :disable_warnings => {
    :default => [],
    :type    => :array,
    :desc    => "A comma-separated list of warning types to suppress. If large numbers
      of warnings are making Puppet's logs too large or difficult to use, you
      can temporarily silence them with this setting.

      If you are preparing to upgrade Puppet to a new major version, you
      should re-enable all warnings for a while.

      Valid values for this setting are:

      * `deprecations` --- disables deprecation warnings.
      * `undefined_variables` --- disables warnings about non existing variables.
      * `undefined_resources` --- disables warnings about non existing resources.",
    :hook      => proc do |value|
      values = munge(value)
      valid   = %w[deprecations undefined_variables undefined_resources]
      invalid = values - (values & valid)
      unless invalid.empty?
        raise ArgumentError, _("Cannot disable unrecognized warning types '%{invalid}'.") % { invalid: invalid.join(',') } +
            ' ' + _("Valid values are '%{values}'.") % { values: valid.join(', ') }
      end
    end
  },
  :skip_logging_catalog_request_destination => {
    :default => false,
    :type    => :boolean,
    :desc => "Specifies whether to suppress the notice of which compiler
      supplied the catalog. A value of `true` suppresses the notice.",
  },
  :merge_dependency_warnings => {
    :default => false,
    :type    => :boolean,
    :desc    => "Whether to merge class-level dependency failure warnings.

      When a class has a failed dependency, every resource in the class
      generates a notice level message about the dependency failure,
      and a warning level message about skipping the resource.

      If true, all messages caused by a class dependency failure are merged
      into one message associated with the class.
      ",
  },
  :strict => {
    :default    => :error,
    :type       => :symbolic_enum,
    :values     => [:off, :warning, :error],
    :desc       => "The strictness level of puppet. Allowed values are:

      * off     - do not perform extra validation, do not report
      * warning - perform extra validation, report as warning
      * error   - perform extra validation, fail with error (default)

      The strictness level is for both language semantics and runtime
      evaluation validation. In addition to controlling the behavior with
      this primary server switch some individual warnings may also be controlled
      by the disable_warnings setting.

      No new validations will be added to a micro (x.y.z) release,
      but may be added in minor releases (x.y.0). In major releases
      it expected that most (if not all) strictness validation become
      standard behavior.",
    :hook    => proc do |value|
      munge(value)
      value.to_sym
    end
  },
  :disable_i18n => {
    :default => true,
    :type    => :boolean,
    :desc    => "If true, turns off all translations of Puppet and module
      log messages, which affects error, warning, and info log messages,
      as well as any translations in the report and CLI.",
    :hook    => proc do |value|
      if value
        require_relative '../puppet/gettext/stubs'
        Puppet::GettextConfig.disable_gettext
      end
    end
  }
)

settings.define_settings(:main,
  :priority => {
    :default => nil,
    :type    => :priority,
    :desc    => "The scheduling priority of the process.  Valid values are 'high',
      'normal', 'low', or 'idle', which are mapped to platform-specific
      values.  The priority can also be specified as an integer value and
      will be passed as is, e.g. -5.  Puppet must be running as a privileged
      user in order to increase scheduling priority.",
  },
  :trace => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to print stack traces on some errors. Will print
        internal Ruby stack trace interleaved with Puppet function frames.",
      :hook     => proc do |value|
        # Enable or disable Facter's trace option too
        Puppet.runtime[:facter].trace(value)
      end
  },
  :puppet_trace => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to print the Puppet stack trace on some errors.
        This is a noop if `trace` is also set.",
  },
  :profile => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to enable experimental performance profiling",
  },
  :versioned_environment_dirs => {
    :default => false,
    :type => :boolean,
    :desc => "Whether or not to look for versioned environment directories,
    symlinked from `$environmentpath/<environment>`. This is an experimental
    feature and should be used with caution."
  },
  :static_catalogs => {
    :default    => true,
    :type       => :boolean,
    :desc       => "Whether to compile a [static catalog](https://puppet.com/docs/puppet/latest/static_catalogs.html#enabling-or-disabling-static-catalogs),
      which occurs only on Puppet Server when the `code-id-command` and
      `code-content-command` settings are configured in its `puppetserver.conf` file.",
  },
  :settings_catalog => {
    :default    => true,
    :type       => :boolean,
    :desc       => "Whether to compile and apply the settings catalog",
  },
  :strict_environment_mode => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether the agent specified environment should be considered authoritative,
      causing the run to fail if the retrieved catalog does not match it.",
  },
  :autoflush => {
    :default => true,
    :type       => :boolean,
    :desc       => "Whether log files should always flush to disk.",
    :hook       => proc { |value| Log.autoflush = value }
  },
  :syslogfacility => {
      :default  => "daemon",
      :desc     => "What syslog facility to use when logging to syslog.
        Syslog has a fixed list of valid facilities, and you must
        choose one of those; you cannot just make one up."
  },
  :statedir => {
      :default  => "$vardir/state",
      :type     => :directory,
      :mode     => "01755",
      :desc     => "The directory where Puppet state is stored.  Generally,
        this directory can be removed without causing harm (although it
        might result in spurious service restarts)."
  },
  :rundir => {
    :default  => nil,
    :type     => :directory,
    :mode     => "0755",
    :owner    => "service",
    :group    => "service",
    :desc     => "Where Puppet PID files are kept."
  },
  :genconfig => {
      :default  => false,
      :type     => :boolean,
      :desc     => "When true, causes Puppet applications to print an example config file
        to stdout and exit. The example will include descriptions of each
        setting, and the current (or default) value of each setting,
        incorporating any settings overridden on the CLI (with the exception
        of `genconfig` itself). This setting only makes sense when specified
        on the command line as `--genconfig`.",
  },
  :genmanifest => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to just print a manifest to stdout and exit.  Only makes
        sense when specified on the command line as `--genmanifest`.  Takes into account arguments specified
        on the CLI.",
  },
  :configprint => {
      :default    => "",
      :deprecated => :completely,
      :desc       => "Prints the value of a specific configuration setting.  If the name of a
        setting is provided for this, then the value is printed and puppet
        exits.  Comma-separate multiple values.  For a list of all values,
        specify 'all'. This setting is deprecated, the 'puppet config' command replaces this functionality.",
  },
  :color => {
    :default => "ansi",
    :type    => :string,
    :desc    => "Whether to use colors when logging to the console.  Valid values are
      `ansi` (equivalent to `true`), `html`, and `false`, which produces no color."
  },
  :mkusers => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to create the necessary user and group that puppet agent will run as.",
  },
  :manage_internal_file_permissions => {
      :default  => ! Puppet::Util::Platform.windows?,
      :type     => :boolean,
      :desc     => "Whether Puppet should manage the owner, group, and mode of files it uses internally.
        **Note**: For Windows agents, the default is `false` for versions 4.10.13 and greater, versions 5.5.6 and greater, and versions 6.0 and greater.",
  },
  :onetime => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Perform one configuration run and exit, rather than spawning a long-running
        daemon. This is useful for interactively running puppet agent, or
        running puppet agent from cron.",
      :short    => 'o',
  },
  :path => {
      :default          => "none",
      :desc             => "The shell search path.  Defaults to whatever is inherited
        from the parent process.

        This setting can only be set in the `[main]` section of puppet.conf; it cannot
        be set in `[server]`, `[agent]`, or an environment config section.",
      :call_hook => :on_define_and_write,
      :hook             => proc do |value|
        ENV['PATH'] = '' if ENV['PATH'].nil?
        ENV['PATH'] = value unless value == 'none'
        paths = ENV['PATH'].split(File::PATH_SEPARATOR)
        Puppet::Util::Platform.default_paths.each do |path|
          next if paths.include?(path)

          ENV['PATH'] = ENV.fetch('PATH', nil) + File::PATH_SEPARATOR + path
        end
        value
      end
  },
  :libdir => {
      :type           => :directory,
      :default        => "$vardir/lib",
      :desc           => "An extra search path for Puppet.  This is only useful
        for those files that Puppet will load on demand, and is only
        guaranteed to work for those cases.  In fact, the autoload
        mechanism is responsible for making sure this directory
        is in Ruby's search path\n"
  },
  :environment => {
      :default  => "production",
      :desc     => "The environment in which Puppet is running. For clients,
        such as `puppet agent`, this determines the environment itself, which
        Puppet uses to find modules and much more. For servers, such as `puppet server`,
        this provides the default environment for nodes that Puppet knows nothing about.

        When defining an environment in the `[agent]` section, this refers to the
        environment that the agent requests from the primary server. The environment doesn't
        have to exist on the local filesystem because the agent fetches it from the
        primary server. This definition is used when running `puppet agent`.

        When defined in the `[user]` section, the environment refers to the path that
        Puppet uses to search for code and modules related to its execution. This
        requires the environment to exist locally on the filesystem where puppet is
        being executed. Puppet subcommands, including `puppet module` and
        `puppet apply`, use this definition.

        Given that the context and effects vary depending on the
        [config section](https://puppet.com/docs/puppet/latest/config_file_main.html#config-sections)
        in which the `environment` setting is defined, do not set it globally.",
      :short    => "E"
  },
  :environmentpath => {
    :default => "$codedir/environments",
    :desc    => "A search path for directory environments, as a list of directories
      separated by the system path separator character. (The POSIX path separator
      is ':', and the Windows path separator is ';'.)

      This setting must have a value set to enable **directory environments.** The
      recommended value is `$codedir/environments`. For more details, see
      <https://puppet.com/docs/puppet/latest/environments_about.html>",
    :type    => :path,
  },
  :report_configured_environmentpath => {
    :type     => :boolean,
    :default  => true,
    :desc     => <<-'EOT'
    Specifies how environment paths are reported. When the value of
    `versioned_environment_dirs` is `true`, Puppet applies the readlink function to
    the `environmentpath` setting when constructing the environment's modulepath. The
    full readlinked path is referred to as the "resolved path," and the configured
    path potentially containing symlinks is the "configured path." When reporting
    where resources come from, users may choose between the configured and resolved
    path.

    When set to `false`, the resolved paths are reported instead of the configured paths.
    EOT
  },
  :use_last_environment => {
    :type     => :boolean,
    :default  => true,
    :desc     => <<-'EOT'
    Puppet saves both the initial and converged environment in the last_run_summary file.
    If they differ, and this setting is set to true, we will use the last converged
    environment and skip the node request.

    When set to false, we will do the node request and ignore the environment data from the last_run_summary file.
    EOT
  },
  :always_retry_plugins => {
      :type     => :boolean,
      :default  => true,
      :desc     => <<-'EOT'
      Affects how we cache attempts to load Puppet resource types and features.  If
      true, then calls to `Puppet.type.<type>?` `Puppet.feature.<feature>?`
      will always attempt to load the type or feature (which can be an
      expensive operation) unless it has already been loaded successfully.
      This makes it possible for a single agent run to, e.g., install a
      package that provides the underlying capabilities for a type or feature,
      and then later load that type or feature during the same run (even if
      the type or feature had been tested earlier and had not been available).

      If this setting is set to false, then types and features will only be
      checked once, and if they are not available, the negative result is
      cached and returned for all subsequent attempts to load the type or
      feature.  This behavior is almost always appropriate for the server,
      and can result in a significant performance improvement for types and
      features that are checked frequently.
      EOT
  },
  :diff_args => {
      :default  => -> { default_diffargs },
      :desc     => "Which arguments to pass to the diff command when printing differences between
        files. The command to use can be chosen with the `diff` setting.",
  },
  :diff => {
    :default => (Puppet::Util::Platform.windows? ? "" : "diff"),
    :desc    => "Which diff command to use when printing differences between files. This setting
        has no default value on Windows, as standard `diff` is not available, but Puppet can use many
        third-party diff tools.",
  },
  :show_diff => {
      :type     => :boolean,
      :default  => false,
      :desc     => "Whether to log and report a contextual diff when files are being replaced.
        This causes partial file contents to pass through Puppet's normal
        logging and reporting system, so this setting should be used with
        caution if you are sending Puppet's reports to an insecure
        destination. This feature currently requires the `diff/lcs` Ruby
        library.",
  },
  :daemonize => {
      :type     => :boolean,
      :default  => !Puppet::Util::Platform.windows?,
      :desc     => "Whether to send the process into the background.  This defaults
        to true on POSIX systems, and to false on Windows (where Puppet
        currently cannot daemonize).",
      :short    => "D",
      :hook     => proc do |value|
                     if value and Puppet::Util::Platform.windows?
                       raise "Cannot daemonize on Windows"
                     end
                   end
  },
  :maximum_uid => {
      :default  => 4_294_967_290,
      :type     => :integer,
      :desc     => "The maximum allowed UID.  Some platforms use negative UIDs
        but then ship with tools that do not know how to handle signed ints,
        so the UIDs show up as huge numbers that can then not be fed back into
        the system.  This is a hackish way to fail in a slightly more useful
        way when that happens.",
  },
  :route_file => {
    :default    => "$confdir/routes.yaml",
    :desc       => "The YAML file containing indirector route configuration.",
  },
  :node_terminus => {
    :type       => :terminus,
    :default    => "plain",
    :desc       => <<-'EOT',
      Which node data plugin to use when compiling node catalogs.

      When Puppet compiles a catalog, it combines two primary sources of info: the main manifest,
      and a node data plugin (often called a "node terminus," for historical reasons). Node data
      plugins provide three things for a given node name:

      1. A list of classes to add to that node's catalog (and, optionally, values for their
         parameters).
      2. Which Puppet environment the node should use.
      3. A list of additional top-scope variables to set.

      The three main node data plugins are:

      * `plain` --- Returns no data, so that the main manifest controls all node configuration.
      * `exec` --- Uses an
        [external node classifier (ENC)](https://puppet.com/docs/puppet/latest/nodes_external.html),
        configured by the `external_nodes` setting. This lets you pull a list of Puppet classes
        from any external system, using a small glue script to perform the request and format the
        result as YAML.
      * `classifier` (formerly `console`) --- Specific to Puppet Enterprise. Uses the PE console
        for node data."
    EOT
  },
  :node_cache_terminus => {
    :type       => :terminus,
    :default    => nil,
    :desc       => "How to store cached nodes.
    Valid values are (none), 'json', 'msgpack', or 'yaml'.",
  },
  :data_binding_terminus => {
    :type    => :terminus,
    :default => "hiera",
    :desc    =>
      "This setting has been deprecated. Use of any value other than 'hiera' should instead be configured
       in a version 5 hiera.yaml. Until this setting is removed, it controls which data binding terminus
       to use for global automatic data binding (across all environments). By default this value is 'hiera'.
       A value of 'none' turns off the global binding.",
    :call_hook => :on_initialize_and_write,
    :hook => proc do |value|
      if Puppet[:strict] != :off
        s_val = value.to_s # because sometimes the value is a symbol
        unless s_val == 'hiera' || s_val == 'none' || value == '' || value.nil?
          #TRANSLATORS 'data_binding_terminus' is a setting and should not be translated
          message = _("Setting 'data_binding_terminus' is deprecated.")
          #TRANSLATORS 'hiera' should not be translated
          message += ' ' + _("Convert custom terminus to hiera 5 API.")
          Puppet.deprecation_warning(message)
        end
      end
    end
  },
  :hiera_config => {
    :default => lambda do
      config = nil
      codedir = settings[:codedir]
      if codedir.is_a?(String)
        config = File.expand_path(File.join(codedir, 'hiera.yaml'))
        config = nil unless Puppet::FileSystem.exist?(config)
      end
      config = File.expand_path(File.join(settings[:confdir], 'hiera.yaml')) if config.nil?
      config
    end,
    :desc    => "The hiera configuration file. Puppet only reads this file on startup, so you must restart the puppet server every time you edit it.",
    :type    => :file,
  },
  :binder_config => {
    :default => nil,
    :desc    => "The binder configuration file. Puppet reads this file on each request to configure the bindings system.
    If set to nil (the default), a $confdir/binder_config.yaml is optionally loaded. If it does not exists, a default configuration
    is used. If the setting :binding_config is specified, it must reference a valid and existing yaml file.",
    :type    => :file,
  },
  :catalog_terminus => {
    :type       => :terminus,
    :default    => "compiler",
    :desc       => "Where to get node catalogs.  This is useful to change if, for instance,
    you'd like to pre-compile catalogs and store them in memcached or some other easily-accessed store.",
  },
  :catalog_cache_terminus => {
    :type       => :terminus,
    :default    => nil,
    :desc       => "How to store cached catalogs. Valid values are 'json', 'msgpack' and 'yaml'. The agent application defaults to 'json'."
  },
  :facts_terminus => {
    :default => 'facter',
    :desc => "The node facts terminus.",
  },
  :trusted_external_command => {
    :default  => nil,
    :type     => :file_or_directory,
    :desc     => "The external trusted facts script or directory to use.
      This setting's value can be set to the path to an executable command that
      can produce external trusted facts or to a directory containing those
      executable commands. The command(s) must:

      * Take the name of a node as a command-line argument.
      * Return a JSON hash with the external trusted facts for this node.
      * For unknown or invalid nodes, exit with a non-zero exit code.

      If the setting points to an executable command, then the external trusted
      facts will be stored in the 'external' key of the trusted facts hash. Otherwise
      for each executable file in the directory, the external trusted facts will be
      stored in the `<basename>` key of the `trusted['external']` hash. For example,
      if the files foo.rb and bar.sh are in the directory, then `trusted['external']`
      will be the hash `{ 'foo' => <foo.rb output>, 'bar' => <bar.sh output> }`.",
  },
  :default_file_terminus => {
    :type       => :terminus,
    :default    => "rest",
    :desc       => "The default source for files if no server is given in a
    uri, e.g. puppet:///file. The default of `rest` causes the file to be
    retrieved using the `server` setting. When running `apply` the default
    is `file_server`, causing requests to be filled locally."
  },
  :http_proxy_host => {
    :default    => "none",
    :desc       => "The HTTP proxy host to use for outgoing connections. The proxy will be bypassed if
    the server's hostname matches the NO_PROXY environment variable or `no_proxy` setting. Note: You
    may need to use a FQDN for the server hostname when using a proxy. Environment variable
    http_proxy or HTTP_PROXY will override this value. ",
  },
  :http_proxy_port => {
    :default    => 3128,
    :type       => :port,
    :desc       => "The HTTP proxy port to use for outgoing connections",
  },
  :http_proxy_user => {
    :default    => "none",
    :desc       => "The user name for an authenticated HTTP proxy. Requires the `http_proxy_host` setting.",
  },
  :http_proxy_password =>{
    :default    => "none",
    :hook       => proc do |value|
      if value =~ %r{[@!# /]}
        raise "Passwords set in the http_proxy_password setting must be valid as part of a URL, and any reserved characters must be URL-encoded. We received: #{value}"
      end
    end,
    :desc       => "The password for the user of an authenticated HTTP proxy.
      Requires the `http_proxy_user` setting.

      Note that passwords must be valid when used as part of a URL. If a password
      contains any characters with special meanings in URLs (as specified by RFC 3986
      section 2.2), they must be URL-encoded. (For example, `#` would become `%23`.)",
  },
  :no_proxy => {
    :default    => "localhost, 127.0.0.1",
    :desc       => "List of host or domain names that should not go through `http_proxy_host`. Environment variable no_proxy or NO_PROXY will override this value. Names can be specified as an FQDN `host.example.com`, wildcard `*.example.com`, dotted domain `.example.com`, or suffix `example.com`.",
  },
  :http_keepalive_timeout => {
    :default    => "4s",
    :type       => :duration,
    :desc       => "The maximum amount of time a persistent HTTP connection can remain idle in the connection pool, before it is closed.  This timeout should be shorter than the keepalive timeout used on the HTTP server, e.g. Apache KeepAliveTimeout directive.
    #{AS_DURATION}"
  },
  :http_debug => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether to write HTTP request and responses to stderr. This should never be used in a production environment."
  },
  :http_connect_timeout => {
    :default => "2m",
    :type    => :duration,
    :desc    => "The maximum amount of time to wait when establishing an HTTP connection. The default
    value is 2 minutes.
    #{AS_DURATION}",
  },
  :http_read_timeout => {
    :default => "10m",
    :type    => :duration,
    :desc    => "The time to wait for data to be read from an HTTP connection. If nothing is
    read after the elapsed interval then the connection will be closed. The default value is 10 minutes.
    #{AS_DURATION}",
  },
  :http_user_agent => {
    :default => "Puppet/#{Puppet.version} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})",
    :desc    => "The HTTP User-Agent string to send when making network requests."
  },
  :filetimeout => {
    :default    => "15s",
    :type       => :duration,
    :desc       => "The minimum time to wait between checking for updates in
    configuration files.  This timeout determines how quickly Puppet checks whether
    a file (such as manifests or puppet.conf) has changed on disk. The default will
    change in a future release to be 'unlimited', requiring a reload of the Puppet
    service to pick up changes to its internal configuration. Currently we do not
    accept a value of 'unlimited'. To reparse files within an environment in
    Puppet Server please use the environment_cache endpoint",
    :hook => proc do |val|
      unless [0, 15, '15s'].include?(val)
        Puppet.deprecation_warning(<<-WARNING)
Fine grained control of filetimeouts is deprecated. In future
releases this value will only determine if file content is cached.

Valid values are 0 (never cache) and 15 (15 second minimum wait time).
        WARNING
      end
    end
  },
  :environment_timeout => {
    :default    => "0",
    :type       => :ttl,
    :desc       => "How long the Puppet server should cache data it loads from an
    environment.

    A value of `0` will disable caching. This setting can also be set to
    `unlimited`, which will cache environments until the server is restarted
    or told to refresh the cache. All other values will result in Puppet
    server evicting environments that haven't been used within the last
    `environment_timeout` seconds.

    You should change this setting once your Puppet deployment is doing
    non-trivial work. We chose the default value of `0` because it lets new
    users update their code without any extra steps, but it lowers the
    performance of your Puppet server. We recommend either:

    * Setting this to `unlimited` and explicitly refreshing your Puppet server
      as part of your code deployment process.

    * Setting this to a number that will keep your most actively used
      environments cached, but allow testing environments to fall out of the
      cache and reduce memory usage. A value of 3 minutes (3m) is a reasonable
      value.

    Once you set `environment_timeout` to a non-zero value, you need to tell
    Puppet server to read new code from disk using the `environment-cache` API
    endpoint after you deploy new code. See the docs for the Puppet Server
    [administrative API](https://puppet.com/docs/puppetserver/latest/admin-api/v1/environment-cache.html).
    "
  },
  :environment_data_provider => {
    :desc       => "The name of a registered environment data provider used when obtaining environment
    specific data. The three built in and registered providers are 'none' (no data), 'function' (data
    obtained by calling the function 'environment::data()') and 'hiera' (data obtained using a data
    provider configured using a hiera.yaml file in root of the environment).
    Other environment data providers may be registered in modules on the module path. For such
    custom data providers see the respective module documentation. This setting is deprecated.",
    :hook => proc { |value|
      unless value.nil? || Puppet[:strict] == :off
        #TRANSLATORS 'environment_data_provider' is a setting and should not be translated
        Puppet.deprecation_warning(_("Setting 'environment_data_provider' is deprecated."))
      end
    }
  },
  :prerun_command => {
    :default    => "",
    :desc       => "A command to run before every agent run.  If this command returns a non-zero
    return code, the entire Puppet run will fail.",
  },
  :postrun_command => {
    :default    => "",
    :desc       => "A command to run after every agent run.  If this command returns a non-zero
    return code, the entire Puppet run will be considered to have failed, even though it might have
    performed work during the normal run.",
  },
  :freeze_main => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Freezes the 'main' class, disallowing any code to be added to it.  This
        essentially means that you can't have any code outside of a node,
        class, or definition other than in the site manifest.",
  },
  :preview_outputdir => {
    :default => '$vardir/preview',
    :type     => :directory,
    :mode     => "0750",
    :owner    => "service",
    :group    => "service",
    :desc    => "The directory where catalog previews per node are generated."
  },
  :location_trusted => {
    :default => false,
    :type     => :boolean,
    :desc    => "This will allow sending the name + password and the cookie header to all hosts that puppet may redirect to.
      This may or may not introduce a security breach if puppet redirects you to a site to which you'll send your authentication info and cookies."
  }
)

settings.define_settings(:module_tool,
  :module_repository  => {
    :default  => 'https://forgeapi.puppet.com',
    :desc     => "The module repository",
  },
  :module_working_dir => {
      :default  => (Puppet::Util::Platform.windows? ? Dir.tmpdir() : '$vardir/puppet-module'),
      :desc     => "The directory into which module tool data is stored",
  },
  :forge_authorization => {
      :default  => nil,
      :desc     => "The authorization key to connect to the Puppet Forge. Leave blank for unauthorized or license based connections",
  },
  :module_groups => {
      :default  => nil,
      :desc     => "Extra module groups to request from the Puppet Forge. This is an internal setting, and users should never change it.",
  }
)

  settings.define_settings(
  :main,
  # We have to downcase the fqdn, because the current ssl stuff (as opposed to in master) doesn't have good facilities for
  # manipulating naming.
  :certname => {
    :default => -> { Puppet::Settings.default_certname.downcase },
    :desc => "The name to use when handling certificates. When a node
      requests a certificate from the CA Puppet Server, it uses the value of the
      `certname` setting as its requested Subject CN.

      This is the name used when managing a node's permissions in
      Puppet Server's [auth.conf](https://puppet.com/docs/puppetserver/latest/config_file_auth.html).
      In most cases, it is also used as the node's name when matching
      [node definitions](https://puppet.com/docs/puppet/latest/lang_node_definitions.html)
      and requesting data from an ENC. (This can be changed with the `node_name_value`
      and `node_name_fact` settings, although you should only do so if you have
      a compelling reason.)

      A node's certname is available in Puppet manifests as `$trusted['certname']`. (See
      [Facts and Built-In Variables](https://puppet.com/docs/puppet/latest/lang_facts_and_builtin_vars.html)
      for more details.)

      * For best compatibility, you should limit the value of `certname` to
        only use lowercase letters, numbers, periods, underscores, and dashes. (That is,
        it should match `/\A[a-z0-9._-]+\Z/`.)
      * The special value `ca` is reserved, and can't be used as the certname
        for a normal node.

        **Note:** You must set the certname in the main section of the puppet.conf file. Setting it in a different section causes errors.

      Defaults to the node's fully qualified domain name.",
    :call_hook => :on_initialize_and_write,
    :hook => proc { |value|
      raise(ArgumentError, _("Certificate names must be lower case")) unless value == value.downcase
    }},
  :dns_alt_names => {
    :default => '',
    :desc    => <<EOT,
  },
  :csr_attributes => {
    :default => "$confdir/csr_attributes.yaml",
    :type => :file,
    :desc => <<EOT
An optional file containing custom attributes to add to certificate signing
requests (CSRs). You should ensure that this file does not exist on your CA
Puppet Server; if it does, unwanted certificate extensions may leak into
certificates created with the `puppetserver ca generate` command.

If present, this file must be a YAML hash containing a `custom_attributes` key
and/or an `extension_requests` key. The value of each key must be a hash, where
each key is a valid OID and each value is an object that can be cast to a string.

Custom attributes can be used by the CA when deciding whether to sign the
certificate, but are then discarded. Attribute OIDs can be any OID value except
the standard CSR attributes (i.e. attributes described in RFC 2985 section 5.4).
This is useful for embedding a pre-shared key for autosigning policy executables
(see the `autosign` setting), often by using the `1.2.840.113549.1.9.7`
("challenge password") OID.

Extension requests will be permanently embedded in the final certificate.
Extension OIDs must be in the "ppRegCertExt" (`1.3.6.1.4.1.34380.1.1`),
"ppPrivCertExt" (`1.3.6.1.4.1.34380.1.2`), or
"ppAuthCertExt" (`1.3.6.1.4.1.34380.1.3`) OID arcs. The ppRegCertExt arc is
reserved for four of the most common pieces of data to embed: `pp_uuid` (`.1`),
`pp_instance_id` (`.2`), `pp_image_name` (`.3`), and `pp_preshared_key` (`.4`)
--- in the YAML file, these can be referred to by their short descriptive names
instead of their full OID. The ppPrivCertExt arc is unregulated, and can be used
for site-specific extensions. The ppAuthCert arc is reserved for two pieces of
data to embed: `pp_authorization` (`.1`) and `pp_auth_role` (`.13`). As with
ppRegCertExt, in the YAML file, these can be referred to by their short
descriptive name instead of their full OID.
EOT
  },
  :certdir => {
    :default => "$ssldir/certs",
    :type   => :directory,
    :mode => "0755",
    :owner => "service",
    :group => "service",
    :desc => "The certificate directory."
  },
  :ssldir => {
    :default => "$confdir/ssl",
    :type   => :directory,
    :mode => "0771",
    :owner => "service",
    :group => "service",
    :desc => "Where SSL certificates are kept."
  },
  :ssl_lockfile => {
    :default => "$ssldir/ssl.lock",
    :type    => :string,
    :desc    => "A lock file to indicate that the ssl bootstrap process is currently in progress.",
  },
  :publickeydir => {
    :default => "$ssldir/public_keys",
    :type   => :directory,
    :mode => "0755",
    :owner => "service",
    :group => "service",
    :desc => "The public key directory."
  },
  :requestdir => {
    :default => "$ssldir/certificate_requests",
    :type => :directory,
    :mode => "0755",
    :owner => "service",
    :group => "service",
    :desc => "Where host certificate requests are stored."
  },
  :privatekeydir => {
    :default => "$ssldir/private_keys",
    :type   => :directory,
    :mode => "0750",
    :owner => "service",
    :group => "service",
    :desc => "The private key directory."
  },
  :privatedir => {
    :default => "$ssldir/private",
    :type   => :directory,
    :mode => "0750",
    :owner => "service",
    :group => "service",
    :desc => "Where the client stores private certificate information."
  },
  :passfile => {
    :default => "$privatedir/password",
    :type   => :file,
    :mode => "0640",
    :owner => "service",
    :group => "service",
    :desc => "Where puppet agent stores the password for its private key.
      Generally unused."
  },
  :hostcsr => {
    :default => "$requestdir/$certname.pem",
    :type   => :file,
    :mode => "0644",
    :owner => "service",
    :group => "service",
    :desc => "Where individual hosts store their certificate request (CSR)
       while waiting for the CA to issue their certificate."
  },
  :hostcert => {
    :default => "$certdir/$certname.pem",
    :type   => :file,
    :mode => "0644",
    :owner => "service",
    :group => "service",
    :desc => "Where individual hosts store and look for their certificates."
  },
  :hostprivkey => {
    :default => "$privatekeydir/$certname.pem",
    :type   => :file,
    :mode => "0640",
    :owner => "service",
    :group => "service",
    :desc => "Where individual hosts store and look for their private key."
  },
  :hostpubkey => {
    :default => "$publickeydir/$certname.pem",
    :type   => :file,
    :mode => "0644",
    :owner => "service",
    :group => "service",
    :desc => "Where individual hosts store and look for their public key."
  },
  :localcacert => {
    :default => "$certdir/ca.pem",
    :type   => :file,
    :mode => "0644",
    :owner => "service",
    :group => "service",
    :desc => "Where each client stores the CA certificate."
  },
  :ca_fingerprint => {
    :default => nil,
    :type   => :string,
    :desc => "The expected fingerprint of the CA certificate. If specified, the agent
      will compare the CA certificate fingerprint that it downloads against this value
      and reject the CA certificate if the values do not match. This only applies
      during the first download of the CA certificate."
  },
  :ssl_trust_store => {
    :default => nil,
    :type => :file,
    :desc => "A file containing CA certificates in PEM format that puppet should trust
      when making HTTPS requests. This **only** applies to https requests to non-puppet
      infrastructure, such as retrieving file metadata and content from https file sources,
      puppet module tool and the 'http' report processor. This setting is ignored when
      making requests to puppet:// URLs such as catalog and report requests.",
  },
  :hostcrl => {
    :default => "$ssldir/crl.pem",
    :type   => :file,
    :mode => "0644",
    :owner => "service",
    :group => "service",
    :desc => "Where the host's certificate revocation list can be found.
      This is distinct from the certificate authority's CRL."
  },
  :certificate_revocation => {
      :default  => 'chain',
      :type     => :certificate_revocation,
      :desc     => <<-'EOT'
        Whether certificate revocation checking should be enabled, and what level of
        checking should be performed.

        When certificate revocation is enabled, Puppet expects the contents of its CRL
        to be one or more PEM-encoded CRLs concatenated together. When using a cert
        bundle, CRLs for all CAs in the chain of trust must be included in the crl file.
        The chain should be ordered from least to most authoritative, with the first CRL
        listed being for the root of the chain and the last being for the leaf CA.

        When certificate_revocation is set to 'true' or 'chain', Puppet ensures
        that each CA in the chain of trust has not been revoked by its issuing CA.

        When certificate_revocation is set to 'leaf', Puppet verifies certs against
        the issuing CA's revocation list, but it does not verify the revocation status
        of the issuing CA or any CA above it within the chain of trust.

        When certificate_revocation is set to 'false', Puppet disables all
        certificate revocation checking and does not attempt to download the CRL.
      EOT
  },
  :ciphers => {
    :default => 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256',
    :type => :string,
    :desc => "The list of ciphersuites for TLS connections initiated by puppet. The
              default value is chosen to support TLS 1.0 and up, but can be made
              more restrictive if needed. The ciphersuites must be specified in OpenSSL
              format, not IANA."
  },
  :key_type => {
    :default => 'rsa',
    :type    => :enum,
    :values  => %w[rsa ec],
    :desc    => "The type of private key. Valid values are `rsa` and `ec`. Default is `rsa`."
  },
  :named_curve => {
    :default => 'prime256v1',
    :type    => :string,
    :desc    => "The short name for the EC curve used to generate the EC private key. Valid
                 values must be one of the curves in `OpenSSL::PKey::EC.builtin_curves`.
                 Default is `prime256v1`."
  },
  :digest_algorithm => {
      :default  => -> { default_digest_algorithm },
      :type     => :enum,
      :values   => valid_digest_algorithms,
      :desc     => "Which digest algorithm to use for file resources and the filebucket.
                    Valid values are #{valid_digest_algorithms.join(', ')}. Default is
                    #{default_digest_algorithm}.",
  },
  :supported_checksum_types => {
    :default => -> { default_file_checksum_types },
    :type    => :array,
    :desc    => "Checksum types supported by this agent for use in file resources of a
                 static catalog. Values must be comma-separated. Valid types are
                 #{valid_file_checksum_types.join(', ')}. Default is
                 #{default_file_checksum_types.join(', ')}.",
    :hook    => proc do |value|
      values = munge(value)

      invalid = values - Puppet.valid_file_checksum_types
      unless invalid.empty?
        raise ArgumentError, _("Invalid value '%{value}' for parameter %{name}. Allowed values are '%{allowed_values}'") % {
          value: invalid.first, name: @name, allowed_values: Puppet.valid_file_checksum_types.join("', '")
        }
      end
    end
  },
  :logdest => {
    :type      => :string,
    :desc      => "Where to send log messages. Choose between 'syslog' (the POSIX syslog
    service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
    file. Multiple destinations can be set using a comma separated list (eg: `/path/file1,console,/path/file2`)"
    # Sure would be nice to set the Puppet::Util::Log destination here in an :on_initialize_and_write hook,
    # unfortunately we have a large number of tests that rely on the logging not resetting itself when the
    # settings are initialized as they test what gets logged during settings initialization.
  }
)

  settings.define_settings(
  :ca,
  :ca_name => {
    :default => "Puppet CA: $certname",
    :desc    => "The name to use the Certificate Authority certificate.",
  },
  :cadir => {
    :default => -> { default_cadir },
    :type => :directory,
    :desc => "The root directory for the certificate authority.",
  },
  :cacert => {
    :default => "$cadir/ca_crt.pem",
    :type => :file,
    :desc => "The CA certificate.",
  },
  :cakey => {
    :default => "$cadir/ca_key.pem",
    :type => :file,
    :desc => "The CA private key.",
  },
  :capub => {
    :default => "$cadir/ca_pub.pem",
    :type => :file,
    :desc => "The CA public key.",
  },
  :cacrl => {
    :default => "$cadir/ca_crl.pem",
    :type => :file,
    :desc => "The certificate revocation list (CRL) for the CA.",
  },
  :csrdir => {
    :default => "$cadir/requests",
    :type => :directory,
    :desc => "Where the CA stores certificate requests.",
  },
  :signeddir => {
    :default => "$cadir/signed",
    :type => :directory,
    :desc => "Where the CA stores signed certificates.",
  },
  :serial => {
    :default => "$cadir/serial",
    :type => :file,
    :desc => "Where the serial number for certificates is stored.",
  },
  :autosign => {
    :default => "$confdir/autosign.conf",
    :type => :autosign,
    :desc => "Whether (and how) to autosign certificate requests. This setting
      is only relevant on a Puppet Server acting as a certificate authority (CA).

      Valid values are true (autosigns all certificate requests; not recommended),
      false (disables autosigning certificates), or the absolute path to a file.

      The file specified in this setting may be either a **configuration file**
      or a **custom policy executable.** Puppet will automatically determine
      what it is: If the Puppet user (see the `user` setting) can execute the
      file, it will be treated as a policy executable; otherwise, it will be
      treated as a config file.

      If a custom policy executable is configured, the CA Puppet Server will run it
      every time it receives a CSR. The executable will be passed the subject CN of the
      request _as a command line argument,_ and the contents of the CSR in PEM format
      _on stdin._ It should exit with a status of 0 if the cert should be autosigned
      and non-zero if the cert should not be autosigned.

      If a certificate request is not autosigned, it will persist for review. An admin
      user can use the `puppetserver ca sign` command to manually sign it, or can delete
      the request.

      For info on autosign configuration files, see
      [the guide to Puppet's config files](https://puppet.com/docs/puppet/latest/config_file_autosign.html).",
  },
  :allow_duplicate_certs => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether to allow a new certificate request to overwrite an existing
      certificate request. If true, then the old certificate must be cleaned using
      `puppetserver ca clean`, and the new request signed using `puppetserver ca sign`."
  },
  :ca_ttl => {
    :default    => "5y",
    :type       => :duration,
    :desc       => "The default TTL for new certificates.
    #{AS_DURATION}",
  },
  :ca_refresh_interval => {
    :default    => "1d",
    :type       => :duration,
    :desc       => "How often the Puppet agent refreshes its local CA
       certificates. By default, CA certificates are refreshed every 24 hours. If a
       different interval is specified, the agent refreshes its CA certificates during
       the next agent run if the elapsed time since the certificates were last
       refreshed exceeds the specified duration.

       In general, the interval should be greater than the `runinterval`
       value. Setting the `ca_refresh_interval` value to 0 or an equal or
       lesser value than `runinterval` causes the CA certificates to be
       refreshed on every run.

       If the agent downloads new CA certs, the agent uses those for subsequent
       network requests. If the refresh request fails or if the CA certs are
       unchanged on the server, then the agent run will continue using the
       local CA certs it already has. #{AS_DURATION}",
  },
  :crl_refresh_interval => {
    :default    => "1d",
    :type       => :duration,
    :desc       => "How often the Puppet agent refreshes its local Certificate
       Revocation List (CRL). By default, the CRL is refreshed every 24 hours. If
       a different interval is specified, the agent refreshes its CRL on the next
       Puppet agent run if the elapsed time since the CRL was last refreshed
       exceeds the specified interval.

       In general, the interval should be greater than the `runinterval` value.
       Setting the `crl_refresh_interval` value to 0 or an equal or lesser value
       than `runinterval` causes the CRL to be refreshed on every run.

       If the agent downloads a new CRL, the agent will use it for subsequent
       network requests. If the refresh request fails or if the CRL is
       unchanged on the server, then the agent run will continue using the
       local CRL it already has.#{AS_DURATION}",
  },
  :hostcert_renewal_interval => {
    :default => "30d",
    :type    => :duration,
    :desc => "How often the Puppet agent renews its client certificate. By
       default, the client certificate is renewed 30 days before the certificate
       expires. If a different interval is specified, the agent renews its client
       certificate during the next agent run, assuming that the client certificate has
       expired within the specified duration.

       In general, the `hostcert_renewal_interval` value should be greater than the
       `runinterval` value. Setting the `hostcert_renewal_interval` value to 0 disables
       automatic renewal.

       If the agent downloads a new certificate, the agent will use it
       for subsequent network requests. If the refresh request fails, the agent run
       continues to use its existing certificate. #{AS_DURATION}",
  },
  :keylength => {
    :default    => 4096,
    :type       => :integer,
    :desc       => "The bit length of keys.",
  },
  :cert_inventory => {
    :default => "$cadir/inventory.txt",
    :type => :file,
    :desc => "The inventory file. This is a text file to which the CA writes a
      complete listing of all certificates.",
  }
)

  # Define the config default.

  settings.define_settings(:application,
    :config_file_name => {
        :type     => :string,
        :default  => Puppet::Settings.default_config_file_name,
        :desc     => "The name of the puppet config file.",
    },
    :config => {
        :type => :file,
        :default  => "$confdir/${config_file_name}",
        :desc     => "The configuration file for the current puppet application.",
    },
    :pidfile => {
        :type => :file,
        :default  => "$rundir/${run_mode}.pid",
        :desc     => "The file containing the PID of a running process.
          This file is intended to be used by service management frameworks
          and monitoring systems to determine if a puppet process is still in
          the process table.",
    },
    :sourceaddress => {
      :default    => nil,
      :desc       => "The address the agent should use to initiate requests.",
    }
  )

settings.define_settings(:environment,
  :manifest => {
    :default    => nil,
    :type       => :file_or_directory,
    :desc       => "The entry-point manifest for the primary server. This can be one file
      or a directory of manifests to be evaluated in alphabetical order. Puppet manages
      this path as a directory if one exists or if the path ends with a / or \\.

      Setting a global value for `manifest` in puppet.conf is not allowed
      (but it can be overridden from the commandline). Please use
      directory environments instead. If you need to use something other than the
      environment's `manifests` directory as the main manifest, you can set
      `manifest` in environment.conf. For more info, see
      <https://puppet.com/docs/puppet/latest/environments_about.html>",
  },
  :modulepath => {
    :default => "",
    :type => :path,
    :desc => "The search path for modules, as a list of directories separated by the system
      path separator character. (The POSIX path separator is ':', and the
      Windows path separator is ';'.)

      Setting a global value for `modulepath` in puppet.conf is not allowed
      (but it can be overridden from the commandline). Please use
      directory environments instead. If you need to use something other than the
      default modulepath of `<ACTIVE ENVIRONMENT'S MODULES DIR>:$basemodulepath`,
      you can set `modulepath` in environment.conf. For more info, see
      <https://puppet.com/docs/puppet/latest/environments_about.html>",
  },
  :config_version => {
    :default    => "",
    :desc       => "How to determine the configuration version.  By default, it will be the
    time that the configuration is parsed, but you can provide a shell script to override how the
    version is determined.  The output of this script will be added to every log message in the
    reports, allowing you to correlate changes on your hosts to the source version on the server.

    Setting a global value for config_version in puppet.conf is not allowed
    (but it can be overridden from the commandline). Please set a
    per-environment value in environment.conf instead. For more info, see
    <https://puppet.com/docs/puppet/latest/environments_about.html>",
  }
)

settings.define_settings(:server,
  :user => {
    :default    => "puppet",
    :desc       => "The user Puppet Server will run as. Used to ensure
    the agent side processes (agent, apply, etc) create files and
    directories readable by Puppet Server when necessary.",
  },
  :group => {
    :default    => "puppet",
    :desc       => "The group Puppet Server will run as. Used to ensure
    the agent side processes (agent, apply, etc) create files and
    directories readable by Puppet Server when necessary.",
  },
  :default_manifest => {
    :default    => "./manifests",
    :type       => :string,
    :desc       => "The default main manifest for directory environments. Any environment that
      doesn't set the `manifest` setting in its `environment.conf` file will use
      this manifest.

      This setting's value can be an absolute or relative path. An absolute path
      will make all environments default to the same main manifest; a relative
      path will allow each environment to use its own manifest, and Puppet will
      resolve the path relative to each environment's main directory.

      In either case, the path can point to a single file or to a directory of
      manifests to be evaluated in alphabetical order.",
  },
  :disable_per_environment_manifest => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether to disallow an environment-specific main manifest. When set
      to `true`, Puppet will use the manifest specified in the `default_manifest` setting
      for all environments. If an environment specifies a different main manifest in its
      `environment.conf` file, catalog requests for that environment will fail with an error.

      This setting requires `default_manifest` to be set to an absolute path.",
    :hook       => proc do |value|
      if value && !Pathname.new(Puppet[:default_manifest]).absolute?
        raise(Puppet::Settings::ValidationError,
              "The 'default_manifest' setting must be set to an absolute path when 'disable_per_environment_manifest' is true")
      end
    end,
  },
  :code => {
    :default    => "",
    :desc       => "Code to parse directly.  This is essentially only used
    by `puppet`, and should only be set if you're writing your own Puppet
    executable.",
  },
  :masterport => {
    :default    => 8140,
    :type       => :port,
    :desc       => "The default port puppet subcommands use to communicate
    with Puppet Server. (eg `puppet facts upload`, `puppet agent`). May be
    overridden by more specific settings (see `ca_port`, `report_port`).",
  },
  :serverport => {
    :type => :alias,
    :alias_for => :masterport
  },
  :bucketdir => {
    :default => "$vardir/bucket",
    :type => :directory,
    :mode => "0750",
    :owner => "service",
    :group => "service",
    :desc => "Where FileBucket files are stored."
  },
  :trusted_oid_mapping_file => {
    :default    => "$confdir/custom_trusted_oid_mapping.yaml",
    :type       => :file,
    :desc       => "File that provides mapping between custom SSL oids and user-friendly names"
  },
  :basemodulepath => {
    :default => -> { default_basemodulepath },
    :type => :path,
    :desc => "The search path for **global** modules. Should be specified as a
      list of directories separated by the system path separator character. (The
      POSIX path separator is ':', and the Windows path separator is ';'.)

      These are the modules that will be used by _all_ environments. Note that
      the `modules` directory of the active environment will have priority over
      any global directories. For more info, see
      <https://puppet.com/docs/puppet/latest/environments_about.html>",
  },
  :vendormoduledir => {
    :default => -> { default_vendormoduledir },
    :type => :string,
    :desc => "The directory containing **vendored** modules. These modules will
    be used by _all_ environments like those in the `basemodulepath`. The only
    difference is that modules in the `basemodulepath` are pluginsynced, while
    vendored modules are not",
  },
  :ssl_client_header => {
    :default    => "HTTP_X_CLIENT_DN",
    :desc       => "The header containing an authenticated client's SSL DN.
    This header must be set by the proxy to the authenticated client's SSL
    DN (e.g., `/CN=puppet.puppetlabs.com`).  Puppet will parse out the Common
    Name (CN) from the Distinguished Name (DN) and use the value of the CN
    field for authorization.

    Note that the name of the HTTP header gets munged by the web server
    common gateway interface: an `HTTP_` prefix is added, dashes are converted
    to underscores, and all letters are uppercased.  Thus, to use the
    `X-Client-DN` header, this setting should be `HTTP_X_CLIENT_DN`.",
  },
  :ssl_client_verify_header => {
    :default    => "HTTP_X_CLIENT_VERIFY",
    :desc       => "The header containing the status message of the client
    verification. This header must be set by the proxy to 'SUCCESS' if the
    client successfully authenticated, and anything else otherwise.

    Note that the name of the HTTP header gets munged by the web server
    common gateway interface: an `HTTP_` prefix is added, dashes are converted
    to underscores, and all letters are uppercased.  Thus, to use the
    `X-Client-Verify` header, this setting should be
    `HTTP_X_CLIENT_VERIFY`.",
  },
  # To make sure this directory is created before we try to use it on the server, we need
  # it to be in the server section (#1138).
  :yamldir => {
    :default => "$vardir/yaml",
    :type => :directory,
    :owner => "service",
    :group => "service",
    :mode => "0750",
    :desc => "The directory in which YAML data is stored, usually in a subdirectory."},
  :server_datadir => {
    :default => "$vardir/server_data",
    :type => :directory,
    :owner => "service",
    :group => "service",
    :mode => "0750",
    :desc => "The directory in which serialized data is stored, usually in a subdirectory."},
  :reports => {
    :default    => "store",
    :desc       => "The list of report handlers to use. When using multiple report handlers,
      their names should be comma-separated, with whitespace allowed. (For example,
      `reports = http, store`.)

      This setting is relevant to puppet server and puppet apply. The primary Puppet
      server will call these report handlers with the reports it receives from
      agent nodes, and puppet apply will call them with its own report. (In
      all cases, the node applying the catalog must have `report = true`.)

      See the report reference for information on the built-in report
      handlers; custom report handlers can also be loaded from modules.
      (Report handlers are loaded from the lib directory, at
      `puppet/reports/NAME.rb`.)

      To turn off reports entirely, set this to `none`",
  },
  :exclude_unchanged_resources => {
    :default => true,
    :type => :boolean,
    :desc => "Specifies how unchanged resources are listed in reports. When
      set to `true`, resources that have had no changes after catalog application
      will not have corresponding unchanged resource status updates listed in a
      report."
  },
  :reportdir => {
    :default => "$vardir/reports",
    :type => :directory,
    :mode => "0750",
    :owner => "service",
    :group => "service",
    :desc => "The directory in which to store reports. Each node gets
      a separate subdirectory in this directory. This setting is only
      used when the `store` report processor is enabled (see the
      `reports` setting)."},
  :reporturl => {
    :default    => "http://localhost:3000/reports/upload",
    :desc       => "The URL that reports should be forwarded to. This setting
      is only used when the `http` report processor is enabled (see the
      `reports` setting).",
  },
  :fileserverconfig => {
    :default    => "$confdir/fileserver.conf",
    :type       => :file,
    :desc       => "Where the fileserver configuration is stored.",
  })

settings.define_settings(:device,
  :devicedir =>  {
      :default  => "$vardir/devices",
      :type     => :directory,
      :mode     => "0750",
      :owner    => "service",
      :group    => "service",
      :desc     => "The root directory of devices' $vardir.",
  },
  :deviceconfig => {
      :default  => "$confdir/device.conf",
      :desc     => "Path to the device config file for puppet device.",
  }
)

settings.define_settings(:agent,
  :node_name_value => {
    :default => "$certname",
    :desc => "The explicit value used for the node name for all requests the agent
      makes to the primary server. WARNING: This setting is mutually exclusive with
      node_name_fact.  Changing this setting also requires changes to
      Puppet Server's default [auth.conf](https://puppet.com/docs/puppetserver/latest/config_file_auth.html)."
  },
  :node_name_fact => {
    :default => "",
    :desc => "The fact name used to determine the node name used for all requests the agent
      makes to the primary server. WARNING: This setting is mutually exclusive with
      node_name_value.  Changing this setting also requires changes to
      Puppet Server's default [auth.conf](https://puppet.com/docs/puppetserver/latest/config_file_auth.html).",
    :hook => proc do |value|
      if !value.empty? and Puppet[:node_name_value] != Puppet[:certname]
        raise "Cannot specify both the node_name_value and node_name_fact settings"
      end
    end
  },
  :statefile => {
    :default => "$statedir/state.yaml",
    :type => :file,
    :mode => "0640",
    :desc => "Where Puppet agent and Puppet Server store state associated
      with the running configuration.  In the case of Puppet Server,
      this file reflects the state discovered through interacting
      with clients."
  },
  :statettl => {
    :default => "32d",
    :type    => :ttl,
    :desc    => "How long the Puppet agent should cache when a resource was last checked or synced.
    #{AS_DURATION}
    A value of `0` or `unlimited` will disable cache pruning.

    This setting affects the usage of `schedule` resources, as the information
    about when a resource was last checked (and therefore when it needs to be
    checked again) is stored in the `statefile`. The `statettl` needs to be
    large enough to ensure that a resource will not trigger multiple times
    during a schedule due to its entry expiring from the cache."
  },
  :transactionstorefile => {
    :default => "$statedir/transactionstore.yaml",
    :type => :file,
    :mode => "0640",
    :desc => "Transactional storage file for persisting data between
      transactions for the purposes of inferring information (such as
      corrective_change) on new data received."
  },
  :clientyamldir => {
    :default => "$vardir/client_yaml",
    :type => :directory,
    :mode => "0750",
    :desc => "The directory in which client-side YAML data is stored."
  },
  :client_datadir => {
    :default => "$vardir/client_data",
    :type => :directory,
    :mode => "0750",
    :desc => "The directory in which serialized data is stored on the client."
  },
  :write_catalog_summary => {
    :default => true,
    :type => :boolean,
    :desc => "Whether to write the `classfile` and `resourcefile` after applying
      the catalog. It is enabled by default, except when running `puppet apply`.",
  },
  :classfile => {
    :default => "$statedir/classes.txt",
    :type => :file,
    :owner => "root",
    :mode => "0640",
    :desc => "The file in which puppet agent stores a list of the classes
      associated with the retrieved configuration.  Can be loaded in
      the separate `puppet` executable using the `--loadclasses`
      option."},
  :resourcefile => {
    :default => "$statedir/resources.txt",
    :type => :file,
    :owner => "root",
    :mode => "0640",
    :desc => "The file in which puppet agent stores a list of the resources
      associated with the retrieved configuration." },
  :puppetdlog => {
    :default => "$logdir/puppetd.log",
    :type => :file,
    :owner => "root",
    :mode => "0640",
    :desc => "The fallback log file. This is only used when the `--logdest` option
      is not specified AND Puppet is running on an operating system where both
      the POSIX syslog service and the Windows Event Log are unavailable. (Currently,
      no supported operating systems match that description.)

      Despite the name, both puppet agent and puppet server will use this file
      as the fallback logging destination.

      For control over logging destinations, see the `--logdest` command line
      option in the manual pages for puppet server, puppet agent, and puppet
      apply. You can see man pages by running `puppet <SUBCOMMAND> --help`,
      or read them online at https://puppet.com/docs/puppet/latest/man/."
  },
  :deviceconfdir => {
    :default  => "$confdir/devices",
    :type     => :directory,
    :mode     => "0750",
    :owner    => "service",
    :group    => "service",
    :desc     => "The root directory of devices' $confdir.",
  },
  :server => {
    :default => "puppet",
    :desc => "The primary Puppet server to which the Puppet agent should connect.",
  },
  :server_list => {
    :default => [],
    :type => :server_list,
    :desc => "The list of primary Puppet servers to which the Puppet agent should connect,
      in the order that they will be tried. Each value should be a fully qualified domain name, followed by an optional ':' and port number. If a port is omitted, Puppet uses masterport for that host.",
  },
  :use_srv_records => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether the server will search for SRV records in DNS for the current domain.",
  },
  :srv_domain => {
    :default    => -> { Puppet::Settings.domain_fact },
    :desc       => "The domain which will be queried to find the SRV records of servers to use.",
  },
  :http_extra_headers => {
    :default => [],
    :type => :http_extra_headers,
    :desc => "The list of extra headers that will be sent with http requests to the primary server.
    The header definition consists of a name and a value separated by a colon."
  },
  :ignoreschedules => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Boolean; whether puppet agent should ignore schedules.  This is useful
    for initial puppet agent runs.",
  },
  :default_schedules => {
    :default    => true,
    :type       => :boolean,
    :desc       => "Boolean; whether to generate the default schedule resources. Setting this to
    false is useful for keeping external report processors clean of skipped schedule resources.",
  },
  :noop => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether to apply catalogs in noop mode, which allows Puppet to
      partially simulate a normal run. This setting affects puppet agent and
      puppet apply.

      When running in noop mode, Puppet will check whether each resource is in sync,
      like it does when running normally. However, if a resource attribute is not in
      the desired state (as declared in the catalog), Puppet will take no
      action, and will instead report the changes it _would_ have made. These
      simulated changes will appear in the report sent to the primary Puppet server, or
      be shown on the console if running puppet agent or puppet apply in the
      foreground. The simulated changes will not send refresh events to any
      subscribing or notified resources, although Puppet will log that a refresh
      event _would_ have been sent.

      **Important note:**
      [The `noop` metaparameter](https://puppet.com/docs/puppet/latest/metaparameter.html#noop)
      allows you to apply individual resources in noop mode, and will override
      the global value of the `noop` setting. This means a resource with
      `noop => false` _will_ be changed if necessary, even when running puppet
      agent with `noop = true` or `--noop`. (Conversely, a resource with
      `noop => true` will only be simulated, even when noop mode is globally disabled.)",
  },
  :runinterval => {
    :default  => "30m",
    :type     => :duration,
    :desc     => "How often puppet agent applies the catalog.
        Note that a runinterval of 0 means \"run continuously\" rather than
        \"never run.\" #{AS_DURATION}",
  },
  :runtimeout => {
    :default  => "1h",
    :type     => :duration,
    :desc     => "The maximum amount of time an agent run is allowed to take.
        A Puppet agent run that exceeds this timeout will be aborted. A value
        of 0 disables the timeout. Defaults to 1 hour. #{AS_DURATION}",
  },
  :ca_server => {
    :default    => "$server",
    :desc       => "The server to use for certificate
    authority requests.  It's a separate server because it cannot
    and does not need to horizontally scale.",
  },
  :ca_port => {
    :default    => "$serverport",
    :type       => :port,
    :desc       => "The port to use for the certificate authority.",
  },
  :preferred_serialization_format => {
    :default    => "json",
    :desc       => "The preferred means of serializing
    ruby instances for passing over the wire.  This won't guarantee that all
    instances will be serialized using this method, since not all classes
    can be guaranteed to support this format, but it will be used for all
    classes that support it.",
    :hook => proc { |value|
      if value == "pson" && !Puppet.features.pson?
        raise(Puppet::Settings::ValidationError, "The 'puppet-pson' gem must be installed to use the PSON serialization format.")
      end
    }
  },
  :allow_pson_serialization => {
    :default    => false,
    :type       => :boolean,
    :desc => "Whether to allow PSON serialization. When unable to serialize to
      JSON or other formats, Puppet falls back to PSON. This option affects the
      configuration management service responses of Puppet Server and the process by
      which the agent saves its cached catalog. With a default value of `false`, this
      option is useful in preventing the loss of data because rich data cannot be
      serialized via PSON.",
  },
  :agent_catalog_run_lockfile => {
    :default    => "$statedir/agent_catalog_run.lock",
    :type       => :string, # (#2888) Ensure this file is not added to the settings catalog.
    :desc       => "A lock file to indicate that a puppet agent catalog run is currently in progress.
      The file contains the pid of the process that holds the lock on the catalog run.",
  },
  :agent_disabled_lockfile => {
      :default    => "$statedir/agent_disabled.lock",
      :type       => :string,
      :desc       => "A lock file to indicate that puppet agent runs have been administratively
        disabled.  File contains a JSON object with state information.",
  },
  :usecacheonfailure => {
    :default    => true,
    :type       => :boolean,
    :desc       => "Whether to use the cached configuration when the remote
      configuration will not compile.  This option is useful for testing
      new configurations, where you want to fix the broken configuration
      rather than reverting to a known-good one.",
  },
  :include_legacy_facts => {
    :type       => :boolean,
    :default    => false,
    :desc       => "Whether to include legacy facts when requesting a catalog. This
      option can be set to `false` if all puppet manifests, hiera.yaml, and hiera
      configuration layers no longer access legacy facts, such as `$osfamily`, and
      instead access structured facts, such as `$facts['os']['family']`."
  },
  :fact_name_length_soft_limit => {
    :default    => 2560,
    :type       => :integer,
    :desc       => "The soft limit for the length of a fact name.",
  },
  :fact_value_length_soft_limit => {
    :default    => 4096,
    :type       => :integer,
    :desc       => "The soft limit for the length of a fact value.",
  },
  :top_level_facts_soft_limit => {
    :default    => 512,
    :type       => :integer,
    :desc       => "The soft limit for the number of top level facts.",
  },
  :number_of_facts_soft_limit => {
    :default    => 10_240,
    :type       => :integer,
    :desc       => "The soft limit for the total number of fact values. This counts the
      child elements of all facts (e.g. all items of an array or a hash), not just top
      level facts.",
  },
  :payload_soft_limit => {
    :default    => 16 * 1024 * 1024,
    :type       => :integer,
    :desc       => "The soft limit for the size of the payload.",
  },
  :use_cached_catalog => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether to only use the cached catalog rather than compiling a new catalog
      on every run.  Puppet can be run with this enabled by default and then selectively
      disabled when a recompile is desired. Because a Puppet agent using cached catalogs
      does not contact the primary server for a new catalog, it also does not upload facts at
      the beginning of the Puppet run.",
  },
  :ignoremissingtypes => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Skip searching for classes and definitions that were missing during a
      prior compilation. The list of missing objects is maintained per-environment and
      persists until the environment is cleared or the primary server is restarted.",
  },
  :splaylimit => {
    :default    => "$runinterval",
    :type       => :duration,
    :desc       => "The maximum time to delay before an agent's first run when
      `splay` is enabled. Defaults to the agent's `$runinterval`. The
      `splay` interval is random and recalculated each time the agent is started or
      restarted. #{AS_DURATION}",
  },
  :splay => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether to sleep for a random amount of time, ranging from
      immediately up to its `$splaylimit`, before performing its first agent run
      after a service restart. After this period, the agent runs periodically
      on its `$runinterval`.

      For example, assume a default 30-minute `$runinterval`, `splay` set to its
      default of `false`, and an agent starting at :00 past the hour. The agent
      would check in every 30 minutes at :01 and :31 past the hour.

      With `splay` enabled, it waits any amount of time up to its `$splaylimit`
      before its first run. For example, it might randomly wait 8 minutes,
      then start its first run at :08 past the hour. With the `$runinterval`
      at its default 30 minutes, its next run will be at :38 past the hour.

      If you restart an agent's puppet service with `splay` enabled, it
      recalculates its splay period and delays its first agent run after
      restarting for this new period. If you simultaneously restart a group of
      puppet agents with `splay` enabled, their checkins to your primary servers
      can be distributed more evenly.",
  },
  :clientbucketdir => {
    :default  => "$vardir/clientbucket",
    :type     => :directory,
    :mode     => "0750",
    :desc     => "Where FileBucket files are stored locally."
  },
  :report_server => {
    :default  => "$server",
    :desc     => "The server to send transaction reports to.",
  },
  :report_port => {
    :default  => "$serverport",
    :type     => :port,
    :desc     => "The port to communicate with the report_server.",
  },
  :report => {
    :default  => true,
    :type     => :boolean,
    :desc     => "Whether to send reports after every transaction.",
  },
  :report_include_system_store => {
    :default  => false,
    :type     => :boolean,
    :desc     => "Whether the 'http' report processor should include the system
      certificate store when submitting reports to HTTPS URLs. If false, then
      the 'http' processor will only trust HTTPS report servers whose certificates
      are issued by the puppet CA or one of its intermediate CAs. If true, the
      processor will additionally trust CA certificates in the system's
      certificate store."
  },
  :resubmit_facts => {
    :default  => false,
    :type     => :boolean,
    :desc     => "Whether to send updated facts after every transaction. By default
      puppet only submits facts at the beginning of the transaction before applying a
      catalog. Since puppet can modify the state of the system, the value of the facts
      may change after puppet finishes. Therefore, any facts stored in puppetdb may not
      be consistent until the agent next runs, typically in 30 minutes. If this feature
      is enabled, puppet will resubmit facts after applying its catalog, ensuring facts
      for the node stored in puppetdb are current. However, this will double the fact
      submission load on puppetdb, so it is disabled by default.",
  },
  :publicdir => {
    :default  => nil,
    :type     => :directory,
    :mode     => "0755",
    :desc     => "Where Puppet stores public files."
  },
  :lastrunfile =>  {
    :default  => "$publicdir/last_run_summary.yaml",
    :type     => :file,
    :mode     => "0640",
    :desc     => "Where puppet agent stores the last run report summary in yaml format."
  },
  :lastrunreport =>  {
    :default  => "$statedir/last_run_report.yaml",
    :type     => :file,
    :mode     => "0640",
    :desc     => "Where Puppet Agent stores the last run report, by default, in yaml format.
      The format of the report can be changed by setting the `cache` key of the `report` terminus
      in the [routes.yaml](https://puppet.com/docs/puppet/latest/config_file_routes.html) file.
      To avoid mismatches between content and file extension, this setting needs to be
      manually updated to reflect the terminus changes."
  },
  :graph => {
    :default  => false,
    :type     => :boolean,
    :desc     => "Whether to create .dot graph files, which let you visualize the
      dependency and containment relationships in Puppet's catalog. You
      can load and view these files with tools like
      [OmniGraffle](http://www.omnigroup.com/applications/omnigraffle/) (OS X)
      or [graphviz](http://www.graphviz.org/) (multi-platform).

      Graph files are created when _applying_ a catalog, so this setting
      should be used on nodes running `puppet agent` or `puppet apply`.

      The `graphdir` setting determines where Puppet will save graphs. Note
      that we don't save graphs for historical runs; Puppet will replace the
      previous .dot files with new ones every time it applies a catalog.

      See your graphing software's documentation for details on opening .dot
      files. If you're using GraphViz's `dot` command, you can do a quick PNG
      render with `dot -Tpng <DOT FILE> -o <OUTPUT FILE>`.",
  },
  :graphdir => {
    :default    => "$statedir/graphs",
    :type       => :directory,
    :desc       => "Where to save .dot-format graphs (when the `graph` setting is enabled).",
  },
  :waitforcert => {
    :default  => "2m",
    :type     => :duration,
    :desc     => "How frequently puppet agent should ask for a signed certificate.

    When starting for the first time, puppet agent will submit a certificate
    signing request (CSR) to the server named in the `ca_server` setting
    (usually the primary Puppet server); this may be autosigned, or may need to be
    approved by a human, depending on the CA server's configuration.

    Puppet agent cannot apply configurations until its approved certificate is
    available. Since the certificate may or may not be available immediately,
    puppet agent will repeatedly try to fetch it at this interval. You can
    turn off waiting for certificates by specifying a time of 0, or a maximum
    amount of time to wait in the `maxwaitforcert` setting, in which case
    puppet agent will exit if it cannot get a cert.
    #{AS_DURATION}",
  },
  :maxwaitforcert => {
    :default  => "unlimited",
    :type     => :ttl,
    :desc     => "The maximum amount of time the Puppet agent should wait for its
    certificate request to be signed. A value of `unlimited` will cause puppet agent
    to ask for a signed certificate indefinitely.
    #{AS_DURATION}",
  },
  :waitforlock => {
    :default  => "0",
    :type     => :duration,
    :desc     => "How frequently puppet agent should try running when there is an
    already ongoing puppet agent instance.

    This argument is by default disabled (value set to 0). In this case puppet agent will
    immediately exit if it cannot run at that moment. When a value other than 0 is set, this
    can also be used in combination with the `maxwaitforlock` argument.
    #{AS_DURATION}",
  },
  :maxwaitforlock => {
    :default  => "1m",
    :type     => :ttl,
    :desc     => "The maximum amount of time the puppet agent should wait for an
    already running puppet agent to finish before starting a new one. This is set by default to 1 minute.
    A value of `unlimited` will cause puppet agent to wait indefinitely.
    #{AS_DURATION}",
  }
)

# Plugin information.

settings.define_settings(
  :main,
  :plugindest => {
    :type       => :directory,
    :default    => "$libdir",
    :desc       => "Where Puppet should store plugins that it pulls down from the central
    server.",
  },
  :pluginsource => {
    :default    => "puppet:///plugins",
    :desc       => "From where to retrieve plugins.  The standard Puppet `file` type
    is used for retrieval, so anything that is a valid file source can
    be used here.",
  },
  :pluginfactdest => {
    :type     => :directory,
    :default  => "$vardir/facts.d",
    :desc     => "Where Puppet should store external facts that are being handled by pluginsync",
  },
  :pluginfactsource => {
    :default  => "puppet:///pluginfacts",
    :desc     => "Where to retrieve external facts for pluginsync",
  },
  :localedest => {
    :type       => :directory,
    :default    => "$vardir/locales",
    :desc       => "Where Puppet should store translation files that it pulls down from the central
    server.",
  },
  :localesource => {
    :default    => "puppet:///locales",
    :desc       => "From where to retrieve translation files.  The standard Puppet `file` type
    is used for retrieval, so anything that is a valid file source can
    be used here.",
  },
  :pluginsync => {
    :default    => true,
    :type       => :boolean,
    :desc       => "Whether plugins should be synced with the central server. This setting is
      deprecated.",
    :hook => proc { |_value|
      #TRANSLATORS 'pluginsync' is a setting and should not be translated
      Puppet.deprecation_warning(_("Setting 'pluginsync' is deprecated."))
    }
  },
  :pluginsignore => {
      :default  => ".svn CVS .git .hg",
      :desc     => "What files to ignore when pulling down plugins.",
  },
  :ignore_plugin_errors => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether the puppet run should ignore errors during pluginsync. If the setting
      is false and there are errors during pluginsync, then the agent will abort the run and
      submit a report containing information about the failed run."
  }
)

  # Central fact information.

  settings.define_settings(
  :main,
  :factpath => {
    :type     => :path,
    :default  => "$vardir/lib/facter#{File::PATH_SEPARATOR}$vardir/facts",
    :desc     => "Where Puppet should look for facts.  Multiple directories should
      be separated by the system path separator character. (The POSIX path
      separator is ':', and the Windows path separator is ';'.)",

    :call_hook => :on_initialize_and_write, # Call our hook with the default value, so we always get the value added to facter.
    :hook => proc do |value|
      paths = value.split(File::PATH_SEPARATOR)
      facter = Puppet.runtime[:facter]
      facter.search(*paths)
    end
  }
)

settings.define_settings(
  :transaction,
  :tags => {
    :default    => "",
    :desc       => "Tags to use to find resources.  If this is set, then
      only resources tagged with the specified tags will be applied.
      Values must be comma-separated.",
  },
  :skip_tags => {
    :default    => "",
    :desc       => "Tags to use to filter resources.  If this is set, then
      only resources not tagged with the specified tags will be applied.
      Values must be comma-separated.",
  },
  :evaltrace => {
    :default    => false,
    :type       => :boolean,
    :desc       => "Whether each resource should log when it is
      being evaluated.  This allows you to interactively see exactly
      what is being done.",
  },
  :preprocess_deferred => {
    :default => false,
    :type => :boolean,
    :desc => "Whether Puppet should call deferred functions before applying
      the catalog. If set to `true`, all prerequisites required for the
      deferred function must be satisfied before the Puppet run. If set to
      `false`, deferred functions follow Puppet relationships and
      ordering. In this way, Puppet can install the prerequisites required for a
      deferred function and call the deferred function in the same run.",
  },
  :summarize => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to print a transaction summary.",
  }
)

  settings.define_settings(
  :main,
  :external_nodes => {
      :default  => "none",
      :desc     => "The external node classifier (ENC) script to use for node data.
        Puppet combines this data with the main manifest to produce node catalogs.

        To enable this setting, set the `node_terminus` setting to `exec`.

        This setting's value must be the path to an executable command that
        can produce node information. The command must:

        * Take the name of a node as a command-line argument.

        * Return a YAML hash with up to three keys:
          * `classes` --- A list of classes, as an array or hash.
          * `environment` --- A string.
          * `parameters` --- A list of top-scope variables to set, as a hash.

        * For unknown nodes, exit with a non-zero exit code.

        Generally, an ENC script makes requests to an external data source.

        For more info, see [the ENC documentation](https://puppet.com/docs/puppet/latest/nodes_external.html).",
  }
)

      settings.define_settings(
      :ldap,
  :ldapssl => {
    :default  => false,
    :type   => :boolean,
    :desc   => "Whether SSL should be used when searching for nodes.
      Defaults to false because SSL usually requires certificates
      to be set up on the client side.",
  },
  :ldaptls => {
    :default  => false,
    :type     => :boolean,
    :desc     => "Whether TLS should be used when searching for nodes.
      Defaults to false because TLS usually requires certificates
      to be set up on the client side.",
  },
  :ldapserver => {
    :default  => "ldap",
    :desc     => "The LDAP server.",
  },
  :ldapport => {
    :default  => 389,
    :type     => :port,
    :desc     => "The LDAP port.",
  },

  :ldapstring => {
    :default  => "(&(objectclass=puppetClient)(cn=%s))",
    :desc     => "The search string used to find an LDAP node.",
  },
  :ldapclassattrs => {
    :default  => "puppetclass",
    :desc     => "The LDAP attributes to use to define Puppet classes.  Values
      should be comma-separated.",
  },
  :ldapstackedattrs => {
    :default  => "puppetvar",
    :desc     => "The LDAP attributes that should be stacked to arrays by adding
      the values in all hierarchy elements of the tree.  Values
      should be comma-separated.",
  },
  :ldapattrs => {
    :default  => "all",
    :desc     => "The LDAP attributes to include when querying LDAP for nodes.  All
      returned attributes are set as variables in the top-level scope.
      Multiple values should be comma-separated.  The value 'all' returns
      all attributes.",
  },
  :ldapparentattr => {
    :default  => "parentnode",
    :desc     => "The attribute to use to define the parent node.",
  },
  :ldapuser => {
    :default  => "",
    :desc     => "The user to use to connect to LDAP.  Must be specified as a
      full DN.",
  },
  :ldappassword => {
    :default  => "",
    :desc     => "The password to use to connect to LDAP.",
  },
  :ldapbase => {
      :default  => "",
      :desc     => "The search base for LDAP searches.  It's impossible to provide
        a meaningful default here, although the LDAP libraries might
        have one already set.  Generally, it should be the 'ou=Hosts'
        branch under your main directory.",
  }
    )

settings.define_settings(:server,
  :storeconfigs => {
    :default  => false,
    :type     => :boolean,
    :desc     => "Whether to store each client's configuration, including catalogs, facts,
      and related data. This also enables the import and export of resources in
      the Puppet language - a mechanism for exchange resources between nodes.

      By default this uses the 'puppetdb' backend.

      You can adjust the backend using the storeconfigs_backend setting.",
    # Call our hook with the default value, so we always get the libdir set.
    :call_hook => :on_initialize_and_write,
    :hook => proc do |value|
      require_relative '../puppet/node'
      require_relative '../puppet/node/facts'
      if value
        Puppet::Resource::Catalog.indirection.set_global_setting(:cache_class, :store_configs)
        settings.override_default(:catalog_cache_terminus, :store_configs)
        Puppet::Node::Facts.indirection.set_global_setting(:cache_class, :store_configs)
        Puppet::Resource.indirection.set_global_setting(:terminus_class, :store_configs)
      end
    end
  },
  :storeconfigs_backend => {
    :type => :terminus,
    :default => "puppetdb",
    :desc => "Configure the backend terminus used for StoreConfigs.
      By default, this uses the PuppetDB store, which must be installed
      and configured before turning on StoreConfigs."
  }
)

settings.define_settings(:parser,
 :max_errors => {
   :default => 10,
   :type => :integer,
   :desc => <<-'EOT'
     Sets the max number of logged/displayed parser validation errors in case
     multiple errors have been detected. A value of 0 is the same as a value of 1; a
     minimum of one error is always raised.  The count is per manifest.
   EOT
 },
 :max_warnings => {
   :default => 10,
   :type => :integer,
   :desc => <<-'EOT'
     Sets the max number of logged/displayed parser validation warnings in
     case multiple warnings have been detected. A value of 0 blocks logging of
     warnings.  The count is per manifest.
   EOT
   },
:max_deprecations => {
  :default => 10,
  :type => :integer,
  :desc => <<-'EOT'
    Sets the max number of logged/displayed parser validation deprecation
    warnings in case multiple deprecation warnings have been detected. A value of 0
    blocks the logging of deprecation warnings.  The count is per manifest.
  EOT
  },
:strict_variables => {
  :default => true,
  :type => :boolean,
  :desc => <<-'EOT'
    Causes an evaluation error when referencing unknown variables. (This does not affect
    referencing variables that are explicitly set to undef).
  EOT
  },
:tasks => {
  :default => false,
  :type => :boolean,
  :desc => <<-'EOT'
    Turns on experimental support for tasks and plans in the puppet language. This is for internal API use only.
    Do not change this setting.
  EOT
  }
)
settings.define_settings(:puppetdoc,
  :document_all => {
      :default  => false,
      :type     => :boolean,
      :desc     => "Whether to document all resources when using `puppet doc` to
        generate manifest documentation.",
  }
)

settings.define_settings(
  :main,
  :rich_data => {
    :default  => true,
    :type     => :boolean,
    :desc     => <<-'EOT'
      Enables having extended data in the catalog by storing them as a hash with the special key
      `__ptype`. When enabled, resource containing values of the data types `Binary`, `Regexp`,
      `SemVer`, `SemVerRange`, `Timespan` and `Timestamp`, as well as instances of types derived
      from `Object` retain their data type.
    EOT
  }
)
end

.initialize_facts ⇒ Object

Initialize puppet’s core facts. It should not be called before initialize_settings.

# File 'lib/puppet.rb', line 187

def self.initialize_facts
  # Add the puppetversion fact; this is done before generating the hash so it is
  # accessible to custom facts.
  Puppet.runtime[:facter].add(:puppetversion) do
    setcode { Puppet.version.to_s }
  end

  Puppet.runtime[:facter].add(:agent_specified_environment) do
    setcode do
      Puppet.settings.set_by_cli(:environment) ||
        Puppet.settings.set_in_section(:environment, :agent) ||
        Puppet.settings.set_in_section(:environment, :main)
    end
  end
end

.initialize_settings(args = [], require_config = true, push_settings_globally = true, runtime_implementations = {}) ⇒ void

This method returns an undefined value.

Initialize puppet’s settings. This is intended only for use by external tools that are not

built off of the Faces API or the Puppet::Util::Application class. It may also be used
to initialize state so that a Face may be used programatically, rather than as a stand-alone
command-line tool.

Parameters:

• args (Array<String>) (defaults to: []) —

  the command line arguments to use for initialization

• require_config (Boolean) (defaults to: true) —

  controls loading of Puppet configuration files

• global_settings (Boolean) —

  controls push to global context after settings object initialization

• runtime_implementations (Hash<Symbol, Object>) (defaults to: {}) —

  runtime implementations to register

# File 'lib/puppet.rb', line 146

def self.initialize_settings(args = [], require_config = true, push_settings_globally = true, runtime_implementations = {})
  do_initialize_settings_for_run_mode(:user, args, require_config, push_settings_globally, runtime_implementations)
end

.lookup(name, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Lookup a binding by name or return a default value provided by a passed block (if given).

# File 'lib/puppet.rb', line 283

def self.lookup(name, &block)
  @context.lookup(name, &block)
end

.mark_context(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/puppet.rb', line 308

def self.mark_context(name)
  @context.mark(name)
end

.minor_version ⇒ String

Returns containing the puppet version to minor specificity, e.g. “3.0”.

Returns:

• (String) —

  containing the puppet version to minor specificity, e.g. “3.0”

# File 'lib/puppet/version.rb', line 71

def self.minor_version
  version.split('.')[0..1].join('.')
end

.override(bindings, description = "") { ... } ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

• bindings (Hash) —

  A hash of bindings to be merged with the parent context.

• description (String) (defaults to: "") —

  A description of the context.

Yields:

• A block executed in the context of the temporarily pushed bindings.

# File 'lib/puppet.rb', line 291

def self.override(bindings, description = "", &block)
  @context.override(bindings, description, &block)
end

.pop_context ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return to the previous context.

Raises:

• (StackUnderflow) —

  if the current context is the root

# File 'lib/puppet.rb', line 277

def self.pop_context
  @context.pop
end

.push_context(overrides, description = "") ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

• overrides (Hash) —

  A hash of bindings to be merged with the parent context.

• description (String) (defaults to: "") —

  A description of the context.

# File 'lib/puppet.rb', line 262

def self.push_context(overrides, description = "")
  @context.push(overrides, description)
end

.push_context_global(overrides, description = '') ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Push something onto the context and make it global across threads. This has the potential to convert threadlocal overrides earlier on the stack into global overrides.

# File 'lib/puppet.rb', line 270

def self.push_context_global(overrides, description = '')
  @context.unsafe_push_global(overrides, description)
end

.replace_settings_object(new_settings) ⇒ Object

The puppetserver project has its own settings class that is thread-aware; this method is here to allow the puppetserver to define its own custom settings class for multithreaded puppet. It is not intended for use outside of the puppetserver implmentation.

# File 'lib/puppet.rb', line 67

def self.replace_settings_object(new_settings)
  @@settings = new_settings
end

.restore(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

• name —

  The name of a previously ignored context key to restore; intended for test usage.

# File 'lib/puppet.rb', line 303

def self.restore(name)
  @context.restore(name)
end

.rollback_context(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/puppet.rb', line 313

def self.rollback_context(name)
  @context.rollback(name)
end

.run_mode ⇒ Object

# File 'lib/puppet.rb', line 110

def self.run_mode
  # This sucks (the existence of this method); there are a lot of places in our code that branch based the value of
  # "run mode", but there used to be some really confusing code paths that made it almost impossible to determine
  # when during the lifecycle of a puppet application run the value would be set properly.  A lot of the lifecycle
  # stuff has been cleaned up now, but it still seems frightening that we rely so heavily on this value.
  #
  # I'd like to see about getting rid of the concept of "run_mode" entirely, but there are just too many places in
  # the code that call this method at the moment... so I've settled for isolating it inside of the Settings class
  # (rather than using a global variable, as we did previously...).  Would be good to revisit this at some point.
  #
  # --cprice 2012-03-16
  Puppet::Util::RunMode[@@settings.preferred_run_mode]
end

.runtime ⇒ Object

# File 'lib/puppet.rb', line 317

def self.runtime
  @runtime
end

.settings ⇒ Object

Note: It’s important that these accessors (‘self.settings`, `self.[]`) are defined before we try to load any “features” (which happens a few lines below), because the implementation of the features loading may examine the values of settings.

# File 'lib/puppet.rb', line 59

def self.settings
  @@settings
end

.valid_digest_algorithms ⇒ Object

# File 'lib/puppet/defaults.rb', line 15

def self.valid_digest_algorithms
  Puppet::Util::Platform.fips_enabled? ?
    %w[sha256 sha384 sha512 sha224] :
    %w[sha256 sha384 sha512 sha224 md5]
end

.valid_file_checksum_types ⇒ Object

# File 'lib/puppet/defaults.rb', line 27

def self.valid_file_checksum_types
  Puppet::Util::Platform.fips_enabled? ?
    %w[sha256 sha256lite sha384 sha512 sha224 sha1 sha1lite mtime ctime] :
    %w[sha256 sha256lite sha384 sha512 sha224 sha1 sha1lite md5 md5lite mtime ctime]
end

.version ⇒ String

version is a public API method intended to always provide a fast and lightweight way to determine the version of Puppet.

The intent is that software external to Puppet be able to determine the Puppet version with no side-effects. The expected use is:

require 'puppet/version'
version = Puppet.version

This function has the following ordering precedence. This precedence list is designed to facilitate automated packaging tasks by simply writing to the VERSION file in the same directory as this source file.

1. If a version has been explicitly assigned using the Puppet.version=
   method, return that version.
2. If there is a VERSION file, read the contents, trim any
   trailing whitespace, and return that version string.
3. Return the value of the Puppet::PUPPETVERSION constant hard-coded into
   the source code.

If there is no VERSION file, the method must return the version string of the nearest parent version that is an officially released version. That is to say, if a branch named 3.1.x contains 25 patches on top of the most recent official release of 3.1.1, then the version method must return the string “3.1.1” if no “VERSION” file is present.

By design the version identifier is not intended to vary during the life a process. There is no guarantee provided that writing to the VERSION file while a Puppet process is running will cause the version string to be updated. On the contrary, the contents of the VERSION are cached to reduce filesystem accesses.

The VERSION file is intended to be used by package maintainers who may be applying patches or otherwise changing the software version in a manner that warrants a different software version identifier. The VERSION file is intended to be managed and owned by the release process and packaging related tasks, and as such should not reside in version control. The PUPPETVERSION constant is intended to be version controlled in history.

Ideally, this behavior will allow package maintainers to precisely specify the version of the software they’re packaging as in the following example:

$ git describe --match "3.0.*" > lib/puppet/VERSION
$ ruby -r puppet -e 'puts Puppet.version'
3.0.1-260-g9ca4e54

Returns:

• (String) —

  containing the puppet version, e.g. “3.0.1”

# File 'lib/puppet/version.rb', line 63

def self.version
  version_file = File.join(File.dirname(__FILE__), 'VERSION')
  return @puppet_version if @puppet_version

  @puppet_version = read_version_file(version_file) || PUPPETVERSION
end

.version=(version) ⇒ Object

# File 'lib/puppet/version.rb', line 75

def self.version=(version)
  @puppet_version = version
end