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/man8/puppet-agent.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-AGENT" "8" "
|
|
3
|
+
.TH "PUPPET\-AGENT" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-agent\fR \- The puppet agent daemon provided by OpenVox
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -10,7 +10,7 @@ This service may be run as a daemon, run periodically using cron (or something s
|
|
|
10
10
|
.SH "USAGE"
|
|
11
11
|
puppet agent [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-serverport \fIPORT\fR] [\-\-noop] [\-o|\-\-onetime] [\-\-sourceaddress \fIIP_ADDRESS\fR] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fISECONDS\fR]
|
|
12
12
|
.SH "DESCRIPTION"
|
|
13
|
-
This is the main
|
|
13
|
+
This is the main OpenVox client\. Its job is to retrieve the local machine's configuration from a remote server and apply it\. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the OpenVox server (which is the default)\. The client will connect and request a signed certificate, and will continue connecting until it receives one\.
|
|
14
14
|
.P
|
|
15
15
|
Once the client has a signed certificate, it will retrieve its configuration and apply it\.
|
|
16
16
|
.SH "USAGE NOTES"
|
|
@@ -31,21 +31,21 @@ Some flags are meant specifically for interactive use \-\- in particular, 'test'
|
|
|
31
31
|
6: The run succeeded, and included both changes and failures\.
|
|
32
32
|
.IP "" 0
|
|
33
33
|
.P
|
|
34
|
-
\&'\-\-tags' allows you to specify what portions of a configuration you want to apply\.
|
|
34
|
+
\&'\-\-tags' allows you to specify what portions of a configuration you want to apply\. OpenVox elements are tagged with all of the class or definition names that contain them, and you can use the 'tags' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage 'ntpd', you would put all of the new elements into an 'ntpd' class, and call puppet with '\-\-tags ntpd', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\.
|
|
35
35
|
.P
|
|
36
|
-
\&'\-\-fingerprint' is a one\-time flag\. In this mode 'puppet agent' runs once and displays on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the '\-\-digest' option allows you to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the
|
|
36
|
+
\&'\-\-fingerprint' is a one\-time flag\. In this mode 'puppet agent' runs once and displays on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the '\-\-digest' option allows you to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the server, the certificate request the server received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
|
|
37
37
|
.P
|
|
38
38
|
\&'\-\-skip_tags' is a flag used to filter resources\. If this is set, then only resources not tagged with the specified tags will be applied\. Values must be comma\-separated\.
|
|
39
39
|
.SH "OPTIONS"
|
|
40
|
-
Note that any
|
|
40
|
+
Note that any OpenVox setting that's valid in the configuration file is also a valid long argument\. For example, 'server' is a valid setting, so you can specify '\-\-server \fIservername\fR' as an argument\. Boolean settings accept a '\-\-no\-' prefix to turn off a behavior, translating into '\-\-setting' and '\-\-no\-setting' pairs, such as \fB\-\-daemonize\fR and \fB\-\-no\-daemonize\fR\.
|
|
41
41
|
.P
|
|
42
|
-
See the configuration file documentation at https://
|
|
42
|
+
See the configuration file documentation at https://docs\.openvoxproject\.org/openvox/latest/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with '\-\-genconfig'\.
|
|
43
43
|
.IP "\(bu" 4
|
|
44
|
-
\-\-certname: Set the certname (unique ID) of the client\. The
|
|
44
|
+
\-\-certname: Set the certname (unique ID) of the client\. The server reads this unique identifying string, which is usually set to the node's fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. (This is an OpenVox setting, and can go in puppet\.conf\.)
|
|
45
45
|
.IP "\(bu" 4
|
|
46
|
-
\-\-daemonize: Send the process into the background\. This is the default\. (This is
|
|
46
|
+
\-\-daemonize: Send the process into the background\. This is the default\. (This is an OpenVox setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
|
|
47
47
|
.IP "\(bu" 4
|
|
48
|
-
\-\-no\-daemonize: Do not send the process into the background\. (This is
|
|
48
|
+
\-\-no\-daemonize: Do not send the process into the background\. (This is an OpenVox setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
|
|
49
49
|
.IP "\(bu" 4
|
|
50
50
|
\-\-debug: Enable full debugging\.
|
|
51
51
|
.IP "\(bu" 4
|
|
@@ -75,13 +75,13 @@ Disable can also take an optional message that will be reported by the 'puppet a
|
|
|
75
75
|
.IP
|
|
76
76
|
\&'puppet agent' exits after executing this\.
|
|
77
77
|
.IP "\(bu" 4
|
|
78
|
-
\-\-evaltrace: Logs each resource as it is being evaluated\. This allows you to interactively see exactly what is being done\. (This is
|
|
78
|
+
\-\-evaltrace: Logs each resource as it is being evaluated\. This allows you to interactively see exactly what is being done\. (This is an OpenVox setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
|
|
79
79
|
.IP "\(bu" 4
|
|
80
80
|
\-\-fingerprint: Display the current certificate or certificate signing request fingerprint and then exit\. Use the '\-\-digest' option to change the digest algorithm used\.
|
|
81
81
|
.IP "\(bu" 4
|
|
82
82
|
\-\-help: Print this help message
|
|
83
83
|
.IP "\(bu" 4
|
|
84
|
-
\-\-job\-id: Attach the specified job id to the catalog request and the report used for this agent run\. This option only works when '\-\-onetime' is used\.
|
|
84
|
+
\-\-job\-id: Attach the specified job id to the catalog request and the report used for this agent run\. This option only works when '\-\-onetime' is used\.
|
|
85
85
|
.IP "\(bu" 4
|
|
86
86
|
\-\-logdest: 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\. If debugging or verbosity is enabled, this defaults to 'console'\. Otherwise, it defaults to 'syslog' on POSIX systems and 'eventlog' on Windows\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
|
|
87
87
|
.IP
|
|
@@ -89,47 +89,47 @@ A path ending with '\.json' will receive structured output in JSON format\. The
|
|
|
89
89
|
.IP
|
|
90
90
|
A path ending with '\.jsonl' will receive structured output in JSON Lines format\.
|
|
91
91
|
.IP "\(bu" 4
|
|
92
|
-
\-\-masterport: The port on which to contact the
|
|
92
|
+
\-\-masterport: The port on which to contact the OpenVox Server\. (This is an OpenVox setting, and can go in puppet\.conf\. Deprecated in favor of the 'serverport' setting\.)
|
|
93
93
|
.IP "\(bu" 4
|
|
94
|
-
\-\-noop: Use 'noop' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes
|
|
94
|
+
\-\-noop: Use 'noop' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes OpenVox would make without actually executing the changes\. (This is an OpenVox setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
|
|
95
95
|
.IP "\(bu" 4
|
|
96
|
-
\-\-onetime: Run the configuration once\. Runs a single (normally daemonized)
|
|
96
|
+
\-\-onetime: Run the configuration once\. Runs a single (normally daemonized) OpenVox run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. (This is an OpenVox setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
|
|
97
97
|
.IP "\(bu" 4
|
|
98
|
-
\-\-serverport: The port on which to contact the
|
|
98
|
+
\-\-serverport: The port on which to contact the OpenVox Server\. (This is an OpenVox setting, and can go in puppet\.conf\.)
|
|
99
99
|
.IP "\(bu" 4
|
|
100
|
-
\-\-sourceaddress: Set the source IP address for transactions\. This defaults to automatically selected\. (This is
|
|
100
|
+
\-\-sourceaddress: Set the source IP address for transactions\. This defaults to automatically selected\. (This is an OpenVox setting, and can go in puppet\.conf\.)
|
|
101
101
|
.IP "\(bu" 4
|
|
102
102
|
\-\-test: Enable the most common options used for testing\. These are 'onetime', 'verbose', 'no\-daemonize', 'no\-usecacheonfailure', 'detailed\-exitcodes', 'no\-splay', and 'show_diff'\.
|
|
103
103
|
.IP "\(bu" 4
|
|
104
|
-
\-\-trace Prints stack traces on some errors\. (This is
|
|
104
|
+
\-\-trace Prints stack traces on some errors\. (This is an OpenVox setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
|
|
105
105
|
.IP "\(bu" 4
|
|
106
106
|
\-\-verbose: Turn on verbose reporting\.
|
|
107
107
|
.IP "\(bu" 4
|
|
108
|
-
\-\-version: Print the
|
|
108
|
+
\-\-version: Print the OpenVox agent version number and exit\.
|
|
109
109
|
.IP "\(bu" 4
|
|
110
|
-
\-\-waitforcert: This option only matters for daemons that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes 'puppet agent' to connect to the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of
|
|
110
|
+
\-\-waitforcert: This option only matters for daemons that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes 'puppet agent' to connect to the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of an OpenVox client\. You can turn off waiting for certificates by specifying a time of 0\. (This is an OpenVox setting, and can go in puppet\.conf\.)
|
|
111
111
|
.IP "\(bu" 4
|
|
112
|
-
\-\-write_catalog_summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes\.txt and resources\.txt (This is
|
|
112
|
+
\-\-write_catalog_summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes\.txt and resources\.txt (This is an OpenVox setting, and can go in puppet\.conf\.)
|
|
113
113
|
.IP "" 0
|
|
114
114
|
.SH "EXAMPLE"
|
|
115
115
|
.nf
|
|
116
116
|
$ puppet agent \-\-server puppet\.domain\.com
|
|
117
117
|
.fi
|
|
118
118
|
.SH "DIAGNOSTICS"
|
|
119
|
-
|
|
119
|
+
OpenVox agent accepts the following signals:
|
|
120
120
|
.TP
|
|
121
121
|
SIGHUP
|
|
122
|
-
Restart the
|
|
122
|
+
Restart the OpenVox agent daemon\.
|
|
123
123
|
.TP
|
|
124
124
|
SIGINT and SIGTERM
|
|
125
|
-
Shut down the
|
|
125
|
+
Shut down the OpenVox agent daemon\.
|
|
126
126
|
.TP
|
|
127
127
|
SIGUSR1
|
|
128
|
-
Immediately retrieve and apply configurations from the
|
|
128
|
+
Immediately retrieve and apply configurations from the OpenVox server\.
|
|
129
129
|
.TP
|
|
130
130
|
SIGUSR2
|
|
131
131
|
Close file descriptors for log files and reopen them\. Used with logrotate\.
|
|
132
132
|
.SH "AUTHOR"
|
|
133
133
|
Luke Kanies
|
|
134
134
|
.SH "COPYRIGHT"
|
|
135
|
-
Copyright (c) 2011 Puppet Inc
|
|
135
|
+
Copyright (c) 2011 Puppet Inc\.; Copyright (c) 2024 Vox Pupuli\. Licensed under the Apache 2\.0 License
|
data/man/man8/puppet-apply.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-APPLY" "8" "
|
|
3
|
+
.TH "PUPPET\-APPLY" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-apply\fR \- Apply Puppet manifests locally via OpenVox
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -12,11 +12,11 @@ This is the standalone puppet execution tool; use it to apply individual manifes
|
|
|
12
12
|
.P
|
|
13
13
|
When provided with a modulepath, via command line or config file, puppet apply can effectively mimic the catalog that would be served by OpenVox server with access to the same modules, although there are some subtle differences\. When combined with scheduling and an automated system for pushing manifests, this can be used to implement a serverless site\.
|
|
14
14
|
.P
|
|
15
|
-
Most users should use 'puppet agent'
|
|
15
|
+
Most users should use 'puppet agent' with an OpenVox server for site\-wide manifests\.
|
|
16
16
|
.SH "OPTIONS"
|
|
17
17
|
Any setting that's valid in the configuration file is a valid long argument for puppet apply\. For example, 'tags' is a valid setting, so you can specify '\-\-tags \fIclass\fR,\fItag\fR' as an argument\.
|
|
18
18
|
.P
|
|
19
|
-
See the configuration file documentation at https://
|
|
19
|
+
See the configuration file documentation at https://docs\.openvoxproject\.org/openvox/latest/configuration\.html for the full list of acceptable parameters\. You can generate a commented list of all configuration options by running puppet with '\-\-genconfig'\.
|
|
20
20
|
.IP "\(bu" 4
|
|
21
21
|
\-\-debug: Enable full debugging\.
|
|
22
22
|
.IP "\(bu" 4
|
|
@@ -42,7 +42,7 @@ A path ending with '\.json' will receive structured output in JSON format\. The
|
|
|
42
42
|
.IP
|
|
43
43
|
A path ending with '\.jsonl' will receive structured output in JSON Lines format\.
|
|
44
44
|
.IP "\(bu" 4
|
|
45
|
-
\-\-noop: Use 'noop' mode where
|
|
45
|
+
\-\-noop: Use 'noop' mode where OpenVox runs in a no\-op or dry\-run mode\. This is useful for seeing what changes OpenVox will make without actually executing the changes\.
|
|
46
46
|
.IP "\(bu" 4
|
|
47
47
|
\-\-execute: Execute a specific piece of Puppet code
|
|
48
48
|
.IP "\(bu" 4
|
|
@@ -50,7 +50,7 @@ A path ending with '\.jsonl' will receive structured output in JSON Lines format
|
|
|
50
50
|
.IP "\(bu" 4
|
|
51
51
|
\-\-verbose: Print extra information\.
|
|
52
52
|
.IP "\(bu" 4
|
|
53
|
-
\-\-catalog: Apply a JSON catalog (such as one generated with 'puppet
|
|
53
|
+
\-\-catalog: Apply a JSON catalog (such as one generated with 'puppet catalog compile')\. You can either specify a JSON file or pipe in JSON from standard input\.
|
|
54
54
|
.IP "\(bu" 4
|
|
55
55
|
\-\-write\-catalog\-summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes\.txt and resources\.txt
|
|
56
56
|
.IP "" 0
|
|
@@ -64,4 +64,4 @@ $ puppet apply \-\-catalog catalog\.json
|
|
|
64
64
|
.SH "AUTHOR"
|
|
65
65
|
Luke Kanies
|
|
66
66
|
.SH "COPYRIGHT"
|
|
67
|
-
Copyright (c) 2011 Puppet Inc
|
|
67
|
+
Copyright (c) 2011 Puppet Inc\.; Copyright (c) 2024 Vox Pupuli\. Licensed under the Apache 2\.0 License
|
data/man/man8/puppet-catalog.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-CATALOG" "8" "
|
|
3
|
+
.TH "PUPPET\-CATALOG" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -10,7 +10,7 @@ This subcommand deals with catalogs, which are compiled per\-node artifacts gene
|
|
|
10
10
|
.SH "OPTIONS"
|
|
11
11
|
Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
|
|
12
12
|
.P
|
|
13
|
-
See the configuration file documentation at \fIhttps://
|
|
13
|
+
See the configuration file documentation at \fIhttps://docs\.openvoxproject\.org/openvox/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
|
14
14
|
.TP
|
|
15
15
|
\-\-render\-as FORMAT
|
|
16
16
|
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
|
@@ -22,9 +22,9 @@ Whether to log verbosely\.
|
|
|
22
22
|
Whether to log debug information\.
|
|
23
23
|
.TP
|
|
24
24
|
\-\-terminus _TERMINUS
|
|
25
|
-
Indirector faces expose indirected subsystems of
|
|
25
|
+
Indirector faces expose indirected subsystems of OpenVox\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In OpenVox parlance, these backends are called terminuses\.
|
|
26
26
|
.IP
|
|
27
|
-
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the
|
|
27
|
+
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the OpenVox server's data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the OpenVox server whenever it receives a remote request\.
|
|
28
28
|
.IP
|
|
29
29
|
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face's manpage for more details\.
|
|
30
30
|
.SH "ACTIONS"
|
|
@@ -55,14 +55,14 @@ Compiles a catalog locally for a node, requiring access to modules, node classif
|
|
|
55
55
|
.IP
|
|
56
56
|
A serialized catalog\.
|
|
57
57
|
.TP
|
|
58
|
-
\fBdownload\fR \- Download this node's catalog from the
|
|
58
|
+
\fBdownload\fR \- Download this node's catalog from the OpenVox server\.
|
|
59
59
|
\fBSYNOPSIS\fR
|
|
60
60
|
.IP
|
|
61
61
|
puppet catalog download [\-\-terminus _TERMINUS]
|
|
62
62
|
.IP
|
|
63
63
|
\fBDESCRIPTION\fR
|
|
64
64
|
.IP
|
|
65
|
-
Retrieves a catalog from the
|
|
65
|
+
Retrieves a catalog from the OpenVox server and saves it to the local yaml cache\. This action always contacts the OpenVox server and will ignore alternate termini\.
|
|
66
66
|
.IP
|
|
67
67
|
The saved catalog can be used in any subsequent catalog action by specifying '\-\-terminus yaml' for that action\.
|
|
68
68
|
.IP
|
|
@@ -122,7 +122,7 @@ A list of resource references ("Type[title]")\. When used from the API, returns
|
|
|
122
122
|
.IP
|
|
123
123
|
\fBNOTES\fR
|
|
124
124
|
.IP
|
|
125
|
-
By default, this action will retrieve a catalog from
|
|
125
|
+
By default, this action will retrieve a catalog from OpenVox's compiler subsystem; you must call the action with \fB\-\-terminus rest\fR if you wish to retrieve a catalog from the OpenVox server\.
|
|
126
126
|
.IP
|
|
127
127
|
FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog\. Use json instead\.
|
|
128
128
|
.SH "EXAMPLES"
|
|
@@ -132,7 +132,7 @@ Apply the locally cached catalog:
|
|
|
132
132
|
.P
|
|
133
133
|
$ puppet catalog apply \-\-terminus yaml
|
|
134
134
|
.P
|
|
135
|
-
Retrieve a catalog from the
|
|
135
|
+
Retrieve a catalog from the server and apply it, in one step:
|
|
136
136
|
.P
|
|
137
137
|
$ puppet catalog apply \-\-terminus rest
|
|
138
138
|
.P
|
|
@@ -172,11 +172,11 @@ Puppet::Face[:catalog, '0\.0\.1']\.download
|
|
|
172
172
|
.P
|
|
173
173
|
\fBselect\fR
|
|
174
174
|
.P
|
|
175
|
-
Ask the
|
|
175
|
+
Ask the OpenVox server for a list of managed file resources for a node:
|
|
176
176
|
.P
|
|
177
177
|
$ puppet catalog select \-\-terminus rest somenode\.magpie\.lan file
|
|
178
178
|
.SH "NOTES"
|
|
179
|
-
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of
|
|
179
|
+
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of OpenVox\. Valid termini for this face include:
|
|
180
180
|
.IP "\(bu" 4
|
|
181
181
|
\fBcompiler\fR
|
|
182
182
|
.IP "\(bu" 4
|
|
@@ -191,4 +191,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
|
|
|
191
191
|
\fByaml\fR
|
|
192
192
|
.IP "" 0
|
|
193
193
|
.SH "COPYRIGHT AND LICENSE"
|
|
194
|
-
Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING
|
|
194
|
+
Copyright 2011 by Puppet Inc\., Vox Pupuli\. Apache 2 license; see COPYING
|
data/man/man8/puppet-config.8
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-CONFIG" "8" "
|
|
3
|
+
.TH "PUPPET\-CONFIG" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-config\fR \- Interact with OpenVox's settings\.
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
7
|
puppet config \fIaction\fR [\-\-section SECTION_NAME]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
This subcommand can inspect and modify settings from OpenVox's 'puppet\.conf' configuration file\. For documentation about individual settings, see https://
|
|
9
|
+
This subcommand can inspect and modify settings from OpenVox's 'puppet\.conf' configuration file\. For documentation about individual settings, see https://docs\.openvoxproject\.org/openvox/latest/configuration\.html\.
|
|
10
10
|
.SH "OPTIONS"
|
|
11
11
|
Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
|
|
12
12
|
.P
|
|
13
|
-
See the configuration file documentation at \fIhttps://
|
|
13
|
+
See the configuration file documentation at \fIhttps://docs\.openvoxproject\.org/openvox/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
|
14
14
|
.TP
|
|
15
15
|
\-\-render\-as FORMAT
|
|
16
16
|
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
|
@@ -24,7 +24,7 @@ Whether to log debug information\.
|
|
|
24
24
|
\-\-section SECTION_NAME
|
|
25
25
|
The section of the puppet\.conf configuration file to interact with\.
|
|
26
26
|
.IP
|
|
27
|
-
The three most commonly used sections are 'main', 'server', and 'agent'\. 'Main' is the default, and is used by all OpenVox applications\. Other sections can override 'main' values for specific applications \-\- the 'server' section affects
|
|
27
|
+
The three most commonly used sections are 'main', 'server', and 'agent'\. 'Main' is the default, and is used by all OpenVox applications\. Other sections can override 'main' values for specific applications \-\- the 'server' section affects OpenVox Server, and the 'agent' section affects puppet agent\.
|
|
28
28
|
.IP
|
|
29
29
|
Less commonly used is the 'user' section, which affects puppet apply\. Any other section will be treated as the name of a legacy environment (a deprecated feature), and can only include the 'manifest' and 'modulepath' settings\.
|
|
30
30
|
.SH "ACTIONS"
|
|
@@ -82,7 +82,7 @@ $ puppet config delete setting_name \-\-section server
|
|
|
82
82
|
.P
|
|
83
83
|
\fBprint\fR
|
|
84
84
|
.P
|
|
85
|
-
Get
|
|
85
|
+
Get OpenVox's runfile directory:
|
|
86
86
|
.P
|
|
87
87
|
$ puppet config print rundir
|
|
88
88
|
.P
|
|
@@ -92,7 +92,7 @@ $ puppet config print all \-\-section server | grep \-E "(path|dir)"
|
|
|
92
92
|
.P
|
|
93
93
|
\fBset\fR
|
|
94
94
|
.P
|
|
95
|
-
Set
|
|
95
|
+
Set OpenVox's runfile directory:
|
|
96
96
|
.P
|
|
97
97
|
$ puppet config set rundir /var/run/puppetlabs
|
|
98
98
|
.P
|
|
@@ -100,4 +100,4 @@ Set the vardir for only the agent:
|
|
|
100
100
|
.P
|
|
101
101
|
$ puppet config set vardir /opt/puppetlabs/puppet/cache \-\-section agent
|
|
102
102
|
.SH "COPYRIGHT AND LICENSE"
|
|
103
|
-
Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING
|
|
103
|
+
Copyright 2011 by Puppet Inc\., Vox Pupuli\. Apache 2 license; see COPYING
|
data/man/man8/puppet-describe.8
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-DESCRIBE" "8" "
|
|
3
|
+
.TH "PUPPET\-DESCRIBE" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-describe\fR \- Display help about resource types available to OpenVox
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
|
-
Prints help about
|
|
7
|
+
Prints help about resource types, providers, and metaparameters installed on an OpenVox node\.
|
|
8
8
|
.SH "USAGE"
|
|
9
9
|
puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]
|
|
10
10
|
.SH "OPTIONS"
|
|
@@ -32,4 +32,4 @@ $ puppet describe user \-s \-m
|
|
|
32
32
|
.SH "AUTHOR"
|
|
33
33
|
David Lutterkort
|
|
34
34
|
.SH "COPYRIGHT"
|
|
35
|
-
Copyright (c) 2011 Puppet Inc
|
|
35
|
+
Copyright (c) 2011 Puppet Inc\.; Copyright (c) 2024 Vox Pupuli\. Licensed under the Apache 2\.0 License
|
data/man/man8/puppet-device.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-DEVICE" "8" "
|
|
3
|
+
.TH "PUPPET\-DEVICE" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-device\fR \- Manage remote network devices via OpenVox
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -24,7 +24,7 @@ The values for the type and url properties are specific to each type of device\.
|
|
|
24
24
|
.P
|
|
25
25
|
The optional debug property specifies transport\-level debugging, and is limited to telnet and ssh transports\.
|
|
26
26
|
.P
|
|
27
|
-
See https://
|
|
27
|
+
See https://docs\.openvoxproject\.org/openvox/latest/config_file_device\.html for details\.
|
|
28
28
|
.SH "OPTIONS"
|
|
29
29
|
Note that any setting that's valid in the configuration file is also a valid long argument\. For example, 'server' is a valid configuration parameter, so you can specify '\-\-server \fIservername\fR' as an argument\.
|
|
30
30
|
.TP
|
data/man/man8/puppet-doc.8
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-DOC" "8" "
|
|
3
|
+
.TH "PUPPET\-DOC" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-doc\fR \- Generate Puppet references for OpenVox
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
|
-
Generates a reference for all
|
|
7
|
+
Generates a reference for all resource types\. Largely meant for internal use\. (Deprecated)
|
|
8
8
|
.SH "USAGE"
|
|
9
9
|
puppet doc [\-h|\-\-help] [\-l|\-\-list] [\-r|\-\-reference \fIreference\-name\fR]
|
|
10
10
|
.SH "DESCRIPTION"
|
|
11
|
-
This deprecated command generates a Markdown document to stdout describing all installed
|
|
11
|
+
This deprecated command generates a Markdown document to stdout describing all installed resource types or all allowable arguments to puppet executables\. It is largely meant for internal use and is used to generate the reference documents which can be posted to a website\.
|
|
12
12
|
.P
|
|
13
13
|
For Puppet module documentation (and all other use cases) this command has been superseded by the "puppet\-strings" module \- see https://github\.com/puppetlabs/puppetlabs\-strings for more information\.
|
|
14
14
|
.P
|
|
15
|
-
This command (puppet\-doc) will be removed
|
|
15
|
+
This command (puppet\-doc) will be removed in a future release\.
|
|
16
16
|
.SH "OPTIONS"
|
|
17
17
|
.TP
|
|
18
18
|
\-\-help
|
|
@@ -27,4 +27,4 @@ $ puppet doc \-r type > /tmp/type_reference\.markdown
|
|
|
27
27
|
.SH "AUTHOR"
|
|
28
28
|
Luke Kanies
|
|
29
29
|
.SH "COPYRIGHT"
|
|
30
|
-
Copyright (c) 2011 Puppet Inc
|
|
30
|
+
Copyright (c) 2011 Puppet Inc\.; Copyright (c) 2024 Vox Pupuli\. Licensed under the Apache 2\.0 License
|
data/man/man8/puppet-epp.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-EPP" "8" "
|
|
3
|
+
.TH "PUPPET\-EPP" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-epp\fR \- Interact directly with the EPP template parser/renderer\.
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -8,7 +8,7 @@ puppet epp \fIaction\fR
|
|
|
8
8
|
.SH "OPTIONS"
|
|
9
9
|
Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
|
|
10
10
|
.P
|
|
11
|
-
See the configuration file documentation at \fIhttps://
|
|
11
|
+
See the configuration file documentation at \fIhttps://docs\.openvoxproject\.org/openvox/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
|
12
12
|
.TP
|
|
13
13
|
\-\-render\-as FORMAT
|
|
14
14
|
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
|
@@ -229,4 +229,4 @@ $ puppet epp validate mymodule/template1\.epp mymodule/template2\.epp \-\-contin
|
|
|
229
229
|
.fi
|
|
230
230
|
.IP "" 0
|
|
231
231
|
.SH "COPYRIGHT AND LICENSE"
|
|
232
|
-
Copyright 2014 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING
|
|
232
|
+
Copyright 2014 by Puppet Inc\., Vox Pupuli\. Apache 2 license; see COPYING
|
data/man/man8/puppet-facts.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-FACTS" "8" "
|
|
3
|
+
.TH "PUPPET\-FACTS" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-facts\fR \- Retrieve and store facts\.
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -10,7 +10,7 @@ This subcommand manages facts, which are collections of normalized system inform
|
|
|
10
10
|
.SH "OPTIONS"
|
|
11
11
|
Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
|
|
12
12
|
.P
|
|
13
|
-
See the configuration file documentation at \fIhttps://
|
|
13
|
+
See the configuration file documentation at \fIhttps://docs\.openvoxproject\.org/openvox/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
|
14
14
|
.TP
|
|
15
15
|
\-\-render\-as FORMAT
|
|
16
16
|
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
|
@@ -22,9 +22,9 @@ Whether to log verbosely\.
|
|
|
22
22
|
Whether to log debug information\.
|
|
23
23
|
.TP
|
|
24
24
|
\-\-terminus _TERMINUS
|
|
25
|
-
Indirector faces expose indirected subsystems of
|
|
25
|
+
Indirector faces expose indirected subsystems of OpenVox\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In OpenVox parlance, these backends are called terminuses\.
|
|
26
26
|
.IP
|
|
27
|
-
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the
|
|
27
|
+
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the OpenVox server's data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the OpenVox server whenever it receives a remote request\.
|
|
28
28
|
.IP
|
|
29
29
|
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face's manpage for more details\.
|
|
30
30
|
.SH "ACTIONS"
|
|
@@ -75,7 +75,7 @@ puppet facts [\-\-terminus _TERMINUS] [\-\-config\-file \fIpath\fR] [\-\-custom\
|
|
|
75
75
|
.IP
|
|
76
76
|
Reads facts from the local system using \fBfacter\fR terminus\. A query can be provided to retrieve just a specific fact or a set of facts\.
|
|
77
77
|
.IP
|
|
78
|
-
\fBOPTIONS\fR \fI\-\-config\-file <path\fR> \- The location of the config file for
|
|
78
|
+
\fBOPTIONS\fR \fI\-\-config\-file <path\fR> \- The location of the config file for OpenFact\.
|
|
79
79
|
.IP
|
|
80
80
|
\fI\-\-custom\-dir <path\fR> \- The path to a directory that contains custom facts\.
|
|
81
81
|
.IP
|
|
@@ -97,7 +97,7 @@ The output of facter with added puppet specific facts\.
|
|
|
97
97
|
.IP
|
|
98
98
|
\fBNOTES\fR
|
|
99
99
|
.TP
|
|
100
|
-
\fBupload\fR \- Upload local facts to the
|
|
100
|
+
\fBupload\fR \- Upload local facts to the OpenVox server\.
|
|
101
101
|
\fBSYNOPSIS\fR
|
|
102
102
|
.IP
|
|
103
103
|
puppet facts upload [\-\-terminus _TERMINUS]
|
|
@@ -112,11 +112,11 @@ Nothing\.
|
|
|
112
112
|
.IP
|
|
113
113
|
\fBNOTES\fR
|
|
114
114
|
.IP
|
|
115
|
-
This action requires that the
|
|
115
|
+
This action requires that the OpenVox Server's \fBauth\.conf\fR file allow \fBPUT\fR or \fBsave\fR access to the \fB/puppet/v3/facts\fR API endpoint\.
|
|
116
116
|
.IP
|
|
117
|
-
For details on configuring
|
|
117
|
+
For details on configuring OpenVox Server's \fBauth\.conf\fR, see:
|
|
118
118
|
.IP
|
|
119
|
-
\fIhttps://
|
|
119
|
+
\fIhttps://docs\.openvoxproject\.org/openvox\-server/latest/config_file_auth\.html\fR
|
|
120
120
|
.SH "EXAMPLES"
|
|
121
121
|
\fBfind\fR
|
|
122
122
|
.P
|
|
@@ -136,7 +136,7 @@ Upload facts:
|
|
|
136
136
|
.P
|
|
137
137
|
$ puppet facts upload
|
|
138
138
|
.SH "NOTES"
|
|
139
|
-
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of
|
|
139
|
+
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of OpenVox\. Valid termini for this face include:
|
|
140
140
|
.IP "\(bu" 4
|
|
141
141
|
\fBfacter\fR
|
|
142
142
|
.IP "\(bu" 4
|
|
@@ -153,4 +153,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
|
|
|
153
153
|
\fByaml\fR
|
|
154
154
|
.IP "" 0
|
|
155
155
|
.SH "COPYRIGHT AND LICENSE"
|
|
156
|
-
Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING
|
|
156
|
+
Copyright 2011 by Puppet Inc\., Vox Pupuli\. Apache 2 license; see COPYING
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-FILEBUCKET" "8" "
|
|
3
|
+
.TH "PUPPET\-FILEBUCKET" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-filebucket\fR \- Store and retrieve files in an OpenVox filebucket
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -22,7 +22,7 @@ list: List all files in the current local filebucket\. Listing remote filebucket
|
|
|
22
22
|
.SH "DESCRIPTION"
|
|
23
23
|
This is a stand\-alone filebucket client for sending files to a local or central filebucket\.
|
|
24
24
|
.P
|
|
25
|
-
Note that 'filebucket' defaults to using a network\-based filebucket available on the server named 'puppet'\. To use this, you'll have to be running as a user with valid
|
|
25
|
+
Note that 'filebucket' defaults to using a network\-based filebucket available on the server named 'puppet'\. To use this, you'll have to be running as a user with valid OpenVox certificates\. Alternatively, you can use your local file bucket by specifying '\-\-local', or by specifying '\-\-bucket' with a local path\.
|
|
26
26
|
.P
|
|
27
27
|
\fBImportant\fR: When you enable and use the backup option, and by extension the filebucket resource, you must ensure that sufficient disk space is available for the file backups\. Generally, you can provide the disk space by using one of the following two options:
|
|
28
28
|
.IP "\(bu" 4
|
|
@@ -39,7 +39,7 @@ Restrict the directory to a maximum size after which the oldest items are remove
|
|
|
39
39
|
.SH "OPTIONS"
|
|
40
40
|
Note that any setting that's valid in the configuration file is also a valid long argument\. For example, 'ssldir' is a valid setting, so you can specify '\-\-ssldir \fIdirectory\fR' as an argument\.
|
|
41
41
|
.P
|
|
42
|
-
See the configuration file documentation at https://
|
|
42
|
+
See the configuration file documentation at https://docs\.openvoxproject\.org/openvox/latest/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with '\-\-genconfig'\.
|
|
43
43
|
.TP
|
|
44
44
|
\-\-bucket
|
|
45
45
|
Specify a local filebucket path\. This overrides the default path set in '$clientbucketdir'\.
|
|
@@ -123,7 +123,7 @@ $ puppet filebucket \-b /tmp/TestBucket backup /tmp/TestFile2
|
|
|
123
123
|
$ puppet filebucket \-b /tmp/TestBucket list
|
|
124
124
|
d41d8cd98f00b204e9800998ecf8427e 2015\-05\-11 09:33:22 /tmp/TestFile2
|
|
125
125
|
|
|
126
|
-
## From
|
|
126
|
+
## From an OpenVox Server, list files in the server bucketdir
|
|
127
127
|
$ puppet filebucket \-b $(puppet config print bucketdir \-\-section server) list
|
|
128
128
|
d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
|
|
129
129
|
7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
|
|
@@ -131,4 +131,4 @@ d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
|
|
|
131
131
|
.SH "AUTHOR"
|
|
132
132
|
Luke Kanies
|
|
133
133
|
.SH "COPYRIGHT"
|
|
134
|
-
Copyright (c) 2011 Puppet Inc
|
|
134
|
+
Copyright (c) 2011 Puppet Inc\.; Copyright (c) 2024 Vox Pupuli\. Licensed under the Apache 2\.0 License
|
data/man/man8/puppet-generate.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-GENERATE" "8" "
|
|
3
|
+
.TH "PUPPET\-GENERATE" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-generate\fR \- Generates Puppet code from Ruby definitions\.
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -8,7 +8,7 @@ puppet generate \fIaction\fR
|
|
|
8
8
|
.SH "OPTIONS"
|
|
9
9
|
Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
|
|
10
10
|
.P
|
|
11
|
-
See the configuration file documentation at \fIhttps://
|
|
11
|
+
See the configuration file documentation at \fIhttps://docs\.openvoxproject\.org/openvox/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
|
12
12
|
.TP
|
|
13
13
|
\-\-render\-as FORMAT
|
|
14
14
|
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
|
@@ -51,4 +51,4 @@ $ puppet generate types \-\-environment development
|
|
|
51
51
|
.fi
|
|
52
52
|
.IP "" 0
|
|
53
53
|
.SH "COPYRIGHT AND LICENSE"
|
|
54
|
-
Copyright 2016 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING
|
|
54
|
+
Copyright 2016 by Puppet Inc\., Vox Pupuli\. Apache 2 license; see COPYING
|
data/man/man8/puppet-help.8
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.10.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
|
|
3
|
-
.TH "PUPPET\-HELP" "8" "
|
|
3
|
+
.TH "PUPPET\-HELP" "8" "August 2026" "Vox Pupuli" "OpenVox manual"
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBpuppet\-help\fR \- Display OpenVox help\.
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -8,7 +8,7 @@ puppet help \fIaction\fR
|
|
|
8
8
|
.SH "OPTIONS"
|
|
9
9
|
Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
|
|
10
10
|
.P
|
|
11
|
-
See the configuration file documentation at \fIhttps://
|
|
11
|
+
See the configuration file documentation at \fIhttps://docs\.openvoxproject\.org/openvox/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
|
12
12
|
.TP
|
|
13
13
|
\-\-render\-as FORMAT
|
|
14
14
|
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
|
@@ -43,4 +43,4 @@ Get help for an action:
|
|
|
43
43
|
.P
|
|
44
44
|
$ puppet help
|
|
45
45
|
.SH "COPYRIGHT AND LICENSE"
|
|
46
|
-
Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING
|
|
46
|
+
Copyright 2011 by Puppet Inc\., Vox Pupuli\. Apache 2 license; see COPYING
|