|
1 | 1 | --- |
2 | 2 | layout: default |
3 | | -title: "Puppet Server: Index" |
4 | | -canonical: "/puppetserver/latest/" |
| 3 | +title: "OpenVox Server 8" |
5 | 4 | --- |
6 | 5 |
|
7 | | -Puppet Server is the next-generation application for managing Puppet agents. |
| 6 | +OpenVox Server is the primary server component in an OpenVox agent/server deployment. |
| 7 | +It compiles configuration catalogs for managed nodes, serves files, manages certificates, |
| 8 | +and receives reports from agents. |
| 9 | +It is a Ruby and Clojure application that runs on the Java Virtual Machine (JVM). |
8 | 10 |
|
9 | | -> **Note:** For information about configuring and tuning settings specific to [Puppet Enterprise](https://puppet.com/docs/pe/), see |
10 | | -> [its documentation](https://puppet.com/docs/pe/latest/configuring/config_puppetserver.html). |
| 11 | +## How it works |
11 | 12 |
|
12 | | -- [**About OpenVox Server**](./services_puppetserver.html) |
13 | | - - [Release notes](./release_notes.html) |
14 | | - - [Deprecated features](./deprecated_features.html) |
15 | | - - [Notable differences vs. the Apache/Passenger stack](./puppetserver_vs_passenger.html) |
16 | | - - [Compatibility with Puppet agent](./compatibility_with_puppet_agent.html) |
17 | | -- [**Installing Puppet Server**](./install_from_packages.html) |
18 | | -- [**Configuring Puppet Server**](./configuration.html) |
19 | | - - [global.conf](./config_file_global.html) |
20 | | - - [webserver.conf](./config_file_webserver.html) |
21 | | - - [web-routes.conf](./config_file_web-routes.html) |
22 | | - - [puppetserver.conf](./config_file_puppetserver.html) |
23 | | - - [auth.conf](./config_file_auth.html) |
24 | | - - [Migrating deprecated authentication rules](./config_file_auth_migration.html) |
25 | | - - [metrics.conf](./config_file_metrics.html) |
26 | | - - [logback.xml](./config_file_logbackxml.html) |
27 | | - - [Advanced logging configuration](./config_logging_advanced.html) |
28 | | - - [master.conf](./config_file_master.html) (deprecated) |
29 | | - - [ca.conf](./config_file_ca.html) |
30 | | - - [Differing behavior in puppet.conf](./puppet_conf_setting_diffs.html) |
31 | | -- **Using and extending Puppet Server** |
32 | | - - [Subcommands](./subcommands.html) |
33 | | - - [Using Ruby gems](./gems.html) |
34 | | - - [Using an external certificate authority](./external_ca_configuration.html) |
35 | | - - [External SSL termination](./external_ssl_termination.html) |
36 | | - - [Monitoring Puppet Server metrics](./puppet_server_metrics.html) |
37 | | - - [HTTP client metrics](./http_client_metrics.html) |
38 | | - - [Tuning guide](./tuning_guide.html) |
39 | | - - [Applying metrics to improve performance](./puppet_server_metrics_performance.html) |
40 | | - - [Scaling Puppet Server](./scaling_puppet_server.html) |
41 | | - - [Restarting Puppet Server](./restarting.html) |
42 | | -- **Known issues and workarounds** |
43 | | - - [Known issues](./known_issues.html) |
44 | | - - [SSL problems with load-balanced PuppetDB servers ("Server Certificate Change" error)](./ssl_server_certificate_change_and_virtual_ips.html) |
45 | | -- **Administrative API endpoints** |
46 | | - - [Environment cache](./admin-api/v1/environment-cache.html) |
47 | | - - [JRuby pool](./admin-api/v1/jruby-pool.html) |
48 | | -- **Server-specific Puppet API endpoints** |
49 | | - - [Environment classes](./puppet-api/v3/environment_classes.html) |
50 | | - - [Environment modules](./puppet-api/v3/environment_modules.html) |
51 | | - - [Static file content](./puppet-api/v3/static_file_content.html) |
52 | | -- **Status API endpoints** |
53 | | - - [Status services](./status-api/v1/services.html) |
54 | | - - [Simple status](./status-api/v1/simple.html) |
55 | | -- **Metrics API endpoints** |
56 | | - - [v1 metrics](./metrics-api/v1/metrics_api.html) |
57 | | - - [v2 (Jolokia) metrics](./metrics-api/v2/metrics_api.html) |
58 | | -- **Developer information** |
59 | | - - [Debugging](./dev_debugging.html) |
60 | | - - [Running from source](./dev_running_from_source.html) |
61 | | - - [Tracing code events](./dev_trace_func.html) |
| 13 | +OpenVox agents periodically contact OpenVox Server over mutual-TLS HTTPS. |
| 14 | +The server compiles a node-specific catalog from Puppet code and Hiera data, returns it |
| 15 | +to the agent for enforcement, and collects the resulting report. |
| 16 | +It also runs a built-in certificate authority for signing agent certificates. |
| 17 | + |
| 18 | +For a full description of the service and its internal components, see |
| 19 | +[About OpenVox Server](./services_puppetserver.html). |
| 20 | + |
| 21 | +## Getting started |
| 22 | + |
| 23 | +1. Review [pre-install tasks](install_pre.html) — system requirements, DNS, firewall, and time synchronization |
| 24 | +2. [Install OpenVox Server](install_from_packages.html) |
| 25 | +3. [Configure OpenVox Server](configuration.html) |
| 26 | + |
| 27 | +For community help and support resources, see the [Vox Pupuli support page](https://voxpupuli.org/openvox/support/). |
0 commit comments