Skip to content

OpenVox Documentation

Main Navigation OpenFact OpenVox OpenVox Server OpenVoxDB OpenBolt OpenVox Containers

Appearance

OpenFact OpenVox OpenVox Server OpenVoxDB OpenBolt OpenVox Containers

Appearance

Search documentation Esc

Return to top

Sidebar Navigation

OpenVox Ecosystem

What is OpenVox?

History

OpenVox Community

Getting Started

Whirlwind guide

Setting up a Server

Architecture and Concepts

Puppet Language intro

Orchestration

Quick Reference

Developer Tooling

Devkit Overview

Set up the DevKit

DevKit Components

Scaffolding New Content

Consistent Style

Using VoxBox in CI

Unit Testing

Publishing Modules

Managing Many Modules

Smoke Testing Your Control Repo

Impact Analysis

Acceptance Testing

Migrating From the PDK

Vox Pupuli Workflow

OpenFact

Overview

Release notes

CLI

Core Facts

Custom facts walkthrough

Overview of custom facts with examples

Configuring OpenFact with facter.conf

OpenVox 8 Platform

OpenVox release notes

OpenVox known issues

System requirements

About openvox-agent

Getting started

Getting started with OpenVox

Try OpenVox locally with crafty (experimental)

Manage a service with a module

Installing and upgrading

Overview of OpenVox's architecture

Before you begin

OpenVox repositories and packages

Install agent: Linux

Install agent: Windows

Install agent: macOS

What gets installed and where (agent)

Upgrading OpenVox 8

Configuration

About OpenVox's settings

Short list of important settings

puppet.conf: The main config file

environment.conf: Per-environment settings

auth.conf (LEGACY): HTTPS authorization

fileserver.conf: Custom fileserver mount points

puppetdb.conf: OpenVoxDB server locations

hiera.yaml: Data lookup configuration

autosign.conf: Basic certificate autosigning

csr_attributes.yaml: Certificate extensions

custom_trusted_oid_mapping.yaml: Short names for cert extension OIDs

device.conf: Network hardware access

routes.yaml: Advanced plugin routing

Checking values of settings

Editing settings on the command line

Complete list of settings (configuration reference)

Important directories and files

Code and data directory (codedir)

Config directory (confdir)

The main manifest

The modulepath

The SSLdir

Cache directory (vardir)

Environments

About environments

Creating environments

Environment isolation

Modules

Fundamentals

Beginner's guide to writing modules

Plugins in modules

Installing modules

Publishing modules on the Puppet Forge

Module metadata and metadata.json

Documenting modules

OpenVox Strings

OpenVox Strings style guide

Module cheat sheet

OpenVox's services and tools

OpenVox's commands

Running OpenVox commands on Windows

OpenVox agent on *nix

OpenVox agent on Windows

Puppet apply

The Puppet language

Visual index

Basics

Puppet language style guide

Handling file paths on Windows

Variables

Resources

Resources (advanced)

Relationships and ordering

Classes

Defined resource types

Type aliases

Expressions and operators

Conditional statements and expressions

Function calls

Docs for built-in functions

Node definitions

Comments

Facts and built-in variables

Reserved words and acceptable names

Writing functions (Puppet language)

Custom types

Provider development

About values and data types

Strings

Numbers

Booleans

Arrays

Hashes

Regular expressions

Sensitive

Undef

Resource references

Resource types

Default

Data type syntax

Abstract data types

Using templates

Embedded Puppet (EPP) template syntax

Embedded Ruby (ERB) template syntax

Iteration and loops

Lambdas (code blocks)

Resource defaults

Resource collectors

Virtual resources

Exported resources

Writing custom functions

Introduction to writing functions

Writing functions (Puppet language)

Overview and examples

Defining signatures

Special features in implementation methods

Documenting Ruby functions

Writing functions (legacy Ruby API --- avoid)

Designing system configs (roles and profiles)

The roles and profiles method

Roles and profiles example

Designing advanced profiles

Designing convenient roles

Hiera

About Hiera

Interactive Hiera Demo

Getting started with Hiera

Configuring Hiera

Creating and editing data

Looking up data with Hiera

Writing new data backends

Upgrading to Hiera 5

Resource types

Overview

All resource types (single-page reference)

Core types cheat sheet

Optional resource types for Windows

Augeas tips and examples

exec

Exec tips and examples for Windows

file

File tips and examples for Windows

filebucket

group

User and group tips and examples for Windows

notify

package

Package tips and examples for Windows

resources

schedule

Scheduled task tips and examples

service

Service tips and examples

stage

tidy

user

User and group tips and examples for Windows

Reports: Tracking OpenVox's activity

About reporting

Built-in report processors

Writing custom report processors

Puppet::Transaction::Report object format

Extensions for assigning classes to nodes

External node classifiers

The LDAP node classifier

Misc. references

Settings (configuration reference)

Functions

Metaparameters

Built-in report processors

Indirections and termini

Ruby API for developing extensions

Man pages

Index

puppet agent

puppet apply

puppet module

puppet resource

puppet lookup

puppet config

puppet describe

puppet device

puppet doc

puppet help

puppet node

puppet parser

puppet plugin

puppet catalog

puppet facts

puppet filebucket

puppet report

HTTP API

OpenVox Server HTTP API

SSL and certificates

Using an external CA

Configuring autosigning

CSR attributes and certificate extensions

