openvox 7.37.1 → 8.19.0

data/man/man8/puppet-resource.8

@@ -1,88 +1,63 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-RESOURCE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-RESOURCE" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
 .SH "NAME"
-\fBpuppet\-resource\fR \- The resource abstraction layer shell
-.
+\fBpuppet\-resource\fR \- The OpenVox resource abstraction layer shell
 .SH "SYNOPSIS"
-Uses the Puppet RAL to directly interact with the system\.
-.
+Uses the OpenVox RAL to directly interact with the system\.
 .SH "USAGE"
-puppet resource [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-p|\-\-param \fIparameter\fR] [\-t|\-\-types] [\-y|\-\-to_yaml] \fItype\fR [\fIname\fR] [\fIattribute\fR=\fIvalue\fR \.\.\.]
-.
+puppet resource [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-p|\-\-param \fIparameter\fR] [\-t|\-\-types] [\-y|\-\-to_yaml] \fItype\fR [\fIname\fR] [\fIattribute\fR=\fIvalue\fR \|\.\|\.\|\.]
 .SH "DESCRIPTION"
-This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current state using Puppet\'s RAL\.
-.
+This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current state using Puppet's RAL\.
 .P
 By default, you must at least provide a type to list, in which case puppet resource will tell you everything it knows about all resources of that type\. You can optionally specify an instance name, and puppet resource will only describe that single instance\.
-.
 .P
-If given a type, a name, and a series of \fIattribute\fR=\fIvalue\fR pairs, puppet resource will modify the state of the specified resource\. Alternately, if given a type, a name, and the \'\-\-edit\' flag, puppet resource will write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction\.
-.
+If given a type, a name, and a series of \fIattribute\fR=\fIvalue\fR pairs, puppet resource will modify the state of the specified resource\. Alternately, if given a type, a name, and the '\-\-edit' flag, puppet resource will write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction\.
 .SH "OPTIONS"
-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\.
-.
+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\.
 .P
-See the configuration file documentation at https://puppet\.com/docs/puppet/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\'\.
-.
+See the configuration file documentation at https://puppet\.com/docs/puppet/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'\.
 .TP
 \-\-debug
 Enable full debugging\.
-.
 .TP
 \-\-edit
 Write the results of the query to a file, open the file in an editor, and read the file back in as an executable Puppet manifest\.
-.
 .TP
 \-\-help
 Print this help message\.
-.
 .TP
 \-\-param
 Add more parameters to be outputted from queries\.
-.
 .TP
 \-\-types
 List all available types\.
-.
 .TP
 \-\-verbose
 Print extra information\.
-.
 .TP
 \-\-to_yaml
 Output found resources in yaml format, suitable to use with Hiera and create_resources\.
-.
 .TP
 \-\-fail
 Fails and returns an exit code of 1 if the resource could not be modified\.
-.
 .SH "EXAMPLE"
 This example uses \fBpuppet resource\fR to return a Puppet configuration for the user \fBluke\fR:
-.
 .IP "" 4
-.
 .nf
-
 $ puppet resource user luke
