You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve services_puppetserver content and structure
- Lead intro with what OpenVox Server does before implementation details
- Add systemctl commands alongside service for modern systemd platforms
- Remove vague 'from a user's perspective' run environment paragraph
- Make Admin API code-deploy use case more concrete
- Link ca.conf from CA service section
- Link logback.xml directly from Logging section
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Michael Harp <mike@mikeharp.com>
OpenVox is configured in an agent-server architecture, in which a primary server manages configuration for a fleet of managed agent nodes.
9
-
OpenVox Server performs the role of the primary server. It is a Ruby and Clojure application that runs on the Java Virtual Machine (JVM).
10
-
It runs OpenVox's catalog compilation and related work inside JRuby interpreters, with supporting services written in Clojure,
11
-
all coordinated by the Trapperkeeper service framework.
9
+
OpenVox Server performs the role of the primary server: it compiles catalogs, serves files, manages certificates, and receives reports from agents.
10
+
It is a Ruby and Clojure application that runs on the Java Virtual Machine (JVM), executing catalog compilation inside JRuby interpreters
11
+
with supporting services written in Clojure, coordinated by the Trapperkeeper service framework.
12
12
13
13
This page describes the run environment and architecture of OpenVox Server. For practical instructions, see the docs for [installing](./install_from_packages.html) and [configuring](./configuration.html) it.
14
14
@@ -23,21 +23,22 @@ OpenVox Server releases are versioned separately from OpenVox (the agent). Major
23
23
24
24
## Controlling the Service
25
25
26
-
The OpenVox Server service name is `puppetserver`. Use the standard commands for your OS to manage it:
26
+
The OpenVox Server service name is `puppetserver`. On systemd-based platforms:
27
27
28
28
```shell
29
-
service puppetserver start
30
-
service puppetserver stop
31
-
service puppetserver restart
32
-
service puppetserver status
29
+
systemctl start puppetserver
30
+
systemctl stop puppetserver
31
+
systemctl restart puppetserver
32
+
systemctl status puppetserver
33
+
systemctl enable puppetserver # start automatically on boot
33
34
```
34
35
36
+
On older SysV-style init systems, use `service puppetserver start|stop|restart|status` instead.
37
+
35
38
## OpenVox Server's Run Environment
36
39
37
40
OpenVox Server consists of several related services that share state and route requests among themselves. These services run inside a single JVM process using the Trapperkeeper service framework.
38
-
39
-
From a user's perspective, it mostly acts like a single monolithic service. Most of the architectural complexity is wrapped and hidden;
40
-
the main exception is the handful of extra config files that manage different internal services.
41
+
The main visible consequence of this architecture is the set of separate config files that manage the different internal services.
41
42
42
43
### Embedded Web Server
43
44
@@ -67,12 +68,14 @@ The relevant endpoints are `certificate`, `certificate_request`, `certificate_re
67
68
Signing and revoking certificates over the network is disallowed by default. You can use [`auth.conf`](./config_file_auth.html) to allow specific certificate owners to issue commands.
68
69
69
70
The CA service stores credentials as `.pem` files under `/etc/puppetlabs/puppetserver/ca/`. Use the `puppetserver ca` command to list, sign, and revoke certificates.
71
+
See [`ca.conf`](./config_file_ca.html) for CA configuration options.
70
72
71
73
### Admin API Service
72
74
73
75
OpenVox Server includes an administrative API for triggering maintenance tasks.
74
76
75
-
The primary use is forcing expiration of all environment caches, which lets you deploy new code to long-timeout environments without a full service restart.
77
+
The primary use case is deploying new Puppet code without restarting the service: the environment cache endpoint expires all cached environments,
78
+
causing OpenVox Server to pick up code changes on the next agent run.
76
79
77
80
For API docs, see:
78
81
@@ -126,7 +129,7 @@ By default, OpenVox Server sends nothing to syslog. All log messages follow the
126
129
127
130
Logback archives log files when they exceed 200 MB, and automatically deletes the oldest logs when the total size of all server logs exceeds 1 GB.
128
131
129
-
Logback is highly configurable; see [the configuration docs](./configuration.html#logging) for details on customizing log output.
132
+
Logback is highly configurable via [`logback.xml`](./config_file_logbackxml.html); see [the configuration docs](./configuration.html#logging) for details on customizing log output.
130
133
131
134
Errors that occur before logging is set up, or that cause the logging system to fail, appear in `journalctl` on systemd-based platforms.
0 commit comments