repository·main·Indexed 41 days ago
https://github.com/openvoxproject/openvoxA community-maintained implementation of Puppet providing automated administrative capabilities for Linux, Unix, and Windows systems via centralized specifications.
OpenVox's command line interface is provided via a single puppet binary that utilizes a subcommand architecture. The tools are categorized by their frequency of use and intended workflow:
Note on Certificate Management:
If you are using Puppet version 6.0 or later, do not use puppet cert. Instead, use the puppetserver cert command.
The OpenVox All-In-One (AIO) agent (also known as openvox-agent) is a collection of software required for OpenVox and its dependencies to run. It bundles core components like openvox and openfact along with vendored dependencies such as Ruby, curl, and openssl.
This repository provides the configuration to build the openvox-agent AIO package and the openfact gem for all Puppet-supported platforms using vanagon, a packaging utility.
OpenVox uses the following formats for message exchange:
application/octet-stream payloads (e.g., file contents).Note: PSON and YAML are no longer supported for performance and security reasons, respectively.
The node_terminus setting determines which plugin is used to compile node catalogs. A node data plugin provides a list of classes, the environment, and top-scope variables for a node.
Supported values:
plain: Returns no data; the main manifest controls all node configuration. (Default)exec: Uses an External Node Classifier (ENC) configured via the external_nodes setting. This allows pulling classes from external systems via a script that returns YAML.json: (Used in conjunction with node_cache_terminus).Use the following logic to determine which base branch a change set belongs to:
master branch: Use this for new functionality that is not a bug fix. This is the branch for major and minor (feature) releases.stable branch: Use this for bug fixes against the latest release or release candidate. This branch does not receive new functionality.master only.stable and master.Instead of relying solely on a precedence table, you can structure your grammar to mimic a recursive descent parser. This involves grouping expressions into hierarchical rules based on their precedence levels.
Example pattern:
expr
: mulexp
| expr PLUS mulexp
| expr MINUS mulexp
mulexp
: primary
| mulexp TIMES primary
| mulexp DIV primary
primary
: NUMBERThis approach makes the precedence explicit in the grammar structure itself.
The package resource type is used to manage software packages on a target system. OpenVox automatically detects the appropriate packaging format based on the platform, but you can manually specify a provider to override this behavior.
yum, apt, gem, rpm) handle package management. Some providers can retrieve files themselves, while others require a source file.Package['my_title']). The name attribute is the actual internal name used by the packaging system, which may differ from the title.adminfile, responsefile, or source to manage files, the package resource will automatically create a dependency on those files.package { 'my_package_title':
name => 'actual_package_name',
ensure => installed,
provider => 'apt',
}OpenVox uses three distinct types of tests to ensure system stability:
spec/ directory.spec/ directory.acceptance/tests/ directory.When ensure => directory is set, you can manage the contents of the directory.
recurse optionsfalse (default): Contents are not managed.remote: If source is set, OpenVox manages the contents of the source directory to match the target. This disables purge and is faster than true.true: Manages contents from the source directory and enables the purge attribute.purgeIf purge => true is set, unmanaged files in the directory will be deleted.
filebucket is configured, purged files are uploaded to the bucket.filebucket is configured, data is destroyed.force => true is set.recurselimitLimits how deep OpenVox descends into subdirectories.
0: Same as recurse => false.1: Manages files/directories directly inside the target, but not their contents.2: Manages direct contents and the first level of subdirectories.Every resource type has a namevar, which is the attribute used to uniquely identify that resource on the target system.
If you do not explicitly provide a value for the namevar, it defaults to the resource's title.
In the following example, the file type's namevar is path. Since path is not specified, it defaults to the title '/etc/passwd'.
file { '/etc/passwd':
owner => 'root',
group => 'root',
mode => '0644',
}You can provide a namevar explicitly to decouple the resource's identity from its title:
file { 'passwords':
path => '/etc/passwd',
owner => 'root',
group => 'root',
mode => '0644',
}In this case, the resource is still identified as File['/etc/passwd'] for relationship management.
The links parameter changes how symbolic links are represented in the JSON response:
links=manage (Default)type is link.destination field contains the path the link points to.mode, owner, and group fields reflect the values of the link itself.links=followtype is file (the type of the target).destination field is null.mode, owner, and group fields reflect the values of the target file.checksum reflects the target file.# Example of 'follow' behavior for a link
{
"destination": null,
"group": 20,
"links": "follow",
"mode": 420,
"owner": 501,
"path": "/etc/puppetlabs/code/modules/example/files/link_to_file.txt",
"relative_path": null,
"type": "file"
}