Skip to content

Releases: cvquesty/voxdocs

v2.0.5 - Alignment with official OpenVox documentation project

04 May 14:20

Choose a tag to compare

Alignment pass against the official OpenVox documentation project

Reviewed and synthesized content from the official OpenVox documentation (github.com/OpenVoxProject/openvox-docs) into VoxDocs.

Version updates

  • OpenVoxDB version updated from "8.x" to 8.8.1
  • Added Ruby 3.2.11 / OpenSSL 3.0.20 component details for openvox-agent 8.26.2

Platform support

  • Added full Supported Platforms table from openvox-docs system requirements (RHEL 7-10, SLES 15-16, Debian 10-13, Ubuntu 18.04-26.04, Fedora 36-43, Windows, macOS, plus unofficial platforms)

PDK alternatives

  • Replaced bare PDK section with "PDK and Open-Source Alternatives" noting PDK 3.4.0 was the last OSS version; documented VoxBox (Vox Pupuli container) and jig (Go-based reimplementation)

Copyright and licensing

  • Updated "A Note on Copyright & Originality" to reference openvox-docs as a source (CC BY-SA 3.0, copyright Puppet, Inc.)
  • Added Attribution subsection to License section with proper credit
  • Updated AGENTS.md copyright policy to permit referencing openvox-docs for factual data

Full Changelog: v2.0.0...v2.0.5

VoxDocs 2.0.0 — OpenVox Project Alignment

27 Apr 14:14

Choose a tag to compare

VoxDocs 2.0.0 — OpenVox Project Alignment

VoxDocs 2.0 brings the community documentation into alignment with the official OpenVox documentation project and the platform's current state on RHEL 9.7.

Why a Major Version?

The conceptual framing of the project has shifted enough that returning readers will encounter new terminology and a restructured introduction:

  • The OpenVox team has rebranded several core components. Facter is now OpenFact, PuppetDB is now OpenVoxDB, and Bolt is now OpenBolt. Binary names (facter, puppetdb, bolt) and config files (facter.conf) are unchanged — only project/package names changed.
  • The official origin story has been refined. It now credits Overlook InfraTech for stepping in with community packaging when Perforce discontinued public distribution of open-source Puppet in late 2024, before Vox Pupuli adopted the project.
  • A Puppet Standards Steering Committee now guides language and feature evolution.
  • The documented package set has expanded to include openvoxdb, openvoxdb-termini, and openbolt as first-class members.

No documentation files were removed. Users on v1.x can continue using v1.1.0 as a snapshot reference.

Highlights

Version bumps (all verified against the live RHEL 9.7 lab)

Component v1.x v2.0.0
openvox-agent 8.25.0 8.26.2
OpenVox Server 8.12.1 8.12.1 (unchanged)
OpenFact (was Facter) 5.4.0 5.6.0
OpenBolt (was Bolt) 5.3.0 5.4.0
r10k 5.0.2 5.0.2 (unchanged)

