openvox 9.0.0.pre.alpha2 → 9.0.0.pre.beta2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +114 -1
- data/CODE_OF_CONDUCT.md +1 -1
- data/Gemfile +5 -5
- data/README.md +6 -6
- data/Rakefile +3 -3
- data/conf/environment.conf +2 -2
- data/conf/fileserver.conf +3 -3
- data/conf/puppet.conf +4 -4
- data/examples/enc/regexp_nodes/regexp_nodes.rb +2 -2
- data/examples/hiera/README.md +1 -1
- data/examples/nagios/check_puppet.rb +1 -1
- data/ext/README.md +3 -3
- data/ext/hiera/hiera.yaml +1 -1
- data/ext/project_data.yaml +1 -1
- data/ext/redhat/client.sysconfig +1 -0
- data/ext/solaris/smf/puppet.xml +2 -2
- data/ext/windows/puppet_interactive.bat +1 -1
- data/ext/windows/service/daemon.rb +5 -5
- data/lib/hiera/puppet_function.rb +1 -2
- data/lib/hiera_puppet.rb +1 -1
- data/lib/puppet/agent/disabler.rb +3 -3
- data/lib/puppet/agent/locker.rb +1 -1
- data/lib/puppet/agent.rb +2 -2
- data/lib/puppet/application/agent.rb +33 -35
- data/lib/puppet/application/apply.rb +7 -7
- data/lib/puppet/application/describe.rb +3 -3
- data/lib/puppet/application/device.rb +1 -1
- data/lib/puppet/application/doc.rb +5 -7
- data/lib/puppet/application/facts.rb +1 -1
- data/lib/puppet/application/filebucket.rb +5 -5
- data/lib/puppet/application/lookup.rb +8 -8
- data/lib/puppet/application/resource.rb +5 -5
- data/lib/puppet/application/script.rb +3 -3
- data/lib/puppet/application/ssl.rb +4 -4
- data/lib/puppet/application_support.rb +2 -2
- data/lib/puppet/configurer.rb +13 -7
- data/lib/puppet/confine/variable.rb +2 -2
- data/lib/puppet/context.rb +1 -1
- data/lib/puppet/data_binding.rb +1 -1
- data/lib/puppet/defaults.rb +157 -226
- data/lib/puppet/error.rb +1 -1
- data/lib/puppet/etc.rb +4 -4
- data/lib/puppet/face/catalog/select.rb +3 -3
- data/lib/puppet/face/catalog.rb +4 -4
- data/lib/puppet/face/config.rb +6 -6
- data/lib/puppet/face/facts.rb +6 -6
- data/lib/puppet/face/help/man.erb +3 -3
- data/lib/puppet/face/node/clean.rb +3 -3
- data/lib/puppet/face/node.rb +2 -2
- data/lib/puppet/face/plugin.rb +4 -4
- data/lib/puppet/functions/all.rb +4 -4
- data/lib/puppet/functions/any.rb +4 -4
- data/lib/puppet/functions/assert_type.rb +5 -5
- data/lib/puppet/functions/defined.rb +1 -1
- data/lib/puppet/functions/each.rb +11 -11
- data/lib/puppet/functions/epp.rb +5 -5
- data/lib/puppet/functions/eyaml_lookup_key.rb +1 -1
- data/lib/puppet/functions/filter.rb +5 -5
- data/lib/puppet/functions/find_file.rb +1 -1
- data/lib/puppet/functions/hiera.rb +4 -4
- data/lib/puppet/functions/hiera_array.rb +5 -5
- data/lib/puppet/functions/hiera_hash.rb +5 -5
- data/lib/puppet/functions/hiera_include.rb +6 -6
- data/lib/puppet/functions/hocon_data.rb +1 -1
- data/lib/puppet/functions/include.rb +1 -1
- data/lib/puppet/functions/index.rb +3 -3
- data/lib/puppet/functions/inline_epp.rb +6 -6
- data/lib/puppet/functions/json_data.rb +1 -1
- data/lib/puppet/functions/lest.rb +1 -1
- data/lib/puppet/functions/lookup.rb +14 -14
- data/lib/puppet/functions/map.rb +5 -5
- data/lib/puppet/functions/reduce.rb +6 -6
- data/lib/puppet/functions/regsubst.rb +1 -13
- data/lib/puppet/functions/reverse_each.rb +5 -5
- data/lib/puppet/functions/scanf.rb +1 -1
- data/lib/puppet/functions/step.rb +5 -5
- data/lib/puppet/functions/then.rb +1 -1
- data/lib/puppet/functions/tree_each.rb +3 -3
- data/lib/puppet/functions/versioncmp.rb +1 -1
- data/lib/puppet/functions/with.rb +2 -2
- data/lib/puppet/functions/yaml_data.rb +1 -1
- data/lib/puppet/generate/type.rb +5 -1
- data/lib/puppet/gettext/config.rb +5 -5
- data/lib/puppet/gettext/module_translations.rb +1 -1
- data/lib/puppet/graph/simple_graph.rb +0 -1
- data/lib/puppet/http/client.rb +5 -5
- data/lib/puppet/http/factory.rb +1 -1
- data/lib/puppet/http/resolver/server_list.rb +2 -2
- data/lib/puppet/http/service/compiler.rb +3 -3
- data/lib/puppet/http/service/file_server.rb +1 -1
- data/lib/puppet/http/service.rb +19 -1
- data/lib/puppet/http/session.rb +1 -1
- data/lib/puppet/http.rb +1 -1
- data/lib/puppet/indirector/catalog/compiler.rb +2 -2
- data/lib/puppet/indirector/data_binding/hiera.rb +93 -2
- data/lib/puppet/indirector/face.rb +4 -4
- data/lib/puppet/indirector/facts/facter.rb +7 -7
- data/lib/puppet/indirector/file_bucket_file/file.rb +2 -2
- data/lib/puppet/indirector/file_bucket_file/rest.rb +7 -3
- data/lib/puppet/indirector/file_content/file_server.rb +1 -1
- data/lib/puppet/indirector/file_metadata/file_server.rb +1 -1
- data/lib/puppet/indirector/node/exec.rb +1 -1
- data/lib/puppet/indirector/node/rest.rb +1 -1
- data/lib/puppet/indirector/report/processor.rb +1 -1
- data/lib/puppet/indirector.rb +1 -1
- data/lib/puppet/interface/documentation.rb +1 -1
- data/lib/puppet/interface/face_collection.rb +1 -1
- data/lib/puppet/interface/option.rb +2 -2
- data/lib/puppet/module/task.rb +1 -1
- data/lib/puppet/module_tool/applications/application.rb +1 -1
- data/lib/puppet/module_tool/metadata.rb +1 -2
- data/lib/puppet/module_tool.rb +1 -1
- data/lib/puppet/network/authorization.rb +1 -1
- data/lib/puppet/network/http/api.rb +2 -2
- data/lib/puppet/network/http/connection.rb +2 -2
- data/lib/puppet/node/environment.rb +6 -6
- data/lib/puppet/node.rb +2 -2
- data/lib/puppet/pal/catalog_compiler.rb +1 -1
- data/lib/puppet/pal/pal_impl.rb +1 -25
- data/lib/puppet/parser/compiler.rb +1 -1
- data/lib/puppet/parser/functions/assert_type.rb +5 -5
- data/lib/puppet/parser/functions/create_resources.rb +1 -1
- data/lib/puppet/parser/functions/defined.rb +1 -1
- data/lib/puppet/parser/functions/digest.rb +1 -1
- data/lib/puppet/parser/functions/each.rb +11 -11
- data/lib/puppet/parser/functions/epp.rb +5 -5
- data/lib/puppet/parser/functions/filter.rb +5 -5
- data/lib/puppet/parser/functions/generate.rb +1 -1
- data/lib/puppet/parser/functions/hiera.rb +3 -3
- data/lib/puppet/parser/functions/hiera_array.rb +4 -4
- data/lib/puppet/parser/functions/hiera_hash.rb +4 -4
- data/lib/puppet/parser/functions/hiera_include.rb +5 -5
- data/lib/puppet/parser/functions/include.rb +1 -1
- data/lib/puppet/parser/functions/inline_epp.rb +6 -6
- data/lib/puppet/parser/functions/inline_template.rb +1 -1
- data/lib/puppet/parser/functions/lest.rb +1 -1
- data/lib/puppet/parser/functions/lookup.rb +14 -14
- data/lib/puppet/parser/functions/map.rb +5 -5
- data/lib/puppet/parser/functions/reduce.rb +7 -7
- data/lib/puppet/parser/functions/reverse_each.rb +5 -5
- data/lib/puppet/parser/functions/scanf.rb +1 -1
- data/lib/puppet/parser/functions/step.rb +5 -5
- data/lib/puppet/parser/functions/then.rb +1 -1
- data/lib/puppet/parser/functions/versioncmp.rb +1 -1
- data/lib/puppet/parser/functions/with.rb +1 -1
- data/lib/puppet/parser/functions.rb +3 -3
- data/lib/puppet/parser/scope.rb +1 -1
- data/lib/puppet/plugins/syntax_checkers.rb +2 -2
- data/lib/puppet/plugins.rb +1 -1
- data/lib/puppet/pops/evaluator/collectors/exported_collector.rb +1 -1
- data/lib/puppet/pops/evaluator/deferred_resolver.rb +4 -1
- data/lib/puppet/pops/issues.rb +3 -3
- data/lib/puppet/pops/loader/module_loaders.rb +4 -4
- data/lib/puppet/pops/loader/ruby_legacy_function_instantiator.rb +1 -1
- data/lib/puppet/pops/loaders.rb +4 -4
- data/lib/puppet/pops/lookup/lookup_adapter.rb +7 -66
- data/lib/puppet/pops/model/factory.rb +5 -5
- data/lib/puppet/pops/resource/resource_type_impl.rb +1 -1
- data/lib/puppet/pops/serialization/to_data_converter.rb +1 -1
- data/lib/puppet/pops/types/iterable.rb +1 -1
- data/lib/puppet/property/keyvalue.rb +3 -3
- data/lib/puppet/provider/group/aix.rb +2 -2
- data/lib/puppet/provider/nameservice/directoryservice.rb +2 -2
- data/lib/puppet/provider/package/aix.rb +1 -1
- data/lib/puppet/provider/package/apt.rb +2 -2
- data/lib/puppet/provider/package/aptitude.rb +0 -1
- data/lib/puppet/provider/package/dnfmodule.rb +1 -1
- data/lib/puppet/provider/package/nim.rb +1 -1
- data/lib/puppet/provider/package/pacman.rb +1 -2
- data/lib/puppet/provider/package/pip.rb +1 -1
- data/lib/puppet/provider/package/pip2.rb +1 -1
- data/lib/puppet/provider/package/pip3.rb +1 -1
- data/lib/puppet/provider/package/pkgdmg.rb +2 -2
- data/lib/puppet/provider/package/puppet_gem.rb +2 -2
- data/lib/puppet/provider/package/puppetserver_gem.rb +1 -1
- data/lib/puppet/provider/package/windows.rb +1 -1
- data/lib/puppet/provider/service/freebsd.rb +1 -1
- data/lib/puppet/provider/service/init.rb +5 -5
- data/lib/puppet/provider/service/launchd.rb +2 -2
- data/lib/puppet/provider/service/smf.rb +1 -1
- data/lib/puppet/provider/service/upstart.rb +2 -2
- data/lib/puppet/provider/user/aix.rb +3 -3
- data/lib/puppet/provider/user/directoryservice.rb +9 -9
- data/lib/puppet/provider/user/pw.rb +3 -3
- data/lib/puppet/provider.rb +1 -1
- data/lib/puppet/reference/configuration.rb +6 -13
- data/lib/puppet/reference/function.rb +4 -4
- data/lib/puppet/reference/indirection.rb +2 -2
- data/lib/puppet/reference/metaparameter.rb +3 -3
- data/lib/puppet/reference/providers.rb +3 -3
- data/lib/puppet/reference/report.rb +4 -4
- data/lib/puppet/reference/type.rb +2 -2
- data/lib/puppet/relationship.rb +1 -1
- data/lib/puppet/reports/http.rb +4 -4
- data/lib/puppet/reports.rb +1 -1
- data/lib/puppet/resource/catalog.rb +4 -4
- data/lib/puppet/resource/type.rb +8 -8
- data/lib/puppet/settings/base_setting.rb +2 -3
- data/lib/puppet/settings/config_file.rb +3 -3
- data/lib/puppet/settings/environment_conf.rb +3 -11
- data/lib/puppet/settings.rb +11 -51
- data/lib/puppet/ssl/certificate.rb +4 -0
- data/lib/puppet/ssl/certificate_request.rb +1 -1
- data/lib/puppet/ssl/oids.rb +1 -1
- data/lib/puppet/ssl/openssl_loader.rb +1 -1
- data/lib/puppet/ssl/ssl_provider.rb +5 -5
- data/lib/puppet/ssl/state_machine.rb +9 -3
- data/lib/puppet/syntax_checkers.rb +1 -1
- data/lib/puppet/transaction/report.rb +3 -3
- data/lib/puppet/transaction.rb +0 -1
- data/lib/puppet/type/exec.rb +20 -20
- data/lib/puppet/type/file/content.rb +10 -37
- data/lib/puppet/type/file/ensure.rb +18 -9
- data/lib/puppet/type/file/mode.rb +4 -4
- data/lib/puppet/type/file/selcontext.rb +2 -2
- data/lib/puppet/type/file/source.rb +19 -25
- data/lib/puppet/type/file.rb +22 -15
- data/lib/puppet/type/filebucket.rb +22 -8
- data/lib/puppet/type/group.rb +5 -5
- data/lib/puppet/type/notify.rb +1 -1
- data/lib/puppet/type/package.rb +4 -4
- data/lib/puppet/type/schedule.rb +11 -11
- data/lib/puppet/type/service.rb +8 -8
- data/lib/puppet/type/stage.rb +1 -1
- data/lib/puppet/type/user.rb +19 -21
- data/lib/puppet/type/whit.rb +2 -2
- data/lib/puppet/type.rb +27 -27
- data/lib/puppet/util/character_encoding.rb +3 -3
- data/lib/puppet/util/command_line.rb +1 -1
- data/lib/puppet/util/execution.rb +1 -1
- data/lib/puppet/util/filetype.rb +6 -6
- data/lib/puppet/util/log.rb +2 -2
- data/lib/puppet/util/logging.rb +3 -3
- data/lib/puppet/util/plist.rb +1 -1
- data/lib/puppet/util/profiler/around_profiler.rb +1 -1
- data/lib/puppet/util/profiler.rb +1 -1
- data/lib/puppet/util/rdoc.rb +6 -3
- data/lib/puppet/util/selinux.rb +5 -5
- data/lib/puppet/util/tag_set.rb +0 -1
- data/lib/puppet/util/windows/adsi.rb +1 -1
- data/lib/puppet/util/windows/com.rb +2 -2
- data/lib/puppet/util/windows/eventlog.rb +6 -6
- data/lib/puppet/util/windows/file.rb +2 -2
- data/lib/puppet/util/windows/security.rb +3 -3
- data/lib/puppet/util.rb +8 -3
- data/lib/puppet/version.rb +8 -8
- data/lib/puppet/x509/cert_provider.rb +1 -1
- data/lib/puppet.rb +5 -5
- data/locales/config.yaml +3 -3
- data/locales/puppet.pot +462 -464
- data/man/man5/puppet.conf.5 +122 -146
- data/man/man8/puppet-agent.8 +25 -25
- data/man/man8/puppet-apply.8 +6 -6
- data/man/man8/puppet-catalog.8 +11 -11
- data/man/man8/puppet-config.8 +7 -7
- data/man/man8/puppet-describe.8 +3 -3
- data/man/man8/puppet-device.8 +2 -2
- data/man/man8/puppet-doc.8 +5 -5
- data/man/man8/puppet-epp.8 +3 -3
- data/man/man8/puppet-facts.8 +11 -11
- data/man/man8/puppet-filebucket.8 +5 -5
- data/man/man8/puppet-generate.8 +3 -3
- data/man/man8/puppet-help.8 +3 -3
- data/man/man8/puppet-lookup.8 +8 -8
- data/man/man8/puppet-module.8 +7 -7
- data/man/man8/puppet-node.8 +11 -45
- data/man/man8/puppet-parser.8 +3 -3
- data/man/man8/puppet-plugin.8 +7 -7
- data/man/man8/puppet-report.8 +6 -6
- data/man/man8/puppet-resource.8 +5 -5
- data/man/man8/puppet-script.8 +3 -3
- data/man/man8/puppet-ssl.8 +21 -23
- data/man/man8/puppet.8 +2 -2
- metadata +5 -8
- data/lib/puppet/indirector/hiera.rb +0 -101
- data/lib/puppet/util/rdoc/generators/puppet_generator.rb +0 -902
- data/lib/puppet/util/rdoc/generators/template/puppet/puppet.rb +0 -1068
data/man/man5/puppet.conf.5
CHANGED
|
@@ -1,28 +1,26 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPETCONF" "5" "
|
|
3
|
+
.TH "PUPPETCONF" "5" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "Configuration settings"
|
|
5
5
|
.IP "\(bu" 4
|
|
6
6
|
Each of these settings can be specified in \fBpuppet\.conf\fR or on the command line\.
|
|
7
7
|
.IP "\(bu" 4
|
|
8
|
-
Puppet Enterprise (PE) and open source Puppet share the configuration settings documented here\. However, PE defaults differ from open source defaults for some settings, such as \fBnode_terminus\fR, \fBstoreconfigs\fR, \fBalways_retry_plugins\fR, \fBdisable18n\fR, \fBenvironment_timeout\fR (when Code Manager is enabled), and the Puppet Server JRuby \fBmax\-active\-instances\fR setting\. To verify PE configuration defaults, check the \fBpuppet\.conf\fR or \fBpe\-puppet\-server\.conf\fR file after installation\.
|
|
9
|
-
.IP "\(bu" 4
|
|
10
8
|
When using boolean settings on the command line, use \fB\-\-setting\fR and \fB\-\-no\-setting\fR instead of \fB\-\-setting (true|false)\fR\. (Using \fB\-\-setting false\fR results in "Error: Could not parse application options: needless argument"\.)
|
|
11
9
|
.IP "\(bu" 4
|
|
12
|
-
Settings can be interpolated as \fB$variables\fR in other settings; \fB$environment\fR is special, in that
|
|
10
|
+
Settings can be interpolated as \fB$variables\fR in other settings; \fB$environment\fR is special, in that OpenVox Server will interpolate each agent node's environment instead of its own\.
|
|
13
11
|
.IP "\(bu" 4
|
|
14
12
|
Multiple values should be specified as comma\-separated lists; multiple directories should be separated with the system path separator (usually a colon)\.
|
|
15
13
|
.IP "\(bu" 4
|
|
16
14
|
Settings that represent time intervals should be specified in duration format: an integer immediately followed by one of the units 'y' (years of 365 days), 'd' (days), 'h' (hours), 'm' (minutes), or 's' (seconds)\. The unit cannot be combined with other units, and defaults to seconds when omitted\. Examples are '3600' which is equivalent to '1h' (one hour), and '1825d' which is equivalent to '5y' (5 years)\.
|
|
17
15
|
.IP "\(bu" 4
|
|
18
|
-
If you use the \fBsplay\fR setting, note that the period that it waits changes each time the
|
|
16
|
+
If you use the \fBsplay\fR setting, note that the period that it waits changes each time the OpenVox agent is restarted\.
|
|
19
17
|
.IP "\(bu" 4
|
|
20
18
|
Settings that take a single file or directory can optionally set the owner, group, and mode for their value: \fBrundir = $vardir/run { owner = puppet, group = puppet, mode = 644 }\fR
|
|
21
19
|
.IP "\(bu" 4
|
|
22
|
-
The
|
|
20
|
+
The OpenVox executables ignores any setting that isn't relevant to their function\.
|
|
23
21
|
.IP "" 0
|
|
24
22
|
.P
|
|
25
|
-
See the configuration guide \fIhttps://
|
|
23
|
+
See the configuration guide \fIhttps://docs\.openvoxproject\.org/openvox/latest/config_about_settings\.html\fR for more details\.
|
|
26
24
|
.SS "agent_catalog_run_lockfile"
|
|
27
25
|
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\.
|
|
28
26
|
.IP "\(bu" 4
|
|
@@ -39,12 +37,12 @@ Whether to allow a new certificate request to overwrite an existing certificate
|
|
|
39
37
|
\fIDefault\fR: \fBfalse\fR
|
|
40
38
|
.IP "" 0
|
|
41
39
|
.SS "allow_pson_serialization"
|
|
42
|
-
Whether to allow PSON serialization\. When unable to serialize to JSON or other formats,
|
|
40
|
+
Whether to allow PSON serialization\. When unable to serialize to JSON or other formats, OpenVox falls back to PSON\. This option affects the configuration management service responses of OpenVox Server and the process by which the agent saves its cached catalog\. With a default value of \fBfalse\fR, this option is useful in preventing the loss of data because rich data cannot be serialized via PSON\.
|
|
43
41
|
.IP "\(bu" 4
|
|
44
42
|
\fIDefault\fR: \fBfalse\fR
|
|
45
43
|
.IP "" 0
|
|
46
44
|
.SS "always_retry_plugins"
|
|
47
|
-
Affects how we cache attempts to load
|
|
45
|
+
Affects how we cache attempts to load OpenVox resource types and features\. If true, then calls to \fBPuppet\.type\.<type>?\fR \fBPuppet\.feature\.<feature>?\fR 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)\.
|
|
48
46
|
.P
|
|
49
47
|
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\.
|
|
50
48
|
.IP "\(bu" 4
|
|
@@ -56,29 +54,29 @@ Whether log files should always flush to disk\.
|
|
|
56
54
|
\fIDefault\fR: \fBtrue\fR
|
|
57
55
|
.IP "" 0
|
|
58
56
|
.SS "autosign"
|
|
59
|
-
Whether (and how) to autosign certificate requests\. This setting is only relevant on
|
|
57
|
+
Whether (and how) to autosign certificate requests\. This setting is only relevant on an OpenVox Server acting as a certificate authority (CA)\.
|
|
60
58
|
.P
|
|
61
59
|
Valid values are true (autosigns all certificate requests; not recommended), false (disables autosigning certificates), or the absolute path to a file\.
|
|
62
60
|
.P
|
|
63
|
-
The file specified in this setting may be either a \fBconfiguration file\fR or a \fBcustom policy executable\.\fR
|
|
61
|
+
The file specified in this setting may be either a \fBconfiguration file\fR or a \fBcustom policy executable\.\fR OpenVox will automatically determine what it is: If the OpenVox user (see the \fBuser\fR setting) can execute the file, it will be treated as a policy executable; otherwise, it will be treated as a config file\.
|
|
64
62
|
.P
|
|
65
|
-
If a custom policy executable is configured, the CA
|
|
63
|
+
If a custom policy executable is configured, the CA OpenVox Server will run it every time it receives a CSR\. The executable will be passed the subject CN of the request \fIas a command line argument,\fR and the contents of the CSR in PEM format \fIon stdin\.\fR It should exit with a status of 0 if the cert should be autosigned and non\-zero if the cert should not be autosigned\.
|
|
66
64
|
.P
|
|
67
65
|
If a certificate request is not autosigned, it will persist for review\. An admin user can use the \fBpuppetserver ca sign\fR command to manually sign it, or can delete the request\.
|
|
68
66
|
.P
|
|
69
|
-
For info on autosign configuration files, see the guide to
|
|
67
|
+
For info on autosign configuration files, see the guide to OpenVox's config files \fIhttps://docs\.openvoxproject\.org/openvox/latest/config_file_autosign\.html\fR\.
|
|
70
68
|
.IP "\(bu" 4
|
|
71
69
|
\fIDefault\fR: \fB$confdir/autosign\.conf\fR
|
|
72
70
|
.IP "" 0
|
|
73
71
|
.SS "basemodulepath"
|
|
74
72
|
The search path for \fBglobal\fR 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 ';'\.)
|
|
75
73
|
.P
|
|
76
|
-
These are the modules that will be used by \fIall\fR environments\. Note that the \fBmodules\fR directory of the active environment will have priority over any global directories\. For more info, see \fIhttps://
|
|
74
|
+
These are the modules that will be used by \fIall\fR environments\. Note that the \fBmodules\fR directory of the active environment will have priority over any global directories\. For more info, see \fIhttps://docs\.openvoxproject\.org/openvox/latest/environments_about\.html\fR
|
|
77
75
|
.IP "\(bu" 4
|
|
78
76
|
\fIDefault\fR: \fB$codedir/modules:/opt/puppetlabs/puppet/modules\fR
|
|
79
77
|
.IP "" 0
|
|
80
78
|
.SS "binder_config"
|
|
81
|
-
The binder configuration file\.
|
|
79
|
+
The binder configuration file\. OpenVox 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\.
|
|
82
80
|
.IP "\(bu" 4
|
|
83
81
|
\fIDefault\fR: ``
|
|
84
82
|
.IP "" 0
|
|
@@ -103,7 +101,7 @@ The port to use for the certificate authority\.
|
|
|
103
101
|
\fIDefault\fR: \fB$serverport\fR
|
|
104
102
|
.IP "" 0
|
|
105
103
|
.SS "ca_refresh_interval"
|
|
106
|
-
How often the
|
|
104
|
+
How often the OpenVox 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\.
|
|
107
105
|
.P
|
|
108
106
|
In general, the interval should be greater than the \fBruninterval\fR value\. Setting the \fBca_refresh_interval\fR value to 0 or an equal or lesser value than \fBruninterval\fR causes the CA certificates to be refreshed on every run\.
|
|
109
107
|
.P
|
|
@@ -169,22 +167,22 @@ The certificate directory\.
|
|
|
169
167
|
.SS "certificate_revocation"
|
|
170
168
|
Whether certificate revocation checking should be enabled, and what level of checking should be performed\.
|
|
171
169
|
.P
|
|
172
|
-
When certificate revocation is enabled,
|
|
170
|
+
When certificate revocation is enabled, OpenVox 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\.
|
|
173
171
|
.P
|
|
174
|
-
When certificate_revocation is set to 'true' or 'chain',
|
|
172
|
+
When certificate_revocation is set to 'true' or 'chain', OpenVox ensures that each CA in the chain of trust has not been revoked by its issuing CA\.
|
|
175
173
|
.P
|
|
176
|
-
When certificate_revocation is set to 'leaf',
|
|
174
|
+
When certificate_revocation is set to 'leaf', OpenVox 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\.
|
|
177
175
|
.P
|
|
178
|
-
When certificate_revocation is set to 'false',
|
|
176
|
+
When certificate_revocation is set to 'false', OpenVox disables all certificate revocation checking and does not attempt to download the CRL\.
|
|
179
177
|
.IP "\(bu" 4
|
|
180
178
|
\fIDefault\fR: \fBchain\fR
|
|
181
179
|
.IP "" 0
|
|
182
180
|
.SS "certname"
|
|
183
|
-
The name to use when handling certificates\. When a node requests a certificate from the CA
|
|
181
|
+
The name to use when handling certificates\. When a node requests a certificate from the CA OpenVox Server, it uses the value of the \fBcertname\fR setting as its requested Subject CN\.
|
|
184
182
|
.P
|
|
185
|
-
This is the name used when managing a node's permissions in
|
|
183
|
+
This is the name used when managing a node's permissions in OpenVox Server's auth\.conf \fIhttps://docs\.openvoxproject\.org/openvox\-server/latest/config_file_auth\.html\fR\. In most cases, it is also used as the node's name when matching node definitions \fIhttps://docs\.openvoxproject\.org/openvox/latest/lang_node_definitions\.html\fR and requesting data from an ENC\. (This can be changed with the \fBnode_name_value\fR and \fBnode_name_fact\fR settings, although you should only do so if you have a compelling reason\.)
|
|
186
184
|
.P
|
|
187
|
-
A node's certname is available in Puppet manifests as \fB$trusted['certname']\fR\. (See Facts and Built\-In Variables \fIhttps://
|
|
185
|
+
A node's certname is available in Puppet manifests as \fB$trusted['certname']\fR\. (See Facts and Built\-In Variables \fIhttps://docs\.openvoxproject\.org/openvox/latest/lang_facts_and_builtin_vars\.html\fR for more details\.)
|
|
188
186
|
.IP "\(bu" 4
|
|
189
187
|
For best compatibility, you should limit the value of \fBcertname\fR to only use lowercase letters, numbers, periods, underscores, and dashes\. (That is, it should match \fB/A[a\-z0\-9\._\-]+Z/\fR\.)
|
|
190
188
|
.IP "\(bu" 4
|
|
@@ -195,10 +193,10 @@ The special value \fBca\fR is reserved, and can't be used as the certname for a
|
|
|
195
193
|
.P
|
|
196
194
|
Defaults to the node's fully qualified domain name\.
|
|
197
195
|
.IP "\(bu" 4
|
|
198
|
-
\fIDefault\fR: \fBthe Host's fully qualified domain name, as determined by
|
|
196
|
+
\fIDefault\fR: \fBthe Host's fully qualified domain name, as determined by OpenFact\fR
|
|
199
197
|
.IP "" 0
|
|
200
198
|
.SS "ciphers"
|
|
201
|
-
The list of ciphersuites for TLS connections initiated by
|
|
199
|
+
The list of ciphersuites for TLS connections initiated by OpenVox\. 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\.
|
|
202
200
|
.IP "\(bu" 4
|
|
203
201
|
\fIDefault\fR: \fBECDHE\-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\fR
|
|
204
202
|
.IP "" 0
|
|
@@ -223,9 +221,9 @@ The directory in which client\-side YAML data is stored\.
|
|
|
223
221
|
\fIDefault\fR: \fB$vardir/client_yaml\fR
|
|
224
222
|
.IP "" 0
|
|
225
223
|
.SS "code"
|
|
226
|
-
Code to parse directly\. This is essentially only used by \fBpuppet\fR, and should only be set if you're writing your own
|
|
224
|
+
Code to parse directly\. This is essentially only used by \fBpuppet\fR, and should only be set if you're writing your own OpenVox executable\.
|
|
227
225
|
.SS "codedir"
|
|
228
|
-
The main
|
|
226
|
+
The main OpenVox code directory\. The default for this setting is calculated based on the user\. If the process is running as root or the user that OpenVox 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\.
|
|
229
227
|
.IP "\(bu" 4
|
|
230
228
|
\fIDefault\fR: \fBUnix/Linux: /etc/puppetlabs/code \-\- Windows: C:\eProgramData\ePuppetLabs\ecode \-\- Non\-root user: ~/\.puppetlabs/etc/code\fR
|
|
231
229
|
.IP "" 0
|
|
@@ -235,28 +233,26 @@ Whether to use colors when logging to the console\. Valid values are \fBansi\fR
|
|
|
235
233
|
\fIDefault\fR: \fBansi\fR
|
|
236
234
|
.IP "" 0
|
|
237
235
|
.SS "confdir"
|
|
238
|
-
The main
|
|
236
|
+
The main OpenVox configuration directory\. The default for this setting is calculated based on the user\. If the process is running as root or the user that OpenVox 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\.
|
|
239
237
|
.IP "\(bu" 4
|
|
240
238
|
\fIDefault\fR: \fBUnix/Linux: /etc/puppetlabs/puppet \-\- Windows: C:\eProgramData\ePuppetLabs\epuppet\eetc \-\- Non\-root user: ~/\.puppetlabs/etc/puppet\fR
|
|
241
239
|
.IP "" 0
|
|
242
240
|
.SS "config"
|
|
243
|
-
The configuration file for the current
|
|
241
|
+
The configuration file for the current OpenVox application\.
|
|
244
242
|
.IP "\(bu" 4
|
|
245
243
|
\fIDefault\fR: \fB$confdir/${config_file_name}\fR
|
|
246
244
|
.IP "" 0
|
|
247
245
|
.SS "config_file_name"
|
|
248
|
-
The name of the
|
|
246
|
+
The name of the OpenVox config file\.
|
|
249
247
|
.IP "\(bu" 4
|
|
250
248
|
\fIDefault\fR: \fBpuppet\.conf\fR
|
|
251
249
|
.IP "" 0
|
|
252
250
|
.SS "config_version"
|
|
253
251
|
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\.
|
|
254
252
|
.P
|
|
255
|
-
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 \fIhttps://
|
|
256
|
-
.SS "configprint"
|
|
257
|
-
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\.
|
|
253
|
+
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 \fIhttps://docs\.openvoxproject\.org/openvox/latest/environments_about\.html\fR
|
|
258
254
|
.SS "crl_refresh_interval"
|
|
259
|
-
How often the
|
|
255
|
+
How often the OpenVox 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 OpenVox agent run if the elapsed time since the CRL was last refreshed exceeds the specified interval\.
|
|
260
256
|
.P
|
|
261
257
|
In general, the interval should be greater than the \fBruninterval\fR value\. Setting the \fBcrl_refresh_interval\fR value to 0 or an equal or lesser value than \fBruninterval\fR causes the CRL to be refreshed on every run\.
|
|
262
258
|
.P
|
|
@@ -265,7 +261,7 @@ If the agent downloads a new CRL, the agent will use it for subsequent network r
|
|
|
265
261
|
\fIDefault\fR: \fB1d\fR
|
|
266
262
|
.IP "" 0
|
|
267
263
|
.SS "csr_attributes"
|
|
268
|
-
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
|
|
264
|
+
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 OpenVox Server; if it does, unwanted certificate extensions may leak into certificates created with the \fBpuppetserver ca generate\fR command\.
|
|
269
265
|
.P
|
|
270
266
|
If present, this file must be a YAML hash containing a \fBcustom_attributes\fR key and/or an \fBextension_requests\fR 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\.
|
|
271
267
|
.P
|
|
@@ -281,15 +277,10 @@ Where the CA stores certificate requests\.
|
|
|
281
277
|
\fIDefault\fR: \fB$cadir/requests\fR
|
|
282
278
|
.IP "" 0
|
|
283
279
|
.SS "daemonize"
|
|
284
|
-
Whether to send the process into the background\. This defaults to true on POSIX systems, and to false on Windows (where
|
|
280
|
+
Whether to send the process into the background\. This defaults to true on POSIX systems, and to false on Windows (where OpenVox currently cannot daemonize)\.
|
|
285
281
|
.IP "\(bu" 4
|
|
286
282
|
\fIDefault\fR: \fBtrue\fR
|
|
287
283
|
.IP "" 0
|
|
288
|
-
.SS "data_binding_terminus"
|
|
289
|
-
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\.
|
|
290
|
-
.IP "\(bu" 4
|
|
291
|
-
\fIDefault\fR: \fBhiera\fR
|
|
292
|
-
.IP "" 0
|
|
293
284
|
.SS "default_file_terminus"
|
|
294
285
|
The default source for files if no server is given in a uri, e\.g\. puppet:///file\. The default of \fBrest\fR causes the file to be retrieved using the \fBserver\fR setting\. When running \fBapply\fR the default is \fBfile_server\fR, causing requests to be filled locally\.
|
|
295
286
|
.IP "\(bu" 4
|
|
@@ -298,7 +289,7 @@ The default source for files if no server is given in a uri, e\.g\. puppet:///fi
|
|
|
298
289
|
.SS "default_manifest"
|
|
299
290
|
The default main manifest for directory environments\. Any environment that doesn't set the \fBmanifest\fR setting in its \fBenvironment\.conf\fR file will use this manifest\.
|
|
300
291
|
.P
|
|
301
|
-
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
|
|
292
|
+
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 OpenVox will resolve the path relative to each environment's main directory\.
|
|
302
293
|
.P
|
|
303
294
|
In either case, the path can point to a single file or to a directory of manifests to be evaluated in alphabetical order\.
|
|
304
295
|
.IP "\(bu" 4
|
|
@@ -325,7 +316,7 @@ The root directory of devices' $vardir\.
|
|
|
325
316
|
\fIDefault\fR: \fB$vardir/devices\fR
|
|
326
317
|
.IP "" 0
|
|
327
318
|
.SS "diff"
|
|
328
|
-
Which diff command to use when printing differences between files\. This setting has no default value on Windows, as standard \fBdiff\fR is not available, but
|
|
319
|
+
Which diff command to use when printing differences between files\. This setting has no default value on Windows, as standard \fBdiff\fR is not available, but OpenVox can use many third\-party diff tools\.
|
|
329
320
|
.IP "\(bu" 4
|
|
330
321
|
\fIDefault\fR: \fBdiff\fR
|
|
331
322
|
.IP "" 0
|
|
@@ -340,21 +331,21 @@ Which digest algorithm to use for file resources and the filebucket\. Valid valu
|
|
|
340
331
|
\fIDefault\fR: \fBsha256\fR
|
|
341
332
|
.IP "" 0
|
|
342
333
|
.SS "disable_i18n"
|
|
343
|
-
If true, turns off all translations of
|
|
334
|
+
If true, turns off all translations of OpenVox and module log messages, which affects error, warning, and info log messages, as well as any translations in the report and CLI\.
|
|
344
335
|
.IP "\(bu" 4
|
|
345
336
|
\fIDefault\fR: \fBtrue\fR
|
|
346
337
|
.IP "" 0
|
|
347
338
|
.SS "disable_per_environment_manifest"
|
|
348
|
-
Whether to disallow an environment\-specific main manifest\. When set to \fBtrue\fR,
|
|
339
|
+
Whether to disallow an environment\-specific main manifest\. When set to \fBtrue\fR, OpenVox will use the manifest specified in the \fBdefault_manifest\fR setting for all environments\. If an environment specifies a different main manifest in its \fBenvironment\.conf\fR file, catalog requests for that environment will fail with an error\.
|
|
349
340
|
.P
|
|
350
341
|
This setting requires \fBdefault_manifest\fR to be set to an absolute path\.
|
|
351
342
|
.IP "\(bu" 4
|
|
352
343
|
\fIDefault\fR: \fBfalse\fR
|
|
353
344
|
.IP "" 0
|
|
354
345
|
.SS "disable_warnings"
|
|
355
|
-
A comma\-separated list of warning types to suppress\. If large numbers of warnings are making
|
|
346
|
+
A comma\-separated list of warning types to suppress\. If large numbers of warnings are making OpenVox's logs too large or difficult to use, you can temporarily silence them with this setting\.
|
|
356
347
|
.P
|
|
357
|
-
If you are preparing to upgrade
|
|
348
|
+
If you are preparing to upgrade OpenVox to a new major version, you should re\-enable all warnings for a while\.
|
|
358
349
|
.P
|
|
359
350
|
Valid values for this setting are:
|
|
360
351
|
.IP "\(bu" 4
|
|
@@ -367,54 +358,49 @@ Valid values for this setting are:
|
|
|
367
358
|
\fIDefault\fR: \fB[]\fR
|
|
368
359
|
.IP "" 0
|
|
369
360
|
.SS "dns_alt_names"
|
|
370
|
-
A comma\-separated list of alternate DNS names for
|
|
361
|
+
A comma\-separated list of alternate DNS names for OpenVox Server\. These are extra hostnames (in addition to its \fBcertname\fR) that the server is allowed to use when serving agents\. OpenVox checks this setting when automatically creating a certificate for the OpenVox agent or OpenVox Server\. These can be either IP or DNS, and the type should be specified and followed with a colon\. Untyped inputs will default to DNS\.
|
|
371
362
|
.P
|
|
372
|
-
In order to handle agent requests at a given hostname (like "puppet\.example\.com"),
|
|
363
|
+
In order to handle agent requests at a given hostname (like "puppet\.example\.com"), OpenVox Server needs a certificate that proves it's allowed to use that name; if a server shows a certificate that doesn't include its hostname, OpenVox agents will refuse to trust it\. If you use a single hostname for OpenVox traffic but load\-balance it to multiple OpenVox Servers, each of those servers needs to include the official hostname in its list of extra names\.
|
|
373
364
|
.P
|
|
374
|
-
\fBNote:\fR The list of alternate names is locked in when the server's certificate is signed\. If you need to change the list later, you can't just change this setting; you also need to regenerate the certificate\. For more information on that process, see the cert regen docs \fIhttps://
|
|
365
|
+
\fBNote:\fR The list of alternate names is locked in when the server's certificate is signed\. If you need to change the list later, you can't just change this setting; you also need to regenerate the certificate\. For more information on that process, see the cert regen docs \fIhttps://docs\.openvoxproject\.org/openvox/latest/ssl_regenerate_certificates\.html\fR\.
|
|
375
366
|
.P
|
|
376
|
-
To see all the alternate names your servers are using, log into your CA server and run \fBpuppetserver ca list \-\-all\fR, then check the output for \fB(alt names: \|\.\|\.\|\.)\fR\. Most agent nodes should NOT have alternate names; the only certs that should have them are
|
|
367
|
+
To see all the alternate names your servers are using, log into your CA server and run \fBpuppetserver ca list \-\-all\fR, then check the output for \fB(alt names: \|\.\|\.\|\.)\fR\. Most agent nodes should NOT have alternate names; the only certs that should have them are OpenVox Server nodes that you want other agents to trust\.
|
|
377
368
|
.SS "document_all"
|
|
378
369
|
Whether to document all resources when using \fBpuppet doc\fR to generate manifest documentation\.
|
|
379
370
|
.IP "\(bu" 4
|
|
380
371
|
\fIDefault\fR: \fBfalse\fR
|
|
381
372
|
.IP "" 0
|
|
382
373
|
.SS "environment"
|
|
383
|
-
The environment in which
|
|
374
|
+
The environment in which OpenVox is running\. For clients, such as \fBpuppet agent\fR, this determines the environment itself, which OpenVox uses to find modules and much more\. For servers, such as OpenVox Server, this provides the default environment for nodes that OpenVox knows nothing about\.
|
|
384
375
|
.P
|
|
385
376
|
When defining an environment in the \fB[agent]\fR 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 \fBpuppet agent\fR\.
|
|
386
377
|
.P
|
|
387
|
-
When defined in the \fB[user]\fR section, the environment refers to the path that
|
|
378
|
+
When defined in the \fB[user]\fR section, the environment refers to the path that OpenVox 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\. OpenVox subcommands, including \fBpuppet module\fR and \fBpuppet apply\fR, use this definition\.
|
|
388
379
|
.P
|
|
389
|
-
Given that the context and effects vary depending on the config section \fIhttps://
|
|
380
|
+
Given that the context and effects vary depending on the config section \fIhttps://docs\.openvoxproject\.org/openvox/latest/config_file_main\.html#config\-sections\fR in which the \fBenvironment\fR setting is defined, do not set it globally\.
|
|
390
381
|
.IP "\(bu" 4
|
|
391
382
|
\fIDefault\fR: \fBproduction\fR
|
|
392
383
|
.IP "" 0
|
|
393
|
-
.SS "environment_data_provider"
|
|
394
|
-
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\.
|
|
395
|
-
.IP "\(bu" 4
|
|
396
|
-
\fIDefault\fR: ``
|
|
397
|
-
.IP "" 0
|
|
398
384
|
.SS "environment_timeout"
|
|
399
|
-
How long the
|
|
385
|
+
How long the OpenVox server should cache data it loads from an environment\.
|
|
400
386
|
.P
|
|
401
|
-
A value of \fB0\fR will disable caching\. This setting can also be set to \fBunlimited\fR, which will cache environments until the server is restarted or told to refresh the cache\. All other values will result in
|
|
387
|
+
A value of \fB0\fR will disable caching\. This setting can also be set to \fBunlimited\fR, which will cache environments until the server is restarted or told to refresh the cache\. All other values will result in the OpenVox server evicting environments that haven't been used within the last \fBenvironment_timeout\fR seconds\.
|
|
402
388
|
.P
|
|
403
|
-
You should change this setting once your
|
|
389
|
+
You should change this setting once your OpenVox deployment is doing non\-trivial work\. We chose the default value of \fB0\fR because it lets new users update their code without any extra steps, but it lowers the performance of your OpenVox server\. We recommend either:
|
|
404
390
|
.IP "\(bu" 4
|
|
405
|
-
Setting this to \fBunlimited\fR and explicitly refreshing your
|
|
391
|
+
Setting this to \fBunlimited\fR and explicitly refreshing your OpenVox server as part of your code deployment process\.
|
|
406
392
|
.IP "\(bu" 4
|
|
407
393
|
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\.
|
|
408
394
|
.IP "" 0
|
|
409
395
|
.P
|
|
410
|
-
Once you set \fBenvironment_timeout\fR to a non\-zero value, you need to tell
|
|
396
|
+
Once you set \fBenvironment_timeout\fR to a non\-zero value, you need to tell the OpenVox server to read new code from disk using the \fBenvironment\-cache\fR API endpoint after you deploy new code\. See the docs for the OpenVox Server administrative API \fIhttps://docs\.openvoxproject\.org/openvox\-server/latest/admin\-api/v1/environment\-cache\.html\fR\.
|
|
411
397
|
.IP "\(bu" 4
|
|
412
398
|
\fIDefault\fR: \fB0\fR
|
|
413
399
|
.IP "" 0
|
|
414
400
|
.SS "environmentpath"
|
|
415
401
|
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 ';'\.)
|
|
416
402
|
.P
|
|
417
|
-
This setting must have a value set to enable \fBdirectory environments\.\fR The recommended value is \fB$codedir/environments\fR\. For more details, see \fIhttps://
|
|
403
|
+
This setting must have a value set to enable \fBdirectory environments\.\fR The recommended value is \fB$codedir/environments\fR\. For more details, see \fIhttps://docs\.openvoxproject\.org/openvox/latest/environments_about\.html\fR
|
|
418
404
|
.IP "\(bu" 4
|
|
419
405
|
\fIDefault\fR: \fB$codedir/environments\fR
|
|
420
406
|
.IP "" 0
|
|
@@ -429,7 +415,7 @@ Specifies how unchanged resources are listed in reports\. When set to \fBtrue\fR
|
|
|
429
415
|
\fIDefault\fR: \fBtrue\fR
|
|
430
416
|
.IP "" 0
|
|
431
417
|
.SS "external_nodes"
|
|
432
|
-
The external node classifier (ENC) script to use for node data\.
|
|
418
|
+
The external node classifier (ENC) script to use for node data\. OpenVox combines this data with the main manifest to produce node catalogs\.
|
|
433
419
|
.P
|
|
434
420
|
To enable this setting, set the \fBnode_terminus\fR setting to \fBexec\fR\.
|
|
435
421
|
.P
|
|
@@ -452,7 +438,7 @@ For unknown nodes, exit with a non\-zero exit code\.
|
|
|
452
438
|
.P
|
|
453
439
|
Generally, an ENC script makes requests to an external data source\.
|
|
454
440
|
.P
|
|
455
|
-
For more info, see the ENC documentation \fIhttps://
|
|
441
|
+
For more info, see the ENC documentation \fIhttps://docs\.openvoxproject\.org/openvox/latest/nodes_external\.html\fR\.
|
|
456
442
|
.IP "\(bu" 4
|
|
457
443
|
\fIDefault\fR: \fBnone\fR
|
|
458
444
|
.IP "" 0
|
|
@@ -467,7 +453,7 @@ The soft limit for the length of a fact value\.
|
|
|
467
453
|
\fIDefault\fR: \fB4096\fR
|
|
468
454
|
.IP "" 0
|
|
469
455
|
.SS "factpath"
|
|
470
|
-
Where
|
|
456
|
+
Where OpenVox 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 ';'\.)
|
|
471
457
|
.IP "\(bu" 4
|
|
472
458
|
\fIDefault\fR: \fB$vardir/lib/facter:$vardir/facts\fR
|
|
473
459
|
.IP "" 0
|
|
@@ -482,7 +468,7 @@ Where the fileserver configuration is stored\.
|
|
|
482
468
|
\fIDefault\fR: \fB$confdir/fileserver\.conf\fR
|
|
483
469
|
.IP "" 0
|
|
484
470
|
.SS "filetimeout"
|
|
485
|
-
The minimum time to wait between checking for updates in configuration files\. This timeout determines how quickly
|
|
471
|
+
The minimum time to wait between checking for updates in configuration files\. This timeout determines how quickly OpenVox checks whether a file (such as manifests or puppet\.conf) has changed on disk\. To reparse files within an environment in OpenVox Server please use the environment_cache endpoint
|
|
486
472
|
.IP "\(bu" 4
|
|
487
473
|
\fIDefault\fR: \fB15s\fR
|
|
488
474
|
.IP "" 0
|
|
@@ -497,7 +483,7 @@ Freezes the 'main' class, disallowing any code to be added to it\. This essentia
|
|
|
497
483
|
\fIDefault\fR: \fBfalse\fR
|
|
498
484
|
.IP "" 0
|
|
499
485
|
.SS "genconfig"
|
|
500
|
-
When true, causes
|
|
486
|
+
When true, causes OpenVox 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 \fBgenconfig\fR itself)\. This setting only makes sense when specified on the command line as \fB\-\-genconfig\fR\.
|
|
501
487
|
.IP "\(bu" 4
|
|
502
488
|
\fIDefault\fR: \fBfalse\fR
|
|
503
489
|
.IP "" 0
|
|
@@ -507,11 +493,11 @@ Whether to just print a manifest to stdout and exit\. Only makes sense when spec
|
|
|
507
493
|
\fIDefault\fR: \fBfalse\fR
|
|
508
494
|
.IP "" 0
|
|
509
495
|
.SS "graph"
|
|
510
|
-
Whether to create \.dot graph files, which let you visualize the dependency and containment relationships in
|
|
496
|
+
Whether to create \.dot graph files, which let you visualize the dependency and containment relationships in OpenVox's catalog\. You can load and view these files with tools like OmniGraffle \fIhttp://www\.omnigroup\.com/applications/omnigraffle/\fR (OS X) or graphviz \fIhttp://www\.graphviz\.org/\fR (multi\-platform)\.
|
|
511
497
|
.P
|
|
512
498
|
Graph files are created when \fIapplying\fR a catalog, so this setting should be used on nodes running \fBpuppet agent\fR or \fBpuppet apply\fR\.
|
|
513
499
|
.P
|
|
514
|
-
The \fBgraphdir\fR setting determines where
|
|
500
|
+
The \fBgraphdir\fR setting determines where OpenVox will save graphs\. Note that we don't save graphs for historical runs; OpenVox will replace the previous \.dot files with new ones every time it applies a catalog\.
|
|
515
501
|
.P
|
|
516
502
|
See your graphing software's documentation for details on opening \.dot files\. If you're using GraphViz's \fBdot\fR command, you can do a quick PNG render with \fBdot \-Tpng <DOT FILE> \-o <OUTPUT FILE>\fR\.
|
|
517
503
|
.IP "\(bu" 4
|
|
@@ -523,14 +509,14 @@ Where to save \.dot\-format graphs (when the \fBgraph\fR setting is enabled)\.
|
|
|
523
509
|
\fIDefault\fR: \fB$statedir/graphs\fR
|
|
524
510
|
.IP "" 0
|
|
525
511
|
.SS "group"
|
|
526
|
-
The group
|
|
512
|
+
The group OpenVox Server will run as\. Used to ensure the agent side processes (agent, apply, etc) create files and directories readable by OpenVox Server when necessary\.
|
|
527
513
|
.IP "\(bu" 4
|
|
528
514
|
\fIDefault\fR: \fBpuppet\fR
|
|
529
515
|
.IP "" 0
|
|
530
516
|
.SS "hiera_config"
|
|
531
|
-
The hiera configuration file\.
|
|
517
|
+
The hiera configuration file\. OpenVox only reads this file on startup, so you must restart the OpenVox server every time you edit it\.
|
|
532
518
|
.IP "\(bu" 4
|
|
533
|
-
\fIDefault\fR: \fB$confdir/hiera\.yaml\. However, for backwards compatibility, if a file exists at $codedir/hiera\.yaml,
|
|
519
|
+
\fIDefault\fR: \fB$confdir/hiera\.yaml\. However, for backwards compatibility, if a file exists at $codedir/hiera\.yaml, OpenVox uses that instead\.\fR
|
|
534
520
|
.IP "" 0
|
|
535
521
|
.SS "hostcert"
|
|
536
522
|
Where individual hosts store and look for their certificates\.
|
|
@@ -538,7 +524,7 @@ Where individual hosts store and look for their certificates\.
|
|
|
538
524
|
\fIDefault\fR: \fB$certdir/$certname\.pem\fR
|
|
539
525
|
.IP "" 0
|
|
540
526
|
.SS "hostcert_renewal_interval"
|
|
541
|
-
How often the
|
|
527
|
+
How often the OpenVox 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\.
|
|
542
528
|
.P
|
|
543
529
|
In general, the \fBhostcert_renewal_interval\fR value should be greater than the \fBruninterval\fR value\. Setting the \fBhostcert_renewal_interval\fR value to 0 disables automatic renewal\.
|
|
544
530
|
.P
|
|
@@ -619,7 +605,7 @@ The HTTP User\-Agent string to send when making network requests\.
|
|
|
619
605
|
\fIDefault\fR: \fBPuppet/<version> Ruby/<version> (<architecture>)\fR
|
|
620
606
|
.IP "" 0
|
|
621
607
|
.SS "ignore_plugin_errors"
|
|
622
|
-
Whether the
|
|
608
|
+
Whether the OpenVox 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\.
|
|
623
609
|
.IP "\(bu" 4
|
|
624
610
|
\fIDefault\fR: \fBfalse\fR
|
|
625
611
|
.IP "" 0
|
|
@@ -654,7 +640,7 @@ Where puppet agent stores the last run report summary in yaml format\.
|
|
|
654
640
|
\fIDefault\fR: \fB$publicdir/last_run_summary\.yaml\fR
|
|
655
641
|
.IP "" 0
|
|
656
642
|
.SS "lastrunreport"
|
|
657
|
-
Where
|
|
643
|
+
Where the OpenVox agent stores the last run report, by default, in yaml format\. The format of the report can be changed by setting the \fBcache\fR key of the \fBreport\fR terminus in the routes\.yaml \fIhttps://docs\.openvoxproject\.org/openvox/latest/config_file_routes\.html\fR file\. To avoid mismatches between content and file extension, this setting needs to be manually updated to reflect the terminus changes\.
|
|
658
644
|
.IP "\(bu" 4
|
|
659
645
|
\fIDefault\fR: \fB$statedir/last_run_report\.yaml\fR
|
|
660
646
|
.IP "" 0
|
|
@@ -710,7 +696,7 @@ Whether TLS should be used when searching for nodes\. Defaults to false because
|
|
|
710
696
|
.SS "ldapuser"
|
|
711
697
|
The user to use to connect to LDAP\. Must be specified as a full DN\.
|
|
712
698
|
.SS "libdir"
|
|
713
|
-
An extra search path for
|
|
699
|
+
An extra search path for OpenVox\. This is only useful for those files that OpenVox 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
|
|
714
700
|
.IP "\(bu" 4
|
|
715
701
|
\fIDefault\fR: \fB$vardir/lib\fR
|
|
716
702
|
.IP "" 0
|
|
@@ -720,22 +706,22 @@ Where each client stores the CA certificate\.
|
|
|
720
706
|
\fIDefault\fR: \fB$certdir/ca\.pem\fR
|
|
721
707
|
.IP "" 0
|
|
722
708
|
.SS "localedest"
|
|
723
|
-
Where
|
|
709
|
+
Where OpenVox should store translation files that it pulls down from the central server\.
|
|
724
710
|
.IP "\(bu" 4
|
|
725
711
|
\fIDefault\fR: \fB$vardir/locales\fR
|
|
726
712
|
.IP "" 0
|
|
727
713
|
.SS "localesource"
|
|
728
|
-
From where to retrieve translation files\. The standard
|
|
714
|
+
From where to retrieve translation files\. The standard OpenVox \fBfile\fR type is used for retrieval, so anything that is a valid file source can be used here\.
|
|
729
715
|
.IP "\(bu" 4
|
|
730
716
|
\fIDefault\fR: \fBpuppet:///locales\fR
|
|
731
717
|
.IP "" 0
|
|
732
718
|
.SS "location_trusted"
|
|
733
|
-
This will allow sending the name + password and the cookie header to all hosts that
|
|
719
|
+
This will allow sending the name + password and the cookie header to all hosts that OpenVox may redirect to\. This may or may not introduce a security breach if OpenVox redirects you to a site to which you'll send your authentication info and cookies\.
|
|
734
720
|
.IP "\(bu" 4
|
|
735
721
|
\fIDefault\fR: \fBfalse\fR
|
|
736
722
|
.IP "" 0
|
|
737
723
|
.SS "log_level"
|
|
738
|
-
Default logging level for messages from
|
|
724
|
+
Default logging level for messages from OpenVox\. Allowed values are:
|
|
739
725
|
.IP "\(bu" 4
|
|
740
726
|
debug
|
|
741
727
|
.IP "\(bu" 4
|
|
@@ -766,19 +752,19 @@ The directory in which to store log files
|
|
|
766
752
|
\fIDefault\fR: \fBUnix/Linux: /var/log/puppetlabs/puppet \-\- Windows: C:\eProgramData\ePuppetLabs\epuppet\evar\elog \-\- Non\-root user: ~/\.puppetlabs/var/log\fR
|
|
767
753
|
.IP "" 0
|
|
768
754
|
.SS "manage_internal_file_permissions"
|
|
769
|
-
Whether
|
|
755
|
+
Whether OpenVox should manage the owner, group, and mode of files it uses internally\. \fBNote\fR: For Windows agents, the default is \fBfalse\fR\.
|
|
770
756
|
.IP "\(bu" 4
|
|
771
757
|
\fIDefault\fR: \fBtrue\fR
|
|
772
758
|
.IP "" 0
|
|
773
759
|
.SS "manifest"
|
|
774
|
-
The entry\-point manifest for the primary server\. This can be one file or a directory of manifests to be evaluated in alphabetical order\.
|
|
760
|
+
The entry\-point manifest for the primary server\. This can be one file or a directory of manifests to be evaluated in alphabetical order\. OpenVox manages this path as a directory if one exists or if the path ends with a / or \.
|
|
775
761
|
.P
|
|
776
|
-
Setting a global value for \fBmanifest\fR 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 \fBmanifests\fR directory as the main manifest, you can set \fBmanifest\fR in environment\.conf\. For more info, see \fIhttps://
|
|
762
|
+
Setting a global value for \fBmanifest\fR 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 \fBmanifests\fR directory as the main manifest, you can set \fBmanifest\fR in environment\.conf\. For more info, see \fIhttps://docs\.openvoxproject\.org/openvox/latest/environments_about\.html\fR
|
|
777
763
|
.IP "\(bu" 4
|
|
778
764
|
\fIDefault\fR: ``
|
|
779
765
|
.IP "" 0
|
|
780
766
|
.SS "masterport"
|
|
781
|
-
The default port puppet subcommands use to communicate with
|
|
767
|
+
The default port puppet subcommands use to communicate with OpenVox Server\. (eg \fBpuppet facts upload\fR, \fBpuppet agent\fR)\. May be overridden by more specific settings (see \fBca_port\fR, \fBreport_port\fR)\.
|
|
782
768
|
.IP "\(bu" 4
|
|
783
769
|
\fIDefault\fR: \fB8140\fR
|
|
784
770
|
.IP "" 0
|
|
@@ -803,7 +789,7 @@ The maximum allowed UID\. Some platforms use negative UIDs but then ship with to
|
|
|
803
789
|
\fIDefault\fR: \fB4294967290\fR
|
|
804
790
|
.IP "" 0
|
|
805
791
|
.SS "maxwaitforcert"
|
|
806
|
-
The maximum amount of time the
|
|
792
|
+
The maximum amount of time the OpenVox agent should wait for its certificate request to be signed\. A value of \fBunlimited\fR will cause puppet agent to ask for a signed certificate indefinitely\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
|
|
807
793
|
.IP "\(bu" 4
|
|
808
794
|
\fIDefault\fR: \fBunlimited\fR
|
|
809
795
|
.IP "" 0
|
|
@@ -844,7 +830,7 @@ The directory into which module tool data is stored
|
|
|
844
830
|
.SS "modulepath"
|
|
845
831
|
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 ';'\.)
|
|
846
832
|
.P
|
|
847
|
-
Setting a global value for \fBmodulepath\fR 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 \fB<ACTIVE ENVIRONMENT'S MODULES DIR>:$basemodulepath\fR, you can set \fBmodulepath\fR in environment\.conf\. For more info, see \fIhttps://
|
|
833
|
+
Setting a global value for \fBmodulepath\fR 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 \fB<ACTIVE ENVIRONMENT'S MODULES DIR>:$basemodulepath\fR, you can set \fBmodulepath\fR in environment\.conf\. For more info, see \fIhttps://docs\.openvoxproject\.org/openvox/latest/environments_about\.html\fR
|
|
848
834
|
.SS "name"
|
|
849
835
|
The name of the application, if we are running as one\. The default is essentially $0 without the path or \fB\.rb\fR\.
|
|
850
836
|
.IP "\(bu" 4
|
|
@@ -866,20 +852,20 @@ How to store cached nodes\. Valid values are (none), 'json', 'msgpack', or 'yaml
|
|
|
866
852
|
\fIDefault\fR: ``
|
|
867
853
|
.IP "" 0
|
|
868
854
|
.SS "node_name_fact"
|
|
869
|
-
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
|
|
855
|
+
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 OpenVox Server's default auth\.conf \fIhttps://docs\.openvoxproject\.org/openvox\-server/latest/config_file_auth\.html\fR\.
|
|
870
856
|
.SS "node_name_value"
|
|
871
|
-
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
|
|
857
|
+
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 OpenVox Server's default auth\.conf \fIhttps://docs\.openvoxproject\.org/openvox\-server/latest/config_file_auth\.html\fR\.
|
|
872
858
|
.IP "\(bu" 4
|
|
873
859
|
\fIDefault\fR: \fB$certname\fR
|
|
874
860
|
.IP "" 0
|
|
875
861
|
.SS "node_terminus"
|
|
876
862
|
Which node data plugin to use when compiling node catalogs\.
|
|
877
863
|
.P
|
|
878
|
-
When
|
|
864
|
+
When OpenVox 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:
|
|
879
865
|
.IP "1." 4
|
|
880
866
|
A list of classes to add to that node's catalog (and, optionally, values for their parameters)\.
|
|
881
867
|
.IP "2." 4
|
|
882
|
-
Which
|
|
868
|
+
Which environment the node should use\.
|
|
883
869
|
.IP "3." 4
|
|
884
870
|
A list of additional top\-scope variables to set\.
|
|
885
871
|
.IP "" 0
|
|
@@ -888,18 +874,16 @@ The three main node data plugins are:
|
|
|
888
874
|
.IP "\(bu" 4
|
|
889
875
|
\fBplain\fR \-\- Returns no data, so that the main manifest controls all node configuration\.
|
|
890
876
|
.IP "\(bu" 4
|
|
891
|
-
\fBexec\fR \-\- Uses an external node classifier (ENC) \fIhttps://
|
|
892
|
-
.IP "\(bu" 4
|
|
893
|
-
\fBclassifier\fR (formerly \fBconsole\fR) \-\- Specific to Puppet Enterprise\. Uses the PE console for node data\."
|
|
877
|
+
\fBexec\fR \-\- Uses an external node classifier (ENC) \fIhttps://docs\.openvoxproject\.org/openvox/latest/nodes_external\.html\fR, configured by the \fBexternal_nodes\fR 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\.
|
|
894
878
|
.IP "\(bu" 4
|
|
895
879
|
\fIDefault\fR: \fBplain\fR
|
|
896
880
|
.IP "" 0
|
|
897
881
|
.SS "noop"
|
|
898
|
-
Whether to apply catalogs in noop mode, which allows
|
|
882
|
+
Whether to apply catalogs in noop mode, which allows OpenVox to partially simulate a normal run\. This setting affects puppet agent and puppet apply\.
|
|
899
883
|
.P
|
|
900
|
-
When running in noop mode,
|
|
884
|
+
When running in noop mode, OpenVox 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), OpenVox will take no action, and will instead report the changes it \fIwould\fR have made\. These simulated changes will appear in the report sent to the primary OpenVox 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 OpenVox will log that a refresh event \fIwould\fR have been sent\.
|
|
901
885
|
.P
|
|
902
|
-
\fBImportant note:\fR The \fBnoop\fR metaparameter \fIhttps://
|
|
886
|
+
\fBImportant note:\fR The \fBnoop\fR metaparameter \fIhttps://docs\.openvoxproject\.org/openvox/latest/metaparameter\.html#noop\fR allows you to apply individual resources in noop mode, and will override the global value of the \fBnoop\fR setting\. This means a resource with \fBnoop => false\fR \fIwill\fR be changed if necessary, even when running puppet agent with \fBnoop = true\fR or \fB\-\-noop\fR\. (Conversely, a resource with \fBnoop => true\fR will only be simulated, even when noop mode is globally disabled\.)
|
|
903
887
|
.IP "\(bu" 4
|
|
904
888
|
\fIDefault\fR: \fBfalse\fR
|
|
905
889
|
.IP "" 0
|
|
@@ -931,17 +915,17 @@ The soft limit for the size of the payload\.
|
|
|
931
915
|
\fIDefault\fR: \fB16777216\fR
|
|
932
916
|
.IP "" 0
|
|
933
917
|
.SS "pidfile"
|
|
934
|
-
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
|
|
918
|
+
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 an OpenVox process is still in the process table\.
|
|
935
919
|
.IP "\(bu" 4
|
|
936
920
|
\fIDefault\fR: \fB$rundir/${run_mode}\.pid\fR
|
|
937
921
|
.IP "" 0
|
|
938
922
|
.SS "plugindest"
|
|
939
|
-
Where
|
|
923
|
+
Where OpenVox should store plugins that it pulls down from the central server\.
|
|
940
924
|
.IP "\(bu" 4
|
|
941
925
|
\fIDefault\fR: \fB$libdir\fR
|
|
942
926
|
.IP "" 0
|
|
943
927
|
.SS "pluginfactdest"
|
|
944
|
-
Where
|
|
928
|
+
Where OpenVox should store external facts that are being handled by pluginsync
|
|
945
929
|
.IP "\(bu" 4
|
|
946
930
|
\fIDefault\fR: \fB$vardir/facts\.d\fR
|
|
947
931
|
.IP "" 0
|
|
@@ -956,36 +940,31 @@ What files to ignore when pulling down plugins\.
|
|
|
956
940
|
\fIDefault\fR: \fB\.svn CVS \.git \.hg\fR
|
|
957
941
|
.IP "" 0
|
|
958
942
|
.SS "pluginsource"
|
|
959
|
-
From where to retrieve plugins\. The standard
|
|
943
|
+
From where to retrieve plugins\. The standard OpenVox \fBfile\fR type is used for retrieval, so anything that is a valid file source can be used here\.
|
|
960
944
|
.IP "\(bu" 4
|
|
961
945
|
\fIDefault\fR: \fBpuppet:///plugins\fR
|
|
962
946
|
.IP "" 0
|
|
963
|
-
.SS "pluginsync"
|
|
964
|
-
Whether plugins should be synced with the central server\. This setting is deprecated\.
|
|
965
|
-
.IP "\(bu" 4
|
|
966
|
-
\fIDefault\fR: \fBtrue\fR
|
|
967
|
-
.IP "" 0
|
|
968
947
|
.SS "postrun_command"
|
|
969
|
-
A command to run after every agent run\. If this command returns a non\-zero return code, the entire
|
|
948
|
+
A command to run after every agent run\. If this command returns a non\-zero return code, the entire OpenVox run will be considered to have failed, even though it might have performed work during the normal run\.
|
|
970
949
|
.SS "preferred_serialization_format"
|
|
971
950
|
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\.
|
|
972
951
|
.IP "\(bu" 4
|
|
973
952
|
\fIDefault\fR: \fBjson\fR
|
|
974
953
|
.IP "" 0
|
|
975
954
|
.SS "preprocess_deferred"
|
|
976
|
-
Whether
|
|
955
|
+
Whether OpenVox should call deferred functions before applying the catalog\. If set to \fBtrue\fR, all prerequisites required for the deferred function must be satisfied before the OpenVox run\. If set to \fBfalse\fR, deferred functions follow OpenVox relationships and ordering\. In this way, OpenVox can install the prerequisites required for a deferred function and call the deferred function in the same run\. Please note that many functions that return complex datatypes will fail when disabling preprocessing and this option may be removed in the future\.
|
|
977
956
|
.IP "\(bu" 4
|
|
978
|
-
\fIDefault\fR: \
|
|
957
|
+
\fIDefault\fR: \fBtrue\fR
|
|
979
958
|
.IP "" 0
|
|
980
959
|
.SS "prerun_command"
|
|
981
|
-
A command to run before every agent run\. If this command returns a non\-zero return code, the entire
|
|
960
|
+
A command to run before every agent run\. If this command returns a non\-zero return code, the entire OpenVox run will fail\.
|
|
982
961
|
.SS "preview_outputdir"
|
|
983
962
|
The directory where catalog previews per node are generated\.
|
|
984
963
|
.IP "\(bu" 4
|
|
985
964
|
\fIDefault\fR: \fB$vardir/preview\fR
|
|
986
965
|
.IP "" 0
|
|
987
966
|
.SS "priority"
|
|
988
|
-
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\.
|
|
967
|
+
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\. OpenVox must be running as a privileged user in order to increase scheduling priority\.
|
|
989
968
|
.IP "\(bu" 4
|
|
990
969
|
\fIDefault\fR: ``
|
|
991
970
|
.IP "" 0
|
|
@@ -1005,7 +984,7 @@ Whether to enable experimental performance profiling
|
|
|
1005
984
|
\fIDefault\fR: \fBfalse\fR
|
|
1006
985
|
.IP "" 0
|
|
1007
986
|
.SS "publicdir"
|
|
1008
|
-
Where
|
|
987
|
+
Where OpenVox stores public files\.
|
|
1009
988
|
.IP "\(bu" 4
|
|
1010
989
|
\fIDefault\fR: \fBUnix/Linux: /opt/puppetlabs/puppet/public \-\- Windows: C:\eProgramData\ePuppetLabs\epuppet\epublic \-\- Non\-root user: ~/\.puppetlabs/opt/puppet/public\fR
|
|
1011
990
|
.IP "" 0
|
|
@@ -1020,11 +999,11 @@ Whether to print the Puppet stack trace on some errors\. This is a noop if \fBtr
|
|
|
1020
999
|
\fIDefault\fR: \fBfalse\fR
|
|
1021
1000
|
.IP "" 0
|
|
1022
1001
|
.SS "puppetdlog"
|
|
1023
|
-
The fallback log file\. This is only used when the \fB\-\-logdest\fR option is not specified AND
|
|
1002
|
+
The fallback log file\. This is only used when the \fB\-\-logdest\fR option is not specified AND OpenVox 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\.)
|
|
1024
1003
|
.P
|
|
1025
1004
|
Despite the name, both puppet agent and puppet server will use this file as the fallback logging destination\.
|
|
1026
1005
|
.P
|
|
1027
|
-
For control over logging destinations, see the \fB\-\-logdest\fR command line option in the manual pages for puppet server, puppet agent, and puppet apply\. You can see man pages by running \fBpuppet <SUBCOMMAND> \-\-help\fR, or read them online at https://
|
|
1006
|
+
For control over logging destinations, see the \fB\-\-logdest\fR command line option in the manual pages for puppet server, puppet agent, and puppet apply\. You can see man pages by running \fBpuppet <SUBCOMMAND> \-\-help\fR, or read them online at https://docs\.openvoxproject\.org/openvox/latest/man/\.
|
|
1028
1007
|
.IP "\(bu" 4
|
|
1029
1008
|
\fIDefault\fR: \fB$logdir/puppetd\.log\fR
|
|
1030
1009
|
.IP "" 0
|
|
@@ -1034,14 +1013,14 @@ Whether to send reports after every transaction\.
|
|
|
1034
1013
|
\fIDefault\fR: \fBtrue\fR
|
|
1035
1014
|
.IP "" 0
|
|
1036
1015
|
.SS "report_configured_environmentpath"
|
|
1037
|
-
Specifies how environment paths are reported\. When the value of \fBversioned_environment_dirs\fR is \fBtrue\fR,
|
|
1016
|
+
Specifies how environment paths are reported\. When the value of \fBversioned_environment_dirs\fR is \fBtrue\fR, OpenVox applies the readlink function to the \fBenvironmentpath\fR 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\.
|
|
1038
1017
|
.P
|
|
1039
1018
|
When set to \fBfalse\fR, the resolved paths are reported instead of the configured paths\.
|
|
1040
1019
|
.IP "\(bu" 4
|
|
1041
1020
|
\fIDefault\fR: \fBtrue\fR
|
|
1042
1021
|
.IP "" 0
|
|
1043
1022
|
.SS "report_include_system_store"
|
|
1044
|
-
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
|
|
1023
|
+
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 OpenVox CA or one of its intermediate CAs\. If true, the processor will additionally trust CA certificates in the system's certificate store\.
|
|
1045
1024
|
.IP "\(bu" 4
|
|
1046
1025
|
\fIDefault\fR: \fBfalse\fR
|
|
1047
1026
|
.IP "" 0
|
|
@@ -1063,13 +1042,13 @@ The directory in which to store reports\. Each node gets a separate subdirectory
|
|
|
1063
1042
|
.SS "reports"
|
|
1064
1043
|
The list of report handlers to use\. When using multiple report handlers, their names should be comma\-separated, with whitespace allowed\. (For example, \fBreports = http, store\fR\.)
|
|
1065
1044
|
.P
|
|
1066
|
-
This setting is relevant to puppet server and puppet apply\. The primary
|
|
1045
|
+
This setting is relevant to puppet server and puppet apply\. The primary OpenVox 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 \fBreport = true\fR\.)
|
|
1067
1046
|
.P
|
|
1068
1047
|
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 \fBpuppet/reports/NAME\.rb\fR\.)
|
|
1069
1048
|
.P
|
|
1070
1049
|
To turn off reports entirely, set this to \fBnone\fR
|
|
1071
1050
|
.IP "\(bu" 4
|
|
1072
|
-
\fIDefault\fR: \
|
|
1051
|
+
\fIDefault\fR: \fBnone\fR
|
|
1073
1052
|
.IP "" 0
|
|
1074
1053
|
.SS "reporturl"
|
|
1075
1054
|
The URL that reports should be forwarded to\. This setting is only used when the \fBhttp\fR report processor is enabled (see the \fBreports\fR setting)\.
|
|
@@ -1087,7 +1066,7 @@ The file in which puppet agent stores a list of the resources associated with th
|
|
|
1087
1066
|
\fIDefault\fR: \fB$statedir/resources\.txt\fR
|
|
1088
1067
|
.IP "" 0
|
|
1089
1068
|
.SS "resubmit_facts"
|
|
1090
|
-
Whether to send updated facts after every transaction\. By default
|
|
1069
|
+
Whether to send updated facts after every transaction\. By default OpenVox only submits facts at the beginning of the transaction before applying a catalog\. Since OpenVox can modify the state of the system, the value of the facts may change after OpenVox finishes\. Therefore, any facts stored in OpenVoxDB may not be consistent until the agent next runs, typically in 30 minutes\. If this feature is enabled, OpenVox will resubmit facts after applying its catalog, ensuring facts for the node stored in OpenVoxDB are current\. However, this will double the fact submission load on OpenVoxDB, so it is disabled by default\.
|
|
1091
1070
|
.IP "\(bu" 4
|
|
1092
1071
|
\fIDefault\fR: \fBfalse\fR
|
|
1093
1072
|
.IP "" 0
|
|
@@ -1102,7 +1081,7 @@ The YAML file containing indirector route configuration\.
|
|
|
1102
1081
|
\fIDefault\fR: \fB$confdir/routes\.yaml\fR
|
|
1103
1082
|
.IP "" 0
|
|
1104
1083
|
.SS "rundir"
|
|
1105
|
-
Where
|
|
1084
|
+
Where OpenVox PID files are kept\.
|
|
1106
1085
|
.IP "\(bu" 4
|
|
1107
1086
|
\fIDefault\fR: \fBUnix/Linux: /var/run/puppetlabs \-\- Windows: C:\eProgramData\ePuppetLabs\epuppet\evar\erun \-\- Non\-root user: ~/\.puppetlabs/var/run\fR
|
|
1108
1087
|
.IP "" 0
|
|
@@ -1112,7 +1091,7 @@ How often puppet agent applies the catalog\. Note that a runinterval of 0 means
|
|
|
1112
1091
|
\fIDefault\fR: \fB30m\fR
|
|
1113
1092
|
.IP "" 0
|
|
1114
1093
|
.SS "runtimeout"
|
|
1115
|
-
The maximum amount of time an agent run is allowed to take\.
|
|
1094
|
+
The maximum amount of time an agent run is allowed to take\. An OpenVox agent run that exceeds this timeout will be aborted\. A value of 0 disables the timeout\. Defaults to 1 hour\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
|
|
1116
1095
|
.IP "\(bu" 4
|
|
1117
1096
|
\fIDefault\fR: \fB1h\fR
|
|
1118
1097
|
.IP "" 0
|
|
@@ -1122,22 +1101,19 @@ Where the serial number for certificates is stored\.
|
|
|
1122
1101
|
\fIDefault\fR: \fB$cadir/serial\fR
|
|
1123
1102
|
.IP "" 0
|
|
1124
1103
|
.SS "server"
|
|
1125
|
-
The primary
|
|
1126
|
-
.IP "\(bu" 4
|
|
1127
|
-
\fIDefault\fR: \fBpuppet\fR
|
|
1128
|
-
.IP "" 0
|
|
1104
|
+
The primary OpenVox server to which the OpenVox agent should connect\. This setting is ignored when \fBserver_list\fR is specified\.
|
|
1129
1105
|
.SS "server_datadir"
|
|
1130
1106
|
The directory in which serialized data is stored, usually in a subdirectory\.
|
|
1131
1107
|
.IP "\(bu" 4
|
|
1132
1108
|
\fIDefault\fR: \fB$vardir/server_data\fR
|
|
1133
1109
|
.IP "" 0
|
|
1134
1110
|
.SS "server_list"
|
|
1135
|
-
The list of primary
|
|
1111
|
+
The list of primary OpenVox servers to which the OpenVox 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, OpenVox uses the \fBserverport\fR setting for that host\. This setting takes precedence over \fBserver\fR\.
|
|
1136
1112
|
.IP "\(bu" 4
|
|
1137
1113
|
\fIDefault\fR: \fB[]\fR
|
|
1138
1114
|
.IP "" 0
|
|
1139
1115
|
.SS "serverport"
|
|
1140
|
-
The default port puppet subcommands use to communicate with
|
|
1116
|
+
The default port puppet subcommands use to communicate with OpenVox Server\. (eg \fBpuppet facts upload\fR, \fBpuppet agent\fR)\. May be overridden by more specific settings (see \fBca_port\fR, \fBreport_port\fR)\.
|
|
1141
1117
|
.IP "\(bu" 4
|
|
1142
1118
|
\fIDefault\fR: \fB8140\fR
|
|
1143
1119
|
.IP "" 0
|
|
@@ -1147,7 +1123,7 @@ Whether to compile and apply the settings catalog
|
|
|
1147
1123
|
\fIDefault\fR: \fBtrue\fR
|
|
1148
1124
|
.IP "" 0
|
|
1149
1125
|
.SS "show_diff"
|
|
1150
|
-
Whether to log and report a contextual diff when files are being replaced\. This causes partial file contents to pass through
|
|
1126
|
+
Whether to log and report a contextual diff when files are being replaced\. This causes partial file contents to pass through OpenVox's normal logging and reporting system, so this setting should be used with caution if you are sending OpenVox's reports to an insecure destination\. This feature currently requires the \fBdiff/lcs\fR Ruby library\.
|
|
1151
1127
|
.IP "\(bu" 4
|
|
1152
1128
|
\fIDefault\fR: \fBfalse\fR
|
|
1153
1129
|
.IP "" 0
|
|
@@ -1175,7 +1151,7 @@ For example, assume a default 30\-minute \fB$runinterval\fR, \fBsplay\fR set to
|
|
|
1175
1151
|
.P
|
|
1176
1152
|
With \fBsplay\fR enabled, it waits any amount of time up to its \fB$splaylimit\fR before its first run\. For example, it might randomly wait 8 minutes, then start its first run at :08 past the hour\. With the \fB$runinterval\fR at its default 30 minutes, its next run will be at :38 past the hour\.
|
|
1177
1153
|
.P
|
|
1178
|
-
If you restart an agent's puppet service with \fBsplay\fR 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
|
|
1154
|
+
If you restart an agent's puppet service with \fBsplay\fR 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 OpenVox agents with \fBsplay\fR enabled, their checkins to your primary servers can be distributed more evenly\.
|
|
1179
1155
|
.IP "\(bu" 4
|
|
1180
1156
|
\fIDefault\fR: \fBfalse\fR
|
|
1181
1157
|
.IP "" 0
|
|
@@ -1190,7 +1166,7 @@ The domain which will be queried to find the SRV records of servers to use\.
|
|
|
1190
1166
|
\fIDefault\fR: \fBexample\.com\fR
|
|
1191
1167
|
.IP "" 0
|
|
1192
1168
|
.SS "ssl_client_header"
|
|
1193
|
-
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\., \fB/CN=puppet\.puppetlabs\.com\fR)\.
|
|
1169
|
+
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\., \fB/CN=puppet\.puppetlabs\.com\fR)\. OpenVox will parse out the Common Name (CN) from the Distinguished Name (DN) and use the value of the CN field for authorization\.
|
|
1194
1170
|
.P
|
|
1195
1171
|
Note that the name of the HTTP header gets munged by the web server common gateway interface: an \fBHTTP_\fR prefix is added, dashes are converted to underscores, and all letters are uppercased\. Thus, to use the \fBX\-Client\-DN\fR header, this setting should be \fBHTTP_X_CLIENT_DN\fR\.
|
|
1196
1172
|
.IP "\(bu" 4
|
|
@@ -1209,7 +1185,7 @@ A lock file to indicate that the ssl bootstrap process is currently in progress\
|
|
|
1209
1185
|
\fIDefault\fR: \fB$ssldir/ssl\.lock\fR
|
|
1210
1186
|
.IP "" 0
|
|
1211
1187
|
.SS "ssl_trust_store"
|
|
1212
|
-
A file containing CA certificates in PEM format that
|
|
1188
|
+
A file containing CA certificates in PEM format that OpenVox should trust when making HTTPS requests\. This \fBonly\fR applies to https requests to non\-OpenVox 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\.
|
|
1213
1189
|
.IP "\(bu" 4
|
|
1214
1190
|
\fIDefault\fR: ``
|
|
1215
1191
|
.IP "" 0
|
|
@@ -1219,24 +1195,24 @@ Where SSL certificates are kept\.
|
|
|
1219
1195
|
\fIDefault\fR: \fB$confdir/ssl\fR
|
|
1220
1196
|
.IP "" 0
|
|
1221
1197
|
.SS "statedir"
|
|
1222
|
-
The directory where
|
|
1198
|
+
The directory where OpenVox state is stored\. Generally, this directory can be removed without causing harm (although it might result in spurious service restarts)\.
|
|
1223
1199
|
.IP "\(bu" 4
|
|
1224
1200
|
\fIDefault\fR: \fB$vardir/state\fR
|
|
1225
1201
|
.IP "" 0
|
|
1226
1202
|
.SS "statefile"
|
|
1227
|
-
Where
|
|
1203
|
+
Where the OpenVox agent and OpenVox Server store state associated with the running configuration\. In the case of OpenVox Server, this file reflects the state discovered through interacting with clients\.
|
|
1228
1204
|
.IP "\(bu" 4
|
|
1229
1205
|
\fIDefault\fR: \fB$statedir/state\.yaml\fR
|
|
1230
1206
|
.IP "" 0
|
|
1231
1207
|
.SS "statettl"
|
|
1232
|
-
How long the
|
|
1208
|
+
How long the OpenVox agent should cache when a resource was last checked or synced\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. A value of \fB0\fR or \fBunlimited\fR will disable cache pruning\.
|
|
1233
1209
|
.P
|
|
1234
1210
|
This setting affects the usage of \fBschedule\fR resources, as the information about when a resource was last checked (and therefore when it needs to be checked again) is stored in the \fBstatefile\fR\. The \fBstatettl\fR 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\.
|
|
1235
1211
|
.IP "\(bu" 4
|
|
1236
1212
|
\fIDefault\fR: \fB32d\fR
|
|
1237
1213
|
.IP "" 0
|
|
1238
1214
|
.SS "static_catalogs"
|
|
1239
|
-
Whether to compile a static catalog \fIhttps://
|
|
1215
|
+
Whether to compile a static catalog \fIhttps://docs\.openvoxproject\.org/openvox/latest/static_catalogs\.html#enabling\-or\-disabling\-static\-catalogs\fR, which occurs only on OpenVox Server when the \fBcode\-id\-command\fR and \fBcode\-content\-command\fR settings are configured in its \fBpuppetserver\.conf\fR file\.
|
|
1240
1216
|
.IP "\(bu" 4
|
|
1241
1217
|
\fIDefault\fR: \fBtrue\fR
|
|
1242
1218
|
.IP "" 0
|
|
@@ -1250,12 +1226,12 @@ You can adjust the backend using the storeconfigs_backend setting\.
|
|
|
1250
1226
|
\fIDefault\fR: \fBfalse\fR
|
|
1251
1227
|
.IP "" 0
|
|
1252
1228
|
.SS "storeconfigs_backend"
|
|
1253
|
-
Configure the backend terminus used for StoreConfigs\. By default, this uses the
|
|
1229
|
+
Configure the backend terminus used for StoreConfigs\. By default, this uses the OpenVoxDB store, which must be installed and configured before turning on StoreConfigs\.
|
|
1254
1230
|
.IP "\(bu" 4
|
|
1255
1231
|
\fIDefault\fR: \fBpuppetdb\fR
|
|
1256
1232
|
.IP "" 0
|
|
1257
1233
|
.SS "strict"
|
|
1258
|
-
The strictness level of
|
|
1234
|
+
The strictness level of OpenVox\. Allowed values are:
|
|
1259
1235
|
.IP "\(bu" 4
|
|
1260
1236
|
off \- do not perform extra validation, do not report
|
|
1261
1237
|
.IP "\(bu" 4
|
|
@@ -1286,7 +1262,7 @@ Whether to print a transaction summary\.
|
|
|
1286
1262
|
\fIDefault\fR: \fBfalse\fR
|
|
1287
1263
|
.IP "" 0
|
|
1288
1264
|
.SS "supported_checksum_types"
|
|
1289
|
-
Checksum types supported by this agent for use in file resources of a static catalog\. Values must be comma\-separated\. Valid types are sha256, sha256lite, sha384, sha512, sha224, sha1, sha1lite, md5, md5lite, mtime, ctime\. Default is sha256, sha384, sha512, sha224, md5\.
|
|
1265
|
+
Checksum types supported by this agent for use in file resources of a static catalog\. Values must be comma\-separated\. Valid types are sha256, sha256lite, sha384, sha512, sha224, sha1, sha1lite, md5, md5lite, mtime, ctime, etag\. Default is sha256, sha384, sha512, sha224, md5\.
|
|
1290
1266
|
.IP "\(bu" 4
|
|
1291
1267
|
\fIDefault\fR: \fB["sha256", "sha384", "sha512", "sha224", "md5"]\fR
|
|
1292
1268
|
.IP "" 0
|
|
@@ -1337,12 +1313,12 @@ File that provides mapping between custom SSL oids and user\-friendly names
|
|
|
1337
1313
|
\fIDefault\fR: \fB$confdir/custom_trusted_oid_mapping\.yaml\fR
|
|
1338
1314
|
.IP "" 0
|
|
1339
1315
|
.SS "use_cached_catalog"
|
|
1340
|
-
Whether to only use the cached catalog rather than compiling a new catalog on every run\.
|
|
1316
|
+
Whether to only use the cached catalog rather than compiling a new catalog on every run\. OpenVox can be run with this enabled by default and then selectively disabled when a recompile is desired\. Because an OpenVox 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 OpenVox run\.
|
|
1341
1317
|
.IP "\(bu" 4
|
|
1342
1318
|
\fIDefault\fR: \fBfalse\fR
|
|
1343
1319
|
.IP "" 0
|
|
1344
1320
|
.SS "use_last_environment"
|
|
1345
|
-
|
|
1321
|
+
OpenVox 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\.
|
|
1346
1322
|
.P
|
|
1347
1323
|
When set to false, we will do the node request and ignore the environment data from the last_run_summary file\.
|
|
1348
1324
|
.IP "\(bu" 4
|
|
@@ -1359,12 +1335,12 @@ Whether to use the cached configuration when the remote configuration will not c
|
|
|
1359
1335
|
\fIDefault\fR: \fBtrue\fR
|
|
1360
1336
|
.IP "" 0
|
|
1361
1337
|
.SS "user"
|
|
1362
|
-
The user
|
|
1338
|
+
The user OpenVox Server will run as\. Used to ensure the agent side processes (agent, apply, etc) create files and directories readable by OpenVox Server when necessary\.
|
|
1363
1339
|
.IP "\(bu" 4
|
|
1364
1340
|
\fIDefault\fR: \fBpuppet\fR
|
|
1365
1341
|
.IP "" 0
|
|
1366
1342
|
.SS "vardir"
|
|
1367
|
-
Where
|
|
1343
|
+
Where OpenVox stores dynamic and growing data\. The default for this setting is calculated specially, like \fBconfdir\fR_\.
|
|
1368
1344
|
.IP "\(bu" 4
|
|
1369
1345
|
\fIDefault\fR: \fBUnix/Linux: /opt/puppetlabs/puppet/cache \-\- Windows: C:\eProgramData\ePuppetLabs\epuppet\ecache \-\- Non\-root user: ~/\.puppetlabs/opt/puppet/cache\fR
|
|
1370
1346
|
.IP "" 0
|
|
@@ -1381,9 +1357,9 @@ Whether or not to look for versioned environment directories, symlinked from \fB
|
|
|
1381
1357
|
.SS "waitforcert"
|
|
1382
1358
|
How frequently puppet agent should ask for a signed certificate\.
|
|
1383
1359
|
.P
|
|
1384
|
-
When starting for the first time, puppet agent will submit a certificate signing request (CSR) to the server named in the \fBca_server\fR setting (usually the primary
|
|
1360
|
+
When starting for the first time, puppet agent will submit a certificate signing request (CSR) to the server named in the \fBca_server\fR setting (usually the primary OpenVox server); this may be autosigned, or may need to be approved by a human, depending on the CA server's configuration\.
|
|
1385
1361
|
.P
|
|
1386
|
-
|
|
1362
|
+
The OpenVox 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 \fBmaxwaitforcert\fR setting, in which case puppet agent will exit if it cannot get a cert\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
|
|
1387
1363
|
.IP "\(bu" 4
|
|
1388
1364
|
\fIDefault\fR: \fB2m\fR
|
|
1389
1365
|
.IP "" 0
|