Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions _data/nav/openvox-server_8x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,24 @@
link: puppet-api/v3/environment_classes.html
- text: Environment modules
link: puppet-api/v3/environment_modules.html
- text: Environment transports
link: puppet-api/v3/environment_transports.html
- text: Compile endpoint
link: puppet-api/v3/compile.html
- text: Static file content
link: puppet-api/v3/static_file_content.html
- text: File content
link: puppet-api/v3/file_content.html
- text: Tasks overview
link: puppet-api/v3/tasks.html
- text: Tasks details
link: puppet-api/v3/task_detail.html
- text: Plans overview
link: puppet-api/v3/plans.html
- text: Plans details
link: puppet-api/v3/plan_detail.html
- text: Catalog endpoint
link: puppet-api/v4/catalog.html
- text: Status API endpoints
items:
- text: Services endpoint
Expand Down
6 changes: 3 additions & 3 deletions docs/_openvox-server_8x/config_file_master.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ When using the `allow-header-cert-info` setting in `master.conf`, you can change
parameter can rename `X-Client-DN`. The `X-Client-Cert` header can't be renamed.

The `allow-header-cert-info` parameter in `master.conf` applies only to HTTP endpoints served by the "master" service. The applicable endpoints include those listed in
[Puppet V3 HTTP API](https://puppet.com/docs/puppet/latest/http_api/http_api_index.html#puppet-v3-http-api). It does not apply to the endpoints listed in
[CA V1 HTTP API](https://puppet.com/docs/puppet/latest/http_api/http_api_index.html#ca-v1-http-api) or to any [Puppet Admin API][`puppetserver.conf`] endpoints.
[Puppet V3 HTTP API](../openvox/latest/http_api/http_api_index.html#puppet-v3-http-api). It does not apply to the endpoints listed in
[CA V1 HTTP API](../openvox/latest/http_api/http_api_index.html#ca-v1-http-api) or to any [Puppet Admin API][`puppetserver.conf`] endpoints.

## Supported Authorization Workflow

Expand All @@ -37,7 +37,7 @@ headers.
The `allow-header-cert-info` parameter in `auth.conf`, applies to all HTTP endpoints that Puppet Server handles, including those served by the "master" service, the CA API, and the Puppet Admin API.

For additional information on the `allow-header-cert-info` parameter in `auth.conf`, see [Puppet Server Configuration Files: `auth.conf`][new `auth.conf`] and
[Configuring the Authorization Service in the `trapperkeeper-authorization` documentation](https://github.com/puppetlabs/trapperkeeper-authorization/blob/master/doc/authorization-config.md#allow-header-cert-info).
[Configuring the Authorization Service in the `trapperkeeper-authorization` documentation](https://github.com/openvoxproject/trapperkeeper-authorization/blob/master/doc/authorization-config.md#allow-header-cert-info).

### HOCON `auth.conf` Example

Expand Down
157 changes: 0 additions & 157 deletions docs/_openvox-server_8x/http_api_index.markdown

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: "OpenVox Server: Puppet API: Environment Transports"
---

[HTTP API]: ../../http_api_index.html
[HTTP API]: ../../../openvox/latest/http_api_index.html
[environment cache API]: ../../admin-api/v1/environment-cache.html
[environment classes API]: ./environment_classes.html
[transports schema]: ./environment_transports.json
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox-server_8x/puppet-api/v4/catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"properties": {
"catalog": {
"type": "object",
"$ref": "https://puppet.com/docs/puppet/6.2/schemas/catalog.json"
"$ref": "https://docs.openvoxproject.org/openvox/latest/schemas/catalog.json"
},
"logs": {
"description": "The log messages that occured during the catalog compilation.",
Expand Down
15 changes: 6 additions & 9 deletions docs/_openvox-server_8x/puppet-api/v4/catalog.markdown
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
layout: default
title: "Puppet Server: Puppet API: Catalog"
canonical: "/puppetserver/latest/puppet-api/v4/catalog.html"
title: "OpenVox Server: Puppet API: Catalog"
---

The catalog API returns a compiled catalog for the node specified in the request, making use of provided metadata like facts or environment if specified. If not specified, it will attempt to fetch this data
from Puppet's configured sources (usually PuppetDB or a node classifier). The returned catalog is in JSON format, ready to be parsed and applied by an agent.
from OpenVox's configured sources (usually OpenVox-DB or a node classifier). The returned catalog is in JSON format, ready to be parsed and applied by an agent.

## `POST /puppet/v4/catalog`

(Introduced in Puppet Server 6.3.0)

The input data for the catalog to be compiled is submitted as a JSON body with the following form:

```text
Expand All @@ -35,7 +32,7 @@ The name of the node for which to compile the catalog.

### `persistence` (required)

A hash containing two required keys, `facts` and `catalog`, which when set to true will cause the facts and reports to be stored in PuppetDB, or discarded if set to false.
A hash containing two required keys, `facts` and `catalog`, which when set to true will cause the facts and reports to be stored in OpenVox-DB, or discarded if set to false.

### `environment` (required)

Expand All @@ -44,12 +41,12 @@ allows an agent-specified environment.

### `facts`

A hash with a required `values` key, containing a hash of all the facts for the node. If not provided, Puppet will attempt to fetch facts for the node from PuppetDB.
A hash with a required `values` key, containing a hash of all the facts for the node. If not provided, Puppet will attempt to fetch facts for the node from OpenVox-DB.

### `trusted_facts`

A hash with a required `values` key containing a hash of the trusted facts for a node. In a normal agent's catalog request, these would be extracted from the cert, but this endpoint does not require a cert for
the node whose catalog is being compiled. If not provided, Puppet will attempt to fetch the trusted facts for the node from PuppetDB or from the provided facts hash.
the node whose catalog is being compiled. If not provided, OpenVox will attempt to fetch the trusted facts for the node from OpenVox-DB or from the provided facts hash.

### `transaction_uuid`

Expand All @@ -76,5 +73,5 @@ The catalog response body conforms to the [catalog schema](./catalog.json).

### Authorization

All requests made to the catalog API are authorized using the Trapperkeeper-based `auth.conf`. For more information about the Puppet Server authorization process and configuration settings, see the
All requests made to the catalog API are authorized using the Trapperkeeper-based `auth.conf`. For more information about the OpenVox Server authorization process and configuration settings, see the
[`auth.conf` documentation](../../config_file_auth.html).
8 changes: 4 additions & 4 deletions docs/_openvox-server_8x/services_puppetserver.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The web server's settings can be modified in [`webserver.conf`](./config_file_we

### OpenVox API Service

OpenVox Server includes a service that handles agent configuration requests. See [OpenVox HTTP API](/openvox/latest/http_api/http_api_index.html) for documentation on the core APIs.
OpenVox Server includes a service that handles agent configuration requests. See [OpenVox HTTP API](../openvox/latest/http_api/http_api_index.html) for documentation on the core APIs.

For OpenVox Server-specific APIs hosted by this service, see:

Expand All @@ -63,7 +63,7 @@ OpenVox Server includes a certificate authority (CA) service that:
- Serves certificates and a certificate revocation list (CRL) to nodes
- Optionally accepts commands to sign or revoke certificates (disabled by default)

The relevant endpoints are `certificate`, `certificate_request`, `certificate_revocation_list`, and `certificate_status`. See [CA HTTP API](/openvox/latest/http_api/http_api_index.html) for details.
The relevant endpoints are `certificate`, `certificate_request`, `certificate_revocation_list`, and `certificate_status`. See [CA HTTP API](../openvox/latest/http_api/http_api_index.html) for details.

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.

Expand All @@ -82,7 +82,7 @@ For API docs, see:
- [The `environment-cache` endpoint](./admin-api/v1/environment-cache.html)
- [The `jruby-pool` endpoint](./admin-api/v1/jruby-pool.html)

For details about environment caching, see [Environments](/openvox/latest/environments_about.html).
For details about environment caching, see [Environments](../openvox/latest/environments_about.html).

### JRuby Interpreters

Expand Down Expand Up @@ -162,5 +162,5 @@ The `conf.d` directory contains:

For full details, see the [Configuration](./configuration.html) page.

OpenVox Server also uses OpenVox's standard config files, including most settings in [`puppet.conf`](/openvox/latest/config_file_main.html).
OpenVox Server also uses OpenVox's standard config files, including most settings in [`puppet.conf`](../openvox/latest/config_file_main.html).
However, some `puppet.conf` settings are treated differently by OpenVox Server — see [puppet.conf differences](./puppet_conf_setting_diffs.html) for details.
11 changes: 4 additions & 7 deletions docs/_openvox-server_8x/status-api/v1/services.markdown
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
layout: default
title: "Puppet Server: Status API: Services"
canonical: "/puppetserver/latest/status-api/v1/services.html"
title: "OpenVox Server: Status API: Services"
---

[`auth.conf`]: ../../config_file_auth.html

The `services` endpoint of Puppet Server's Status API provides information about services running on Puppet Server. As of Puppet Server 2.6.0, the endpoint provides information about memory usage similar to the
The `services` endpoint of OpenVox Server's Status API provides information about services running on OpenVox Server. The endpoint provides information about memory usage similar to the
data produced by the Java MemoryMXBean, as well as basic data on the `pupppetserver` process's state and uptime. See the
[Java MemoryMXBean documentation](https://docs.oracle.com/javase/7/docs/api/java/lang/management/MemoryMXBean.html) for help interpreting the memory information.

Expand All @@ -16,8 +15,6 @@ data produced by the Java MemoryMXBean, as well as basic data on the `pupppetser

## `GET /status/v1/services`

(Introduced in Puppet Server 2.6.0)

### Supported HTTP methods

GET
Expand All @@ -36,7 +33,7 @@ JSON

- `debug`: This level returns status information about a service in enough detail to be suitable for debugging issues with the `puppetserver` process. Depending on the service, this level can be significantly
more expensive than lower levels, reduce the process's performance, and generate large amounts of data. This level is suitable for producing aggregate metrics about the performance or resource usage of
Puppet Server's subsystems.
OpenVox Server's subsystems.

The information returned for any service at each increasing level of detail includes the data from lower levels. In other words, the `info` level returns the same data structure as the `critical` level, and
might provide additional data in the `status` field depending on the service. Likewise, the `debug` level returns the same data structure as `info`, and might also add additional information in the `status`
Expand Down Expand Up @@ -98,7 +95,7 @@ Content-Type: application/json

### Authorization

Requests to the `services` endpoint are authorized by the [Trapperkeeper-based authorization process][`auth.conf`] as of Puppet Server 5.3.0. For more information about the supported Puppet Server authorization
Requests to the `services` endpoint are authorized by the [Trapperkeeper-based authorization process][`auth.conf`]. For more information about the supported OpenVox Server authorization
processes and configuration settings, see the [`auth.conf` documentation][`auth.conf`].

One may also restrict access to the status service by changing the `client-auth` setting to `required` for the webserver. See
Expand Down
Loading