From 8274b629eb2251756fda9131b2f6fcee73020837 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 15 Jan 2025 14:59:27 -0800 Subject: [PATCH 1/3] Update the install instructions for the new packages The `openvox-server` and `openvox-db` packages haven't been published yet, but they should be very shortly. --- openvox/install.md | 51 ++++++++++++++++++++++++++++++++++------------ 1 file changed, 38 insertions(+), 13 deletions(-) diff --git a/openvox/install.md b/openvox/install.md index 30c93cd..29f1aad 100644 --- a/openvox/install.md +++ b/openvox/install.md @@ -5,16 +5,40 @@ subsection: openvox --- OpenVox package downloads are currently sponsored by [Overlook InfraTech](https://overlookinfratech.com). -Following Perforce's suggestions, these are straight rebuilds of the original packages with no branding or name changes. -Be aware that this will change as soon as the OpenVox pipelines are running. +As of release 8.11, OpenVox is functionally equivalent to Puppet; the command names are the same, the configuration file paths are the same, etc. +The major differences are in help text output, man pages, and so on. +This means that you can continue to use all the commands, modules, tooling, etc that you're used to, but at this time *you cannot install both Puppet and OpenVox on the same system*. + +🚨 Before you enable and install the packages, be forewarned that these are still experimental packages only. +We do not yet have a fully robust test pipeline, although that is our next priority. + + +## Uninstalling Puppet + +We encourage you to try out OpenVox on a fresh test system, the way you would for any major system package. +If you'd rather try it on an existing system or develop a migration process, then you will first have to uninstall Puppet. + +* If you're migrating from Puppet Enterprise you can use the `puppet-enterprise-uninstaller` script on each node as described in [their docs](https://www.puppet.com/docs/pe/latest/uninstalling.html). +* If you're using the all-in-one packages such as `puppet-agent` or `puppetserver` from the `[apt|yum].puppet.com` repos, simply remove these packages. +* If you're using distro provided packages, then you might have a bigger job. + For example, if you're using Debian packages, you may have several Puppet modules packaged as `.deb` packages that you'll have to move to your `Puppetfile`. + You might consider waiting until your distro packages OpenVox. + * If you do want to migrate now, then remove any puppet packages and dependencies you have installed using your distro tools. + * Debian family + * `apt autoremove ` + * RedHat family + * `yum autoremove ` + * You might also consider (carefully) cleaning up unused dependencies afterwards by running `apt` or `yum` autoremove without a package name. + +You do not need to purge the configuration files because OpenVox will continue to use them unchanged. +However, you should consider making backups. +Likewise, you do not need to remove the `[apt|yum].puppet.com` repositories although the only thing you'll be able to use them for going forward is installing historical Puppet releases. -🚨 Before you enable and install the packages, be forewarned that these are preliminary kick-the-tires packages only. -We do not yet have a fully robust test pipeline, although with the community interest that will be forthcoming. ## Installation First enable the repository, based on your Linux distribution. -Choose the appropriate repo package from either of these locations and install it. +Choose the appropriate `openvox8-release` repo package from either of these locations and install it. * Debian family: * [https://apt.overlookinfratech.com](https://apt.overlookinfratech.com) @@ -23,14 +47,15 @@ Choose the appropriate repo package from either of these locations and install i Then install the packages you want. -* Debian - * `apt install puppet-agent` - * `apt install puppetserver` - * `apt install puppetdb` -* RedHat - * `yum install puppet-agent` - * `yum install puppetserver` - * `yum install puppetdb` +* Debian family + * `apt install openvox-agent` + * `apt install openvox-server` + * `apt install openvox-db` +* RedHat family + * `yum install openvox-agent` + * `yum install openvox-server` + * `yum install openvox-db` + ### Sponsorship From 8f792e2cec56c453ca85d6d841ebfe466749942b Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Wed, 15 Jan 2025 15:47:35 -0800 Subject: [PATCH 2/3] addressing reviews --- openvox/install.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/openvox/install.md b/openvox/install.md index 29f1aad..b277653 100644 --- a/openvox/install.md +++ b/openvox/install.md @@ -18,6 +18,9 @@ We do not yet have a fully robust test pipeline, although that is our next prior We encourage you to try out OpenVox on a fresh test system, the way you would for any major system package. If you'd rather try it on an existing system or develop a migration process, then you will first have to uninstall Puppet. +You do not need to purge configuration files because OpenVox will continue to use them as they are. +However, **before getting started on the migration you should strongly consider backing up the entire `/etc/puppetlabs/` tree** in case of accidents. + * If you're migrating from Puppet Enterprise you can use the `puppet-enterprise-uninstaller` script on each node as described in [their docs](https://www.puppet.com/docs/pe/latest/uninstalling.html). * If you're using the all-in-one packages such as `puppet-agent` or `puppetserver` from the `[apt|yum].puppet.com` repos, simply remove these packages. * If you're using distro provided packages, then you might have a bigger job. @@ -30,9 +33,7 @@ If you'd rather try it on an existing system or develop a migration process, the * `yum autoremove ` * You might also consider (carefully) cleaning up unused dependencies afterwards by running `apt` or `yum` autoremove without a package name. -You do not need to purge the configuration files because OpenVox will continue to use them unchanged. -However, you should consider making backups. -Likewise, you do not need to remove the `[apt|yum].puppet.com` repositories although the only thing you'll be able to use them for going forward is installing historical Puppet releases. +You do not need to remove the `[apt|yum].puppet.com` repositories although the only thing you'll be able to use them for going forward is installing historical Puppet releases. ## Installation @@ -56,6 +57,7 @@ Then install the packages you want. * `yum install openvox-server` * `yum install openvox-db` +If you have backed up config files, then restore them now. ### Sponsorship From 98bdad394d5f1859c4fa6a3ec4b7207538941904 Mon Sep 17 00:00:00 2001 From: Ben Ford Date: Thu, 16 Jan 2025 15:31:35 -0800 Subject: [PATCH 3/3] correct package name --- openvox/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openvox/install.md b/openvox/install.md index b277653..7352abd 100644 --- a/openvox/install.md +++ b/openvox/install.md @@ -51,11 +51,11 @@ Then install the packages you want. * Debian family * `apt install openvox-agent` * `apt install openvox-server` - * `apt install openvox-db` + * `apt install openvoxdb` * RedHat family * `yum install openvox-agent` * `yum install openvox-server` - * `yum install openvox-db` + * `yum install openvoxdb` If you have backed up config files, then restore them now.