New & expanded sections

  • README — new "A Brief History" section covering the Perforce → Overlook InfraTech → Vox Pupuli timeline; expanded versions table with package paths; Windows / macOS download URLs; links to the official Installing OpenVox and Support pages and the official docs repo.
  • Getting Started — new "Windows and macOS Agents" subsection; new "Full OpenVox Package Set" subsection covering openvox-agent, openvox-server, openvoxdb, openvoxdb-termini, openbolt; verification snippets for OpenFact and PuppetServer.
  • Migration Guide — new "Two migration paths" callout (Puppet 7 → OpenVox 7 → OpenVox 8 vs. Puppet 7 → Puppet 8 → OpenVox 8); new "Upgrade Order" subsection (server → openvoxdb → termini → agent); explicit warning that Puppet and OpenVox cannot coexist on the same host.
  • Architecture — branding callouts in the PuppetDB and Facter sections explaining the OpenVoxDB / OpenFact rename; OpenFact, OpenVoxDB, and OpenBolt added to the glossary.
  • CLI Reference — version banner now enumerates the actual lab package set; refreshed puppet --help, puppet --version, bolt --version, and facter --version captures from the live lab; OpenVoxDB row added to the Server & Infrastructure table.
  • Server Admin — PostgreSQL recommendation bumped to PostgreSQL 14+ (still requires 11+) with PGDG repo links, matching official OpenVoxDB 8 guidance.
  • Troubleshooting — new FAQ entry for the cosmetic puppet --version reporting bug in OpenVox 8.26.2 (OpenVoxProject/openvox#415).
  • Community — acknowledgments expanded to call out Overlook InfraTech's role and the Puppet Standards Steering Committee.
  • Orchestrationopenbolt documented as the preferred package name alongside the legacy puppet-bolt.

Known issue documented

OpenVox 8.26.2 has a cosmetic bug where puppet --version reports 8.26.1. The agent itself is at the correct version — this affects the version string only. Tracked at OpenVoxProject/openvox#415. Verify the real package version with rpm -q openvox-agent or dpkg -l openvox-agent.

Diff stats

14 files changed, +218 / -27.

License

CC BY-SA 4.0. Original community-written work; no Perforce/Puppet documentation copied. All CLI output captured from a live RHEL 9.7 OpenVox lab.


Built with coffee, sudo access, and mild frustration by the community.

v1.1.0 — Sanitized & GitHub Release

27 Mar 19:52

Choose a tag to compare

VoxDocs reaches GitHub! This release contains the complete OpenVox community documentation, sanitized for public consumption.

What's Included

  • 🚀 Getting Started — Installation, first manifest, agent-server setup
  • 🏗️ Architecture — Components, data flow, environments, modules
  • 📝 Language Reference — 14 topic pages covering the full Puppet DSL
  • ⌨️ CLI Reference — 16 command pages with real output
  • ⚙️ Configuration — puppet.conf, hiera.yaml, all settings
  • 🖥️ Server Administration — PuppetServer, PuppetDB, CA management
  • 📚 Hiera Deep-Dive — Hierarchies, merge strategies, eyaml
  • 📦 Module Development — Roles/profiles, testing, publishing
  • 🎯 Orchestration — Bolt, r10k, tasks and plans
  • 🔧 Troubleshooting — Common issues and solutions
  • 🤝 Community — Contributing, resources, support

This Release

  • All personal info removed (domain, username, hardware details)
  • Published to github.com/cvquesty/voxdocs
  • 46 files, 7343 lines of documentation
  • CC BY-SA 4.0 licensed

What's New

  • Sanitized: all questy.orgexample.com
  • No personal hardware specs exposed
  • Ready for public consumption

Links

v1.0.0 — First Stable Release 🎉

12 Mar 18:21

Choose a tag to compare

VoxDocs 1.0.0 — First Stable Release! 🎉

The OpenVox community documentation is now production-ready.


📚 Complete Documentation Coverage

Section Description
🚀 Getting Started Installation, first manifest, agent-server setup, migration guide
🏗️ Architecture Components, data flow, environments, module system
📝 Language Reference 14 topic pages covering the full Puppet DSL
⌨️ CLI Reference 16 command pages with real output from live infrastructure
⚙️ Configuration puppet.conf, hiera.yaml, all settings
🖥️ Server Administration PuppetServer, PuppetDB, CA management
📚 Hiera Deep-Dive Hierarchies, merge strategies, eyaml encryption
📦 Module Development Roles/profiles, testing, linting, publishing
🎯 Orchestration Bolt, r10k, tasks and plans
🔧 Troubleshooting Common issues and solutions
🤝 Community Contributing, resources, support channels

🔄 Migration Guide (New in 0.97.0)

Complete guide for migrating from Puppet 7 to OpenVox 8:

  • Strict modestrict_variables=true is now default
  • Legacy facts removed — Complete conversion table (20+ facts)
  • Hiera 3 functions removedhiera()lookup() migration
  • Ruby 3.2.x and OpenSSL 3.0 compatibility
  • Package migration — Step-by-step for RHEL and Debian
  • Migration checklist — Don't miss anything!

✅ Technical Verification

All content reviewed against:

  • 📖 Official Puppet 8.10.0 documentation (52,477 lines)
  • 📘 Puppet Best Practices by Chris Barbour
  • 📗 Puppet 8 for DevOps Engineers by David Sandilands

🛠️ Tools Integration

  • openvox-lint — Community linter for style guide, legacy facts, Hiera 3 deprecation
  • openvox-gui — Web management UI

📄 License

This documentation is released under CC BY-SA 4.0.


Built by the community, for the community. 🦊

v0.97.0 - Migration Guide & Expanded Functions

12 Mar 18:18

Choose a tag to compare

What's New

🔄 Migration Guide (New!)

A comprehensive guide for migrating from Puppet 7 to OpenVox 8:

  • Strict modestrict_variables=true is now default
  • Legacy facts removed — Complete conversion table (20+ facts)
  • Hiera 3 functions removedhiera()lookup() migration guide
  • Ruby 3.2.x and OpenSSL 3.0 compatibility notes
  • Package migration — Step-by-step for RHEL and Debian
  • Migration checklist — Don't miss anything!

📄 Read the Migration Guide

📚 Expanded Functions Reference

The language/functions.md has been significantly expanded from 42 to 192 lines:

  • String Functions (case transformation, whitespace, search/replace)
  • Array Functions (unique, flatten, sort, slice)
  • Hash Functions (merge, keys, values, dig)
  • Hiera Lookuplookup() signatures and merge strategies
  • ⚠️ Deprecation warning for hiera(), hiera_array(), hiera_hash()
  • Type Checking and assertion
  • Conditional functions (pick, lest, then)
  • Utility functions (epp, include, contain, fail)

🔍 openvox-lint Integration

Added documentation for openvox-lint in the Module Development guide:

gem install openvox-lint
openvox-lint .

Technical Note: All content reviewed against official Puppet 8.10.0 documentation (52,477 lines), Puppet Best Practices (Chris Barbour), and Puppet 8 for DevOps Engineers (David Sandilands).