Merge pull request #71 from miharp/docs/agent-install-what-and-where

Add agent install overview, component versions table, and clean up stale content

Author: tuxmea

_data/nav/openvox_8x.yml

@@ -9,8 +9,6 @@
     link: "system_requirements.html"
   - text: Component versions in `openvox-agent`
     link: "about_agent.html"
-  - text: OpenVox agent release notes
-    link: "release_notes_agent.html"
 - text: Quick start guides
   items:
   - text: NTP quick start guide
@@ -49,6 +47,8 @@
     link: "install_windows.html"
   - text: 'Install agent: macOS'
     link: "install_osx.html"
+  - text: What gets installed and where (agent)
+    link: "install_what_and_where.html"
   - text: File location changes since OpenVox 3.8.x
     link: "whered_it_go.html"
   - text: Pre-upgrade tasks from 3.8

docs/_openvox_8x/about_agent.md

@@ -3,25 +3,32 @@ layout: default
 title: "Component versions in OpenVox-agent"
 ---
 
-[Facter]: {{facter}}/
-[Hiera]: {{hiera}}/
+[OpenFact]: /openfact/latest/
+[Hiera]: ./hiera_intro.html
 [agent]: ./services_agent_unix.html
 [apply]: ./services_apply.html
-[Puppet Server]: {{puppetserver}}/
-[release notes]: ./release_notes_agent.html
+[OpenVox Server]: /openvox-server/latest/
+[release notes]: ./release_notes.html
 
-### Release contents of `OpenVox-agent` 8.x
+## Release contents of `OpenVox-agent` 8.x
 
 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.
 
-### What `openvox-agent` and OpenVox Server are
+| OpenVox release | OpenFact | Ruby   | OpenSSL |
+|-----------------|----------|--------|---------|
+| 8.26.2          | 5.6.0    | 3.2.11 | 3.0.20  |
+| 8.26.1          | 5.6.0    | 3.2.11 | 3.0.20  |
+| 8.26.0          | 5.6.0    | 3.2.11 | 3.0.20  |
+| 8.25.0          | 5.4.0    | 3.2.10 | 3.0.19  |
+
+## What `openvox-agent` and OpenVox Server are
 
 We distribute OpenVox as two core packages.
 
-- `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].
+- `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 [`puppet apply` command][apply].
 - `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.
 
-### How version numbers work
+## How version numbers work
 
 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.
 

docs/_openvox_8x/install_what_and_where.markdown

@@ -0,0 +1,68 @@
+---
+layout: default
+title: "What gets installed and where (agent)"
+---
+
+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`.
+
+## Executables and binaries
+
+| Location | Description |
+|----------|-------------|
+| `/opt/puppetlabs/bin/` | Public binaries (`puppet`, `facter`). This directory is on the `PATH` by default. |
+| `/opt/puppetlabs/puppet/bin/` | Private binaries and the Ruby runtime used internally by the agent. Not on the `PATH` by default. |
+
+**Windows:** `C:\Program Files\Puppet Labs\OpenVox\bin\` and `C:\Program Files\Puppet Labs\OpenVox\puppet\bin\`
+
+## Configuration files
+
+The main configuration directory ([confdir](./dirs_confdir.html)) defaults to:
+
+- **\*nix:** `/etc/puppetlabs/puppet/`
+- **Windows:** `%PROGRAMDATA%\PuppetLabs\puppet\etc\`
+- **Non-root users:** `~/.puppetlabs/etc/puppet/`
+
+Key files within the confdir:
+
+| File | Description |
+|------|-------------|
+| `puppet.conf` | Main configuration file |
+| `ssl/` | SSL certificates, keys, and CRLs — see [SSLdir](./dirs_ssldir.html) |
+| `hiera.yaml` | Hiera configuration |
+| `auth.conf` | HTTPS authorization rules |
+
+## Code and data
+
+The code directory ([codedir](./dirs_codedir.html)) defaults to:
+
+- **\*nix:** `/etc/puppetlabs/code/`
+- **Windows:** `%PROGRAMDATA%\PuppetLabs\code\`
+- **Non-root users:** `~/.puppetlabs/etc/code/`
+
+## Cache directory
+
+The cache directory ([vardir](./dirs_vardir.html)) stores dynamic data generated during agent runs:
+
+- **\*nix:** `/var/opt/puppetlabs/puppet/cache/`
+- **Non-root users:** `~/.puppetlabs/opt/puppet/cache/`
+
+Notable contents:
+
+| Path | Description |
+|------|-------------|
+| `state/last_run_summary.yaml` | Summary of the most recent agent run |
+| `state/last_run_report.yaml` | Full report from the most recent agent run |
+| `state/agent_catalog_run.lock` | Lock file present while an agent run is in progress |
+| `facts.d/` | External facts directory |
+
+## Log files
+
+- **\*nix:** `/var/log/puppetlabs/puppet/puppet.log`
+- **Windows:** `%PROGRAMDATA%\PuppetLabs\puppet\var\log\puppet.log`
+
+## Service
+
+The agent runs as the `puppet` service, managed by the platform's native service manager (systemd on most Linux distributions).
+
+- **Service name:** `puppet`
+- **Runs as user:** `puppet` (created by the package installer)