Regenerating all certificates in a deployment

Adding a custom CA for HTTPS-inspecting proxies

Details about OpenVox's internals

Agent/server HTTPS communications

Catalog compilation

Msgpack serialization support

About OpenVox Server

Release notes

Deprecated features

Installing and upgrading

Before you begin

Install OpenVox Server

What gets installed and where

Upgrading OpenVox Server

Configuring OpenVox Server

Main OpenVox Server configurations: puppetserver.conf

Global settings: global.conf

Webserver service: webserver.conf

Web application mount points: web-routes.conf

Access control: auth.conf

Metrics services: metrics.conf

Log level and location: logback.xml

Advanced logging configuration

CA service: ca.conf

OpenVox Server use of puppet.conf settings

Configuring product-level interactions (optional): product.conf

Using and extending OpenVox Server

Using Ruby gems

Subcommands

Infrastructure CRL

Intermediate CA

External SSL termination

Restarting OpenVox Server

Tuning, troubleshooting, and known issues

Known issues

SSL problems with load-balanced PuppetDB servers ("Server Certificate Change" error)

OpenVox Server tuning guide

Scaling OpenVox Server with compilers

HTTP API

HTTP API overview

PSON

Puppet v3 API

Catalog

Node

Facts

File bucket file

File content

File metadata

Report

Environments

Puppet v4 API

Catalog

CA v1 API

Certificate

Certificate request

Certificate status

Certificate revocation list

Certificate clean

Certificate expirations

Certificate renewal

Bulk certificate sign

Server-specific API

Environment classes

Environment modules

Environment transports

Compile endpoint

Static file content

File content

Tasks overview

Tasks details

Plans overview

Plans details

Admin API

Environment cache

JRuby pool

Status API

Services endpoint

Simple endpoint

Metrics

Monitoring OpenVox Server metrics

HTTP client metrics

Applying metrics to improve performance

v1 metrics API

v2 (Jolokia) metrics API

Developer information

Developer debugging

Running from source

Tracing code events

General information

Release notes

Overview and requirements

Frequently asked questions

Versioning policy

Known issues

Community add-ons

Installation

Installing via Puppet module

Installing from packages

Installing from source

Upgrading OpenVoxDB

Connecting Puppet Servers

Connecting standalone Puppet nodes

Configuration

Configuring OpenVoxDB

puppetdb.conf: Configuring a Puppet/OpenVoxDB connection

Configuring Postgres

Setting up SSL for PostgreSQL

Coordinating database migrations

Usage/admin

Using OpenVoxDB

Maintaining and tuning

OpenVoxDB CLI

Exporting and anonymizing data

Scaling recommendations

Logging configuration

Debugging with remote REPL

Load testing

Troubleshooting

General Support Guide

Session logging

PQL - Puppet Query Language

Tutorial

Reference guide

Examples

API

Overview

Query tutorial

Curl tips

Query API version 4

Upgrading from version 3

Query structure

Entities

AST query language

Query paging

Root endpoint

Nodes endpoint

Environments endpoint

Producers endpoint

Factsets endpoint

Facts endpoint

Fact-names endpoint

Fact-paths endpoint

Fact-contents endpoint

Inventory endpoint

Catalogs endpoint

Catalog inputs endpoint

Catalog input contents endpoint

Resources endpoint

Edges endpoint

Reports endpoint

Events endpoint

Event counts endpoint

Aggregate event counts endpoint

Package endpoints

Admin API version 1

Archive endpoint

Command (cmd) endpoint

Summary stats endpoint

Command API version 1

Commands endpoint

Status API version 1

Status endpoint

Metadata API version 1

Version endpoint

Server time endpoint

Metrics API

Metrics API v2

Wire formats

Catalog wire format - v9

Facts wire format - v5

Report wire format - v8

Deactivate node wire format - v3

Replace catalog inputs wire format - v1 (experimental)

Configure expiration wire format - v1 (experimental)

Welcome to Puppet Bolt®

Developer updates

Release notes

Bolt versioning

Known issues

Installing Bolt

Run Bolt from a Docker image

Getting started with Bolt

Configuring Bolt

Bolt projects

Inventory files

Configuring Bolt

Logs

Escalating privilege with Bolt

Setting up VS Code for Bolt

Running Bolt

Run Bolt

Run Bolt on network devices

Scripts

Running scripts

Wrapping a script in a plan

Plans

Inspecting plans

Running plans

Writing plans in YAML

Writing plans in the Puppet language

Debugging plans

Testing plans

Tasks

Inspecting tasks

Running tasks

Writing tasks

Task helpers

Modules

Modules overview

Installing modules

Module structure

Packaged modules

Plugins

Using plugins

Supported plugins

Writing plugins

Using Bolt with Puppet

Applying Puppet code

Using Bolt with Hiera

Connecting Bolt to PuppetDB

Bolt Examples

Automating Windows targets

Deploy a TIG stack with Bolt

🧪 Experimental features

Reference

*nix shell commands

PowerShell cmdlets

JSON output

Plan functions

Data types

Transport configuration options

bolt-defaults.yaml options

bolt-project.yaml options

inventory.yaml fields

BoltSpec reference

Troubleshooting

Glossary

About OpenVox Containers

Container summary

On this page

Formats: Reports

This version of Puppet uses report format 9.

Last updated: Jun 10, 2026, 4:31:38 PM