Skip to content

Commit e199caf

Browse files
committed
Add agent install overview, component versions table, and clean up stale content
- Add install_what_and_where.markdown: new page documenting where the openvox-agent package installs binaries, config, code, cache, logs, and the system service/user on *nix and Windows - Add component versions table to about_agent.md seeded from 8.25.0 onward (OpenFact, Ruby, OpenSSL per release), fix broken links ({{facter}}, {{hiera}}, {{puppetserver}} all resolved to /), rename Facter→OpenFact, and update puppet apply→openvox apply - Remove release_notes_agent.md (stale Puppet 5.x content) and redirect all references to release_notes.html - Add new page to nav under "Installing and upgrading" Signed-off-by: Michael Harp <mike@mikeharp.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
1 parent 85902d5 commit e199caf

5 files changed

Lines changed: 85 additions & 135 deletions

File tree

_data/nav/openvox_8x.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
link: "system_requirements.html"
1010
- text: Component versions in `openvox-agent`
1111
link: "about_agent.html"
12-
- text: OpenVox agent release notes
13-
link: "release_notes_agent.html"
1412
- text: Quick start guides
1513
items:
1614
- text: NTP quick start guide
@@ -49,6 +47,8 @@
4947
link: "install_windows.html"
5048
- text: 'Install agent: macOS'
5149
link: "install_osx.html"
50+
- text: What gets installed and where (agent)
51+
link: "install_what_and_where.html"
5252
- text: File location changes since OpenVox 3.8.x
5353
link: "whered_it_go.html"
5454
- text: Pre-upgrade tasks from 3.8

docs/_openvox_8x/_puppet_toc.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ <h3 id="puppet-reference-manual">Puppet Platform reference manual</h3>
1111
* [Puppet known issues]({{puppet}}/known_issues.html)
1212
* [System requirements]({{puppet}}/system_requirements.html)
1313
* [Component versions in `puppet-agent`]({{puppet}}/about_agent.html)
14-
* [Puppet agent release notes]({{puppet}}/release_notes_agent.html)
1514
* [Puppet Server {{ server_version }} release notes]({{puppetserver}}/release_notes.html)
1615
* [Facter release notes]({{facter}}/release_notes.html)
1716
* **Quick start guides**

docs/_openvox_8x/about_agent.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,32 @@ layout: default
33
title: "Component versions in OpenVox-agent"
44
---
55

6-
[Facter]: {{facter}}/
7-
[Hiera]: {{hiera}}/
6+
[OpenFact]: /openfact/latest/
7+
[Hiera]: ./hiera_intro.html
88
[agent]: ./services_agent_unix.html
99
[apply]: ./services_apply.html
10-
[Puppet Server]: {{puppetserver}}/
11-
[release notes]: ./release_notes_agent.html
10+
[OpenVox Server]: /openvox-server/latest/
11+
[release notes]: ./release_notes.html
1212

13-
### Release contents of `OpenVox-agent` 8.x
13+
## Release contents of `OpenVox-agent` 8.x
1414

1515
See the table for details about which components shipped in which `openvox-agent` release, and the [package-specific release notes][release notes] for more information about packaging and installation fixes and features.
1616

17-
### What `openvox-agent` and OpenVox Server are
17+
| OpenVox release | OpenFact | Ruby | OpenSSL |
18+
|-----------------|----------|--------|---------|
19+
| 8.26.2 | 5.6.0 | 3.2.11 | 3.0.20 |
20+
| 8.26.1 | 5.6.0 | 3.2.11 | 3.0.20 |
21+
| 8.26.0 | 5.6.0 | 3.2.11 | 3.0.20 |
22+
| 8.25.0 | 5.4.0 | 3.2.10 | 3.0.19 |
23+
24+
## What `openvox-agent` and OpenVox Server are
1825

1926
We distribute OpenVox as two core packages.
2027

