Add OpenVox support

This adds a fact that discovers if the Perforce or OpenVox agent is
installed. If none are installed yet, we default to the Perforce package
for backwards compatibility.

Author: binford2k

README.md

@@ -56,10 +56,8 @@ Then the `foreman_ssl_{ca,cert,key}` parameters are ignored and `certs::puppet`
 
 ## PuppetDB integration
 
-The Puppet server can be configured to export catalogs and reports to a
-PuppetDB instance, using the puppetlabs/puppetdb module.  Use its
-`puppetdb::server` class to install the PuppetDB server and this module to
-configure the Puppet server to connect to PuppetDB.
+The Puppet server can be configured to export catalogs and reports to a PuppetDB instance, using the puppetlabs/puppetdb module.
+Use its `puppetdb::server` class to install the PuppetDB server and this module to configure the Puppet server to connect to PuppetDB.
 
 Requires [puppetlabs/puppetdb](https://forge.puppetlabs.com/puppetlabs/puppetdb)
 
@@ -74,8 +72,9 @@ class { 'puppet::server::puppetdb':
 }
 ```
 
-Above example manages Puppetserver + PuppetDB integration. It won't install the
-PuppetDB. To do so, you also need the `puppetdb` class
+Above example manages Puppetserver + PuppetDB integration.
+It won't install the PuppetDB.
+To do so, you also need the `puppetdb` class
 
 ```puppet
 class { 'puppet':
@@ -115,15 +114,33 @@ class { 'puppet::server::puppetdb':
 }
 ```
 
-Above code will install Puppetserver/PuppetDB/PostgreSQL on a single server. It
-will use the upstream postgresql repositories. It was tested on Ubuntu.
+Above code will install Puppetserver/PuppetDB/PostgreSQL on a single server.
+It will use the upstream postgresql repositories.
+It was tested on Ubuntu.
 
 Please also make sure your puppetdb ciphers are compatible with your puppet server ciphers, ie that the two following parameters match:
+
 ```
 puppet::server::cipher_suites
 puppetdb::server::cipher_suites
 ```
 
+By default, the Perforce packages are used.
+[Since November 2024, they don't receive updates anymore](https://www.puppet.com/blog/open-source-puppet-updates-2025).
+To use the new [OpenVoxProject packages](https://voxpupuli.org/openvox/), update the package names:
+
+```yaml
+---
+puppet::client_package: openvox-agent
+puppet::server_package: openvox-server
+puppetdb::puppetdb_package: openvoxdb
+puppetdb::master::config::terminus_package: openvoxdb-termini
+```
+
+If you replace the Perforce agent or server packages and switch to the OpenVox implementation by hand, without setting anything in Hiera, the module will detect this and just keeps working, no changes required.
+
+Further installation instructions are also documented on the [OpenVox project page](https://voxpupuli.org/openvox/install/).
+
 # Installation
 
 Available from GitHub (via cloning or tarball), [Puppet Forge](https://forge.puppetlabs.com/theforeman/puppet)

manifests/init.pp

@@ -707,7 +707,7 @@
   Boolean $server_ssl_key_manage = $puppet::params::server_ssl_key_manage,
   Array[String] $server_ssl_protocols = $puppet::params::server_ssl_protocols,
   Optional[Stdlib::Absolutepath] $server_ssl_chain_filepath = $puppet::params::server_ssl_chain_filepath,
-  Optional[Variant[String, Array[String]]] $server_package = $puppet::params::server_package,
+  Variant[String[1], Array[String[1]]] $server_package = $puppet::params::server_package,
   Optional[String] $server_version = $puppet::params::server_version,
   String $server_certname = $puppet::params::server_certname,
   Integer[0] $server_request_timeout = $puppet::params::server_request_timeout,

manifests/params.pp

@@ -265,22 +265,25 @@
 
   $puppet_major = regsubst($facts['puppetversion'], '^(\d+)\..*$', '\1')
 
-  if ($facts['os']['family'] =~ /(FreeBSD|DragonFly)/) {
-    $server_package = "puppetserver${puppet_major}"
+  # Add support for OpenVox. Default to puppet if nothing is installed yet
+  $puppet_implementation       = pick($facts['implementation'], 'puppet')
+  $puppetserver_implementation = bool2str($puppet_implementation == 'openvox', 'openvox-server', 'puppetserver')
+
+  $server_package = if ($facts['os']['family'] =~ /(FreeBSD|DragonFly)/) {
+    "${puppetserver_implementation}${puppet_major}"
   } else {
-    $server_package = undef
+    $puppetserver_implementation
   }
 
   $server_ssl_dir = $ssldir
   $server_version = undef
 
-  if $aio_package or
-  ($facts['os']['name'] == 'Debian' and versioncmp($facts['os']['release']['major'], '12') >= 0) {
-    $client_package = ['puppet-agent']
+  $client_package = if $aio_package or ($facts['os']['name'] == 'Debian' and versioncmp($facts['os']['release']['major'], '12') >= 0) {
+    ["${puppet_implementation}-agent"]
   } elsif ($facts['os']['family'] =~ /(FreeBSD|DragonFly)/) {
-    $client_package = ["puppet${puppet_major}"]
+    ["${puppet_implementation}${puppet_major}"]
   } else {
-    $client_package = ['puppet']
+    [$puppet_implementation]
   }
 
   # Puppet service name

manifests/server.pp

@@ -405,7 +405,7 @@
   Boolean $ssl_key_manage = $puppet::server_ssl_key_manage,
   Array[String] $ssl_protocols = $puppet::server_ssl_protocols,
   Optional[Stdlib::Absolutepath] $ssl_chain_filepath = $puppet::server_ssl_chain_filepath,
-  Optional[Variant[String, Array[String]]] $package = $puppet::server_package,
+  Variant[String[1], Array[String[1]]] $package = $puppet::server_package,
   Optional[String] $version = $puppet::server_version,
   String $certname = $puppet::server_certname,
   Integer[0] $request_timeout = $puppet::server_request_timeout,

manifests/server/install.pp

@@ -33,7 +33,7 @@
   }
 
   if $puppet::manage_packages == true or $puppet::manage_packages == 'server' {
-    $server_package = pick($puppet::server::package, 'puppetserver')
+    $server_package = $puppet::server::package
     $server_version = pick($puppet::server::version, $puppet::version)
 
     package { $server_package:

manifests/server/puppetserver.pp

@@ -152,8 +152,6 @@
   # We need a method to determine what version is installed.
   $real_puppetserver_version = pick($puppetserver_version, '8.0.0')
 
-  $puppetserver_package = pick($puppet::server::package, 'puppetserver')
-
   if $java_bin {
     $_java_bin = $java_bin
   } else {

metadata.json

@@ -36,6 +36,10 @@
     {
       "name": "puppet",
       "version_requirement": ">= 8.0.0 < 9.0.0"
+    },
+    {
+      "name": "openvox",
+      "version_requirement": ">= 8.23.1 < 9.0.0"
     }
   ],
   "operatingsystem_support": [

spec/classes/puppet_init_spec.rb

@@ -10,21 +10,25 @@
         puppet_concat    = '/usr/local/etc/puppet/puppet.conf'
         puppet_directory = '/usr/local/etc/puppet'
         puppet_package   = "puppet#{puppet_major}"
+        openvox_package  = "openvox#{puppet_major}"
         puppetconf_mode  = '0644'
       when 'windows'
         puppet_concat    = 'C:/ProgramData/PuppetLabs/puppet/etc/puppet.conf'
         puppet_directory = 'C:/ProgramData/PuppetLabs/puppet/etc'
         puppet_package   = 'puppet-agent'
+        openvox_package  = 'openvox-agent'
         puppetconf_mode  = '0674'
       when 'Archlinux'
         puppet_concat    = '/etc/puppetlabs/puppet/puppet.conf'
         puppet_directory = '/etc/puppetlabs/puppet'
         puppet_package   = 'puppet'
+        openvox_package  = 'openvox'
         puppetconf_mode  = '0644'
       else
         puppet_concat    = '/etc/puppetlabs/puppet/puppet.conf'
         puppet_directory = '/etc/puppetlabs/puppet'
         puppet_package   = 'puppet-agent'
+        openvox_package  = 'openvox-agent'
         puppetconf_mode  = '0644'
       end
 
@@ -45,6 +49,27 @@
         }
       end
 
+      describe 'with already installed packages' do
+        describe 'legacy Perforce opensource packages' do
+          let :facts do
+            facts.merge(implementation: 'puppet')
+          end
+          it { should contain_package(puppet_package)
+            .with_ensure('present')
+            .with_install_options(nil)
+          }
+        end
+        describe 'OpenVox packages' do
+          let :facts do
+            facts.merge(implementation: 'openvox')
+          end
+          it { should contain_package(openvox_package)
+            .with_ensure('present')
+            .with_install_options(nil)
+          }
+        end
+      end
+
       describe 'with server => true', :unless => unsupported_puppetserver_osfamily(facts[:os]['family']) do
         let :params do {
           :server => true,