-user { \'luke\':
- home => \'/home/luke\',
- uid => \'100\',
- ensure => \'present\',
- comment => \'Luke Kanies,,,\',
- gid => \'1000\',
- shell => \'/bin/bash\',
- groups => [\'sysadmin\',\'audio\',\'video\',\'puppet\']
+user { 'luke':
+ home => '/home/luke',
+ uid => '100',
+ ensure => 'present',
+ comment => 'Luke Kanies,,,',
+ gid => '1000',
+ shell => '/bin/bash',
+ groups => ['sysadmin','audio','video','puppet']
 }
-.
 .fi
-.
 .IP "" 0
-.
 .SH "AUTHOR"
 Luke Kanies
-.
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-script.8

@@ -1,70 +1,48 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-SCRIPT" "8" "October 2024" "Puppet, Inc." "Puppet manual"
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-SCRIPT" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
 .SH "NAME"
 \fBpuppet\-script\fR \- Run a puppet manifests as a script without compiling a catalog
-.
 .SH "SYNOPSIS"
 Runs a puppet language script without compiling a catalog\.
-.
 .SH "USAGE"
 puppet script [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-noop] \fIfile\fR
-.
 .SH "DESCRIPTION"
 This is a standalone puppet script runner tool; use it to run puppet code without compiling a catalog\.
-.
 .P
 When provided with a modulepath, via command line or config file, puppet script can load functions, types, tasks and plans from modules\.
-.
 .SH "OPTIONS"
-Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'environment\' is a valid setting, so you can specify \'\-\-environment mytest\' as an argument\.
-.
+Note that any setting that's valid in the configuration file is also a valid long argument\. For example, 'environment' is a valid setting, so you can specify '\-\-environment mytest' as an argument\.
 .P
-See the configuration file documentation at https://puppet\.com/docs/puppet/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\'\.
-.
+See the configuration file documentation at https://puppet\.com/docs/puppet/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'\.
 .TP
 \-\-debug
 Enable full debugging\.
-.
 .TP
 \-\-help
 Print this help message
-.
 .TP
 \-\-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\. Defaults to \'console\'\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
-.
+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\. Defaults to 'console'\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
 .IP
-A path ending with \'\.json\' will receive structured output in JSON format\. The log file will not have an ending \']\' automatically written to it due to the appending nature of logging\. It must be appended manually to make the content valid JSON\.
-.
+A path ending with '\.json' will receive structured output in JSON format\. The log file will not have an ending ']' automatically written to it due to the appending nature of logging\. It must be appended manually to make the content valid JSON\.
 .IP
-A path ending with \'\.jsonl\' will receive structured output in JSON Lines format\.
-.
+A path ending with '\.jsonl' will receive structured output in JSON Lines format\.
 .TP
 \-\-noop
-Use \'noop\' mode where Puppet runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. Applies to tasks only\.
-.
+Use 'noop' mode where Puppet runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. Applies to tasks only\.
 .TP
 \-\-execute
 Execute a specific piece of Puppet code
-.
 .TP
 \-\-verbose
 Print extra information\.
-.
 .SH "EXAMPLE"
-.
 .nf
-
 $ puppet script \-l /tmp/manifest\.log manifest\.pp
-$ puppet script \-\-modulepath=/root/dev/modules \-e \'notice("hello world")\'
-.
+$ puppet script \-\-modulepath=/root/dev/modules \-e 'notice("hello world")'
 .fi
-.
 .SH "AUTHOR"
 Henrik Lindberg
-.
 .SH "COPYRIGHT"
-Copyright (c) 2017 Puppet Inc\., LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2017 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-ssl.8

@@ -1,63 +1,45 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-SSL" "8" "October 2024" "Puppet, Inc." "Puppet manual"
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-SSL" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
 .SH "NAME"
-\fBpuppet\-ssl\fR \- Manage SSL keys and certificates for puppet SSL clients
-.
+\fBpuppet\-ssl\fR \- Manage SSL keys and certificates for OpenVox SSL clients
 .SH "SYNOPSIS"
-Manage SSL keys and certificates for SSL clients needing to communicate with a puppet infrastructure\.
-.
+Manage SSL keys and certificates for clients needing to communicate with an OpenVox infrastructure\.
 .SH "USAGE"
 puppet ssl \fIaction\fR [\-h|\-\-help] [\-v|\-\-verbose] [\-d|\-\-debug] [\-\-localca] [\-\-target CERTNAME]
-.
 .SH "OPTIONS"
-.
 .IP "\(bu" 4
 \-\-help: Print this help message\.
-.
 .IP "\(bu" 4
 \-\-verbose: Print extra information\.
-.
 .IP "\(bu" 4
 \-\-debug: Enable full debugging\.
-.
 .IP "\(bu" 4
 \-\-localca Also clean the local CA certificate and CRL\.
-.
 .IP "\(bu" 4
-\-\-target CERTNAME Clean the specified device certificate instead of this host\'s certificate\.
-.
+\-\-target CERTNAME Clean the specified device certificate instead of this host's certificate\.
 .IP "" 0
-.
 .SH "ACTIONS"
-.
 .TP
 bootstrap
 Perform all of the steps necessary to request and download a client certificate\. If autosigning is disabled, then puppet will wait every \fBwaitforcert\fR seconds for its certificate to be signed\. To only attempt once and never wait, specify a time of 0\. Since \fBwaitforcert\fR is a Puppet setting, it can be specified as a time interval, such as 30s, 5m, 1h\.
-.
 .TP
 submit_request
-Generate a certificate signing request (CSR) and submit it to the CA\. If a private and public key pair already exist, they will be used to generate the CSR\. Otherwise a new key pair will be generated\. If a CSR has already been submitted with the given \fBcertname\fR, then the operation will fail\.
-.
+Generate a certificate signing request (CSR) and submit it to the CA\. If a private and public key pair already exist, they will be used to generate the CSR\. Otherwise, a new key pair will be generated\. If a CSR has already been submitted with the given \fBcertname\fR, then the operation will fail\.
 .TP
 generate_request
-Generate a certificate signing request (CSR)\. If a private and public key pair already exist, they will be used to generate the CSR\. Otherwise a new key pair will be generated\.
-.
+Generate a certificate signing request (CSR)\. If a private and public key pair exist, they will be used to generate the CSR\. Otherwise a new key pair will be generated\.
 .TP
 download_cert
 Download a certificate for this host\. If the current private key matches the downloaded certificate, then the certificate will be saved and used for subsequent requests\. If there is already an existing certificate, it will be overwritten\.
-.
 .TP
 verify
 Verify the private key and certificate are present and match, verify the certificate is issued by a trusted CA, and check revocation status\.
-.
 .TP
 clean
-Remove the private key and certificate related files for this host\. If \fB\-\-localca\fR is specified, then also remove this host\'s local copy of the CA certificate(s) and CRL bundle\. if \fB\-\-target CERTNAME\fR is specified, then remove the files for the specified device on this host instead of this host\.
-.
+Remove the private key and certificate related files for this host\. If \fB\-\-localca\fR is specified, then also remove this host's local copy of the CA certificate(s) and CRL bundle\. if \fB\-\-target CERTNAME\fR is specified, then remove the files for the specified device on this host instead of this host\.
 .TP
 show
-Print the full\-text version of this host\'s certificate\.
-
+Print the full\-text version of this host's certificate\.
+.P
+COPYRIGHT \-\-\-\-\-\- Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet.8

@@ -1,28 +1,98 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET" "8" "October 2024" "Puppet, Inc." "Puppet manual"
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
 .SH "NAME"
-\fBpuppet\fR
-.
+\fBpuppet\fR \- OpenVox is an automated configuration management tool
+.SH "SYNOPSIS"
+\fBpuppet\fR \fIsubcommand\fR [options] \fIaction\fR [options]
+.SH "DESCRIPTION"
+OpenVox is a community implementation of Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, designed to perform administrative tasks (such as adding users, installing packages, and updating server configurations) based on a centralized specification\.
+.SH "COMMANDS"
+.SS "Common"
+\fBapply\fR
+.br
+\~\~\~\~Apply Puppet manifests locally via OpenVox
+.P
+\fBagent\fR
+.br
+\~\~\~\~The puppet agent daemon provided by OpenVox
+.P
+\fBconfig\fR
+.br
+\~\~\~\~Interact with OpenVox's settings\.
+.P
+\fBhelp\fR
+.br
+\~\~\~\~Display OpenVox help\.
+.P
+\fBlookup\fR
+.br
+\~\~\~\~Interactive Hiera lookup for OpenVox
+.P
+\fBmodule\fR
+.br
+\~\~\~\~Creates, installs and searches for modules on the Puppet Forge\.
+.P
+\fBresource\fR
+.br
+\~\~\~\~The OpenVox resource abstraction layer shell
+.SS "Specialized"
+\fBstrings\fR
+.br
+\~\~\~\~Generate Puppet documentation with YARD\.
+.P
+\fBcatalog\fR
+.br
+\~\~\~\~Compile, save, view, and convert catalogs\.
+.P
+\fBdescribe\fR
+.br
+\~\~\~\~Display help about resource types available to OpenVox
 .P
-Usage: puppet \fIsubcommand\fR [options] \fIaction\fR [options]
-.
+\fBdevice\fR
+.br
+\~\~\~\~Manage remote network devices via OpenVox
 .P
-Available subcommands:
-.
+\fBdoc\fR
+.br
+\~\~\~\~Generate Puppet references for OpenVox
+.P
+\fBepp\fR
+.br
+\~\~\~\~Interact directly with the EPP template parser/renderer\.
+.P
+\fBfacts\fR
+.br
+\~\~\~\~Retrieve and store facts\.
+.P
+\fBfilebucket\fR
+.br
+\~\~\~\~Store and retrieve files in an OpenVox filebucket
+.P
+\fBgenerate\fR
+.br
+\~\~\~\~Generates Puppet code from Ruby definitions\.
+.P
+\fBnode\fR
+.br
+\~\~\~\~View and manage node definitions\.
+.P
+\fBparser\fR
+.br
+\~\~\~\~Interact directly with the parser\.
+.P
+\fBplugin\fR
+.br
+\~\~\~\~Interact with the OpenVox plugin system\.
 .P
-Common:
-.
+\fBscript\fR
 .br
-agent The puppet agent daemon apply Apply Puppet manifests locally config Interact with Puppet\'s settings\. help Display Puppet help\. lookup Interactive Hiera lookup module Creates, installs and searches for modules on the Puppet Forge\. resource The resource abstraction layer shell
-.
+\~\~\~\~Run a puppet manifests as a script without compiling a catalog
 .P
-Specialized:
-.
+\fBssl\fR
 .br
-catalog Compile, save, view, and convert catalogs\. describe Display help about resource types device Manage remote network devices doc Generate Puppet references epp Interact directly with the EPP template parser/renderer\. facts Retrieve and store facts\. filebucket Store and retrieve files in a filebucket generate Generates Puppet code from Ruby definitions\. node View and manage node definitions\. parser Interact directly with the parser\. plugin Interact with the Puppet plugin system\. script Run a puppet manifests as a script without compiling a catalog ssl Manage SSL keys and certificates for puppet SSL clients
-.
+\~\~\~\~Manage SSL keys and certificates for OpenVox SSL clients
+.SH "SEE ALSO"
+See \fBpuppet help <subcommand>\fR for help on a specific subcommand\.
 .P
-See \'puppet help \fIsubcommand\fR \fIaction\fR\' for help on a specific subcommand action\. See \'puppet help \fIsubcommand\fR\' for help on a specific subcommand\. Puppet v7\.35\.0
+See \fBpuppet help <subcommand> <action>\fR for help on a specific subcommand action\.

data/tasks/tag.rake

@@ -0,0 +1,34 @@
+namespace :vox do
+  desc 'Update version, create tag, and push to origin'
+  task :tag, [:tag] do |_, args|
+    abort 'You must provide a tag.' if args[:tag].nil? || args[:tag].empty?
+    version = args[:tag]
+    abort "#{version} does not appear to be a valid version string in x.y.z format" unless Gem::Version.correct?(version)
+
+    # Update lib/puppet/version.rb and puppet.gemspec
+    puts "Setting version to #{version}"
+    data = File.read('lib/puppet/version.rb')
+    data = data.sub(/PUPPETVERSION = '\d+\.\d+\.\d+'/, "PUPPETVERSION = '#{version}'")
+    File.write('lib/puppet/version.rb', data)
+    data = File.read('puppet.gemspec')
+    data = data.sub(/spec.version = "\d+\.\d+\.\d+"/, "spec.version = \"#{version}\"")
+    File.write('puppet.gemspec', data)
+    run_command("git add lib/puppet/version.rb && git add puppet.gemspec && git commit -m 'Set version to #{version}'")
+
+    # Run git command to get short SHA and one line description of the commit on HEAD
+    branch = run_command('git rev-parse --abbrev-ref HEAD')
+    sha = run_command('git rev-parse --short HEAD')
+    msg = run_command('git log -n 1 --pretty=%B')
+
+    puts "Branch: #{branch}"
+    puts "SHA: #{sha}"
+    puts "Commit: #{msg}"
+
+    run_command("git tag -a #{version} -m '#{version}'")
+
+    unless !ENV['NOPUSH'].nil?
+      puts "Pushing to origin"
+      run_command("git push origin && git push origin #{version}")
+    end
+  end
+end