21-
- `openvox-agent` --- This package contains OpenVox's main code and all of the dependencies needed to run it, including [Facter][], [Hiera][], and bundled versions of Ruby and OpenSSL. Once it's installed, you have everything you need to run [the OpenVox agent service][agent] and the [`puppet apply` command][apply].
28+
- `openvox-agent` --- This package contains OpenVox's main code and all of the dependencies needed to run it, including [OpenFact][], [Hiera][], and bundled versions of Ruby and OpenSSL. Once it's installed, you have everything you need to run [the OpenVox agent service][agent] and the [`openvox apply` command][apply].
2229
- `openvox-server` --- This package depends on `openvox-agent`, and adds the JVM-based [OpenVox Server][] application. Once it's installed, OpenVox Server can serve catalogs to nodes running the OpenVox agent service.
2330

24-
### How version numbers work
31+
## How version numbers work
2532

2633
OpenVox Server is a separate application that, among other things, runs instances of the OpenVox server application. It has its own version number separate from the version of OpenVox it runs and may be compatible with more than one existing OpenVox version.
2734

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
layout: default
3+
title: "What gets installed and where (agent)"
4+
---
5+
6+
When you install the `openvox-agent` package, it places files and directories in the following locations. Windows paths use `%PROGRAMDATA%` which is usually `C:\ProgramData`.
7+
8+
## Executables and binaries
9+
10+
| Location | Description |
11+
|----------|-------------|
12+
| `/opt/puppetlabs/bin/` | Public binaries (`puppet`, `facter`). This directory is on the `PATH` by default. |
13+
| `/opt/puppetlabs/puppet/bin/` | Private binaries and the Ruby runtime used internally by the agent. Not on the `PATH` by default. |
14+
15+
**Windows:** `C:\Program Files\Puppet Labs\OpenVox\bin\` and `C:\Program Files\Puppet Labs\OpenVox\puppet\bin\`
16+
17+
## Configuration files
18+
19+
The main configuration directory ([confdir](./dirs_confdir.html)) defaults to:
20+
21+
- **\*nix:** `/etc/puppetlabs/puppet/`
22+
- **Windows:** `%PROGRAMDATA%\PuppetLabs\puppet\etc\`
23+
- **Non-root users:** `~/.puppetlabs/etc/puppet/`
24+
25+
Key files within the confdir:
26+
27+
| File | Description |
28+
|------|-------------|
29+
| `puppet.conf` | Main configuration file |
30+
| `ssl/` | SSL certificates, keys, and CRLs — see [SSLdir](./dirs_ssldir.html) |
31+
| `hiera.yaml` | Hiera configuration |
32+
| `auth.conf` | HTTPS authorization rules |
33+
34+
## Code and data
35+
36+
The code directory ([codedir](./dirs_codedir.html)) defaults to:
37+
38+
- **\*nix:** `/etc/puppetlabs/code/`
39+
- **Windows:** `%PROGRAMDATA%\PuppetLabs\code\`
40+
- **Non-root users:** `~/.puppetlabs/etc/code/`
41+
42+
## Cache directory
43+
44+
The cache directory ([vardir](./dirs_vardir.html)) stores dynamic data generated during agent runs:
45+
46+
- **\*nix:** `/var/opt/puppetlabs/puppet/cache/`
47+
- **Non-root users:** `~/.puppetlabs/opt/puppet/cache/`
48+
49+
Notable contents:
50+
51+
| Path | Description |
52+
|------|-------------|
53+
| `state/last_run_summary.yaml` | Summary of the most recent agent run |
54+
| `state/last_run_report.yaml` | Full report from the most recent agent run |
55+
| `state/agent_catalog_run.lock` | Lock file present while an agent run is in progress |
56+
| `facts.d/` | External facts directory |
57+
58+
## Log files
59+
60+
- **\*nix:** `/var/log/puppetlabs/puppet/puppet.log`
61+
- **Windows:** `%PROGRAMDATA%\PuppetLabs\puppet\var\log\puppet.log`
62+
63+
## Service
64+
65+
The agent runs as the `puppet` service, managed by the platform's native service manager (systemd on most Linux distributions).
66+
67+
- **Service name:** `puppet`
68+
- **Runs as user:** `puppet` (created by the package installer)

docs/_openvox_8x/release_notes_agent.md

Lines changed: 0 additions & 124 deletions
This file was deleted.

0 commit comments

Comments
 (0)