From 9dc123e3dd8bf8294fde6231edeea2d9daa26241 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sat, 16 May 2026 11:58:01 +0200 Subject: [PATCH 1/4] fix puppet-api wording and nav list - add missing links to nav list - rename from Puppet to OpenVox - where applicable - remove old http_api_index in server - point to http_api_index in openvox tree - remove docs for API v1 und v2 - fix github links to pint to openvoxproject Signed-off-by: Martin Alfke --- _data/nav/openvox-server_8x.yml | 16 ++ .../config_file_master.markdown | 6 +- .../http_api_index.markdown | 157 ------------------ .../v3/environment_transports.markdown | 2 +- .../puppet-api/v4/catalog.json | 2 +- .../puppet-api/v4/catalog.markdown | 15 +- .../services_puppetserver.markdown | 8 +- .../status-api/v1/services.markdown | 11 +- .../status-api/v1/simple.markdown | 29 ++-- 9 files changed, 46 insertions(+), 200 deletions(-) delete mode 100644 docs/_openvox-server_8x/http_api_index.markdown diff --git a/_data/nav/openvox-server_8x.yml b/_data/nav/openvox-server_8x.yml index 2ee9947f9..6e642ad06 100644 --- a/_data/nav/openvox-server_8x.yml +++ b/_data/nav/openvox-server_8x.yml @@ -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 diff --git a/docs/_openvox-server_8x/config_file_master.markdown b/docs/_openvox-server_8x/config_file_master.markdown index 6d879149e..738c8b851 100644 --- a/docs/_openvox-server_8x/config_file_master.markdown +++ b/docs/_openvox-server_8x/config_file_master.markdown @@ -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 @@ -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 diff --git a/docs/_openvox-server_8x/http_api_index.markdown b/docs/_openvox-server_8x/http_api_index.markdown deleted file mode 100644 index 31c07ce7e..000000000 --- a/docs/_openvox-server_8x/http_api_index.markdown +++ /dev/null @@ -1,157 +0,0 @@ ---- -layout: default -title: "Puppet Server HTTP API: Index" ---- - -Puppet Server provides several services via HTTP API, and the Puppet agent application uses those services to resolve a node's credentials, retrieve a configuration catalog, retrieve file data, and submit -reports. - -Many of these endpoints are the same as the [Puppet HTTP API](https://puppet.com/docs/puppet/latest/http_api/http_api_index.html). - -## V1/V2 HTTP APIs (removed) - -The V1 and V2 APIs were removed in Puppet 4.0.0. The routes that were previously under `/` or `/v2.0` can now be found under the [`/puppet/v3`](#puppet-v3-http-api) API or [`/puppet-ca/v1`](#ca-v1-http-api) -API. - -Starting with Puppet Server 2.1, Server provides both the current and previous API endpoints, and can serve nodes running Puppet agent 3.x and 4.x. However, Rack masters, WEBrick masters, and Puppet Server 2.0 -cannot serve nodes running Puppet 3.x. - -## Puppet and Puppet CA APIs - -Beginning with Puppet 4, Puppet's HTTP API was split into two separately versioned APIs: - -- An API for configuration-related services -- An API for the certificate authority (CA). - -All configuration endpoints are prefixed with `/puppet`, while all CA endpoints are prefixed with `/puppet-ca`. All endpoints are explicitly versioned: the prefix is always immediately followed by a string like -`/v3` (a directory separator, the letter `v`, and the version number of the API). - -### Authorization - -Authorization for `/puppet` and `/puppet-ca` endpoints is controlled with [Puppet Server's `auth.conf` authorization system](./config_file_auth.html), which differs from Puppet's deprecated `auth.conf` system. - -## Puppet V3 HTTP API - -The Puppet agent application uses several network services to manage systems. These services are all grouped under the `/puppet` API. Other tools can access these services and use the Puppet master's data for -other purposes. - -The V3 API contains endpoints of two types: those that are based on dispatching to Puppet's internal "indirector" framework, and those that are not (namely the [environments endpoint](#environments-endpoint)). - -Every HTTP endpoint that dispatches to the indirector follows the form `/puppet/v3/:indirection/:key?environment=:environment`, where: - -- `:environment` is the name of the environment that should be in effect for the request. Not all endpoints need an environment, but the query parameter must always be specified. -- `:indirection` is the indirection to which the request is dispatched. -- `:key` is the "key" portion of the indirection call. - -Using this API requires significant understanding of how Puppet's internal services are structured, but the following documents specify what is available and how to interact with it. - -### Configuration management services - -The Puppet agent application directly uses these servcies to manage the configuration of a node. - -These endpoints accept payload formats formatted as JSON by default (MIME type of `application/json`), except for `File Content` and `File Bucket File`, which always use `application/octet-stream`. - -> **Note:** Legacy PSON (MIME type of `text/pson`) is still an available format, but should be used only as a fallback for binary content. - -- [Facts](https://puppet.com/docs/puppet/latest/http_api/http_facts.html) -- [Catalog](https://puppet.com/docs/puppet/latest/http_api/http_catalog.html) -- [Node](https://puppet.com/docs/puppet/latest/http_api/http_node.html) -- [File bucket file](https://puppet.com/docs/puppet/latest/http_api/http_file_bucket_file.html) -- [File content](https://puppet.com/docs/puppet/latest/http_api/http_file_content.html) -- [File metadata](https://puppet.com/docs/puppet/latest/http_api/http_file_metadata.html) -- [Report](https://puppet.com/docs/puppet/latest/http_api/http_report.html) - -### Informational services - -These services are not directly used by Puppet agent, but can be used by other tools. - -- [Status](https://puppet.com/docs/puppet/latest/http_api/http_status.html) - -> **Note:** The [Puppet Server status API](#puppet-server-specific-endpoints) provides more detail and features than Puppet's. - -### Environments endpoint - -The `/puppet/v3/environments` endpoint uses a different format than the configuration management and informational services endpoints. - -The endpoint accepts only payloads formatted as JSON, and responds with JSON (MIME type of `application/json`). - -- [Environments](https://puppet.com/docs/puppet/latest/http_api/http_environments.html) - -### Puppet Server-specific endpoints - -Puppet Server adds several unique endpoints of its own. They include these additional `/puppet/v3/` endpoints: - -- [Environment classes](./puppet-api/v3/environment_classes.html), at `/puppet/v3/environment_classes` -- [Environment modules](./puppet-api/v3/environment_modules.html), at `/puppet/v3/environment_modules` -- [Static file content](./puppet-api/v3/static_file_content.html), at `/puppet/v3/static_file_content` - -It also includes these unique APIs, with endpoints containing other URL prefixes: - -- [Status API](./status-api/v1/services.html), at `/status/v1/services` -- [Metrics v1 (mbeans) API](./metrics-api/v1/metrics_api.html), at `/metrics/v1/mbeans` -- [Metrics v2 (Jolokia) API](./metrics-api/v2/metrics_api.html), at `/metrics/v2/` -- Admin API, at `/puppet-admin-api/v1/`: - - [Environment cache](./admin-api/v1/environment-cache.html), at `/puppet-admin-api/v1/environment-cache` - - [JRuby pool](./admin-api/v1/jruby-pool.html), at `/puppet-admin-api/v1/jruby-pool` - -### Error responses - -The `environments` endpoint responds to error conditions in a uniform manner and uses standard HTTP response codes to signify those errors. - -| Request problem | HTTP API error response code | -| --------------- | ---------------------------- | -| Client submits malformed request | 400 Bad Request | -| Unauthorized client | 403 Not Authorized | -| Client uses an HTTP method not permitted for the endpoint | 405 Method Not Allowed | -| Client requests a response in a format other than JSON | 406 Unacceptable | -| Server encounters an unexpected error while handling a request | 500 Server Error | -| Server can't find an endpoint handler for an HTTP request | 404 Not Found | - -Except for HEAD requests, error responses contain a body of a uniform JSON object with the following properties: - -- `message`: (`String`) A human-readable message explaining the error. -- `issue_kind`: (`String`) A unique label to identify the error class. - -Puppet provides a [JSON schema for error objects](https://puppet.com/docs/puppet/latest/schemas/error.json). Endpoints implemented by Puppet Server have a different error schema: - -```json -{ - "msg": "", - "kind": "" -} -``` - -## CA V1 HTTP API - -The certificate authority (CA) API contains all of the endpoints supporting Puppet's public key infrastructure (PKI) system. - -The CA V1 endpoints share the same basic format as the Puppet V3 API, because they are based on the interface of Puppet's indirector-based CA. However, Puppet Server's CA is implemented in Clojure. Both have a -different prefix and version than the V3 API. - -These endpoints follow the form `/puppet-ca/v1/:indirection/:key?environment=:environment`, where: - -- `:environment` is an arbitrary placeholder word, required for historical reasons. No CA endpoints actually use an environment, but the query parameter must always be specified. -- `:indirection` is the indirection to which the request is dispatched. -- `:key` is the "key" portion of the indirection call. - -As with the Puppet V3 API, using this API requires a significant amount of understanding of how Puppet's internal services are structured. The following documents specify what is available and how to interact -with it. - -### SSL certificate-related services - -These endpoints accept only plain-text payload formats. Historically, Puppet has used the MIME type `s` to mean `text/plain`. In Puppet 5, it always uses `text/plain`, but continues to accept `s` as an -equivalent. - -- [Certificate](./http_certificate.html) -- [Certificate Signing Requests](./http_certificate_request.html) -- [Certificate Status](./http_certificate_status.html) -- [Certificate Revocation List](./http_certificate_revocation_list.html) - -## Serialization formats - -Puppet sends messages using several serialization formats. Not all REST services support all of the formats. - -- [JSON](https://tools.ietf.org/html/rfc7159) -- [PSON](https://puppet.com/docs/puppet/latest/http_api/pson.html) - -`YAML` was supported in earlier versions of Puppet, but is no longer for security reasons. diff --git a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown index 7171949cd..636936afa 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown @@ -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 diff --git a/docs/_openvox-server_8x/puppet-api/v4/catalog.json b/docs/_openvox-server_8x/puppet-api/v4/catalog.json index ce6ae94b8..c6fae4b73 100644 --- a/docs/_openvox-server_8x/puppet-api/v4/catalog.json +++ b/docs/_openvox-server_8x/puppet-api/v4/catalog.json @@ -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.", diff --git a/docs/_openvox-server_8x/puppet-api/v4/catalog.markdown b/docs/_openvox-server_8x/puppet-api/v4/catalog.markdown index 89d8a71f2..8e53432bd 100644 --- a/docs/_openvox-server_8x/puppet-api/v4/catalog.markdown +++ b/docs/_openvox-server_8x/puppet-api/v4/catalog.markdown @@ -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 @@ -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) @@ -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` @@ -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). diff --git a/docs/_openvox-server_8x/services_puppetserver.markdown b/docs/_openvox-server_8x/services_puppetserver.markdown index c2cf023d8..014f67919 100644 --- a/docs/_openvox-server_8x/services_puppetserver.markdown +++ b/docs/_openvox-server_8x/services_puppetserver.markdown @@ -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: @@ -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. @@ -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 @@ -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. diff --git a/docs/_openvox-server_8x/status-api/v1/services.markdown b/docs/_openvox-server_8x/status-api/v1/services.markdown index 2ff1d48ee..3d38e36f7 100644 --- a/docs/_openvox-server_8x/status-api/v1/services.markdown +++ b/docs/_openvox-server_8x/status-api/v1/services.markdown @@ -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. @@ -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 @@ -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` @@ -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 diff --git a/docs/_openvox-server_8x/status-api/v1/simple.markdown b/docs/_openvox-server_8x/status-api/v1/simple.markdown index 8c81eaeb5..0978ebdd5 100644 --- a/docs/_openvox-server_8x/status-api/v1/simple.markdown +++ b/docs/_openvox-server_8x/status-api/v1/simple.markdown @@ -1,13 +1,12 @@ --- layout: default -title: "Puppet Server: Status API: Simple" -canonical: "/puppetserver/latest/status-api/v1/simple.html" +title: "OpenVox Server: Status API: Simple" --- [`auth.conf`]: ../../config_file_auth.html -The `simple` endpoint of Puppet Server's Status API provides a simple -indication of whether Puppet Server is running on a server. It's designed for +The `simple` endpoint of OpenVox Server's Status API provides a simple +indication of whether OpenVox Server is running on a server. It's designed for load balancers that don't support any kind of JSON parsing or parameter setting and returns a simple string body (either the state of the server or a simple error message) and a status code relevant to the result. @@ -16,8 +15,6 @@ The content type for this endpoint is `text/plain; charset=utf-8`. ## `GET /status/v1/simple` -(Introduced in Puppet Server 2.6.0) - ### Supported HTTP methods GET @@ -32,22 +29,20 @@ None ### Response -The `simple` endpoint's response consists of a single word describing Puppet -Server's status: +The `simple` endpoint's response consists of a single word describing OpenVox Server's status: -- `running`, if and only if the Puppet Server service is running -- `error`, if the service reports an error -- `unknown`, if the service reports an unknown state, but doesn't report an - error +- `running`, if and only if the OpenVox Server service is running +- `error`, if the service reports an error +- `unknown`, if the service reports an unknown state, but doesn't report an error Requests to this endpoint return one of the following status codes: -- 200 if and only if the Puppet Server service reports a status of running -- 503 if the service's status is unknown or error +- 200 if and only if the OpenVox Server service reports a status of running +- 503 if the service's status is unknown or error ### Example request and response for a GET request -``` +```text GET /status/v1/simple HTTP/1.1 200 OK @@ -59,9 +54,7 @@ running ### Authorization Requests to the `simple` 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 processes and configuration settings, see 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 From 0130a6393ea673236f5a967e759b459baa951adb Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sun, 17 May 2026 12:27:10 +0200 Subject: [PATCH 2/4] Update broken links Signed-off-by: Martin Alfke --- docs/_openvox-server_8x/config_file_master.markdown | 4 ++-- .../puppet-api/v3/environment_classes.markdown | 10 +++++----- .../puppet-api/v3/environment_modules.markdown | 2 +- .../puppet-api/v3/environment_transports.markdown | 2 +- .../puppet-api/v3/file_content.markdown | 2 +- .../puppet-api/v3/static_file_content.markdown | 10 +++++----- docs/_openvox-server_8x/services_puppetserver.markdown | 8 ++++---- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/_openvox-server_8x/config_file_master.markdown b/docs/_openvox-server_8x/config_file_master.markdown index 738c8b851..91e3de3d9 100644 --- a/docs/_openvox-server_8x/config_file_master.markdown +++ b/docs/_openvox-server_8x/config_file_master.markdown @@ -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](../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. +[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 diff --git a/docs/_openvox-server_8x/puppet-api/v3/environment_classes.markdown b/docs/_openvox-server_8x/puppet-api/v3/environment_classes.markdown index d8a5bd277..45f8939f4 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/environment_classes.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/environment_classes.markdown @@ -3,11 +3,11 @@ layout: default title: "OpenVox Server: Puppet API: Environment Classes" --- -[classes]: ../../../../openvox/latest/lang_classes.html -[node definitions]: ../../../../openvox/latest/lang_node_definitions.html -[defined types]: ../../../../openvox/latest/lang_defined_types.html -[`environment_timeout`]: ../../../../openvox/latest/config_file_environment.html#environmenttimeout -[`manifest` setting]: ../../../../openvox/latest/config_file_environment.html#manifest +[classes]: /openvox/latest/lang_classes.html +[node definitions]: /openvox/latest/lang_node_definitions.html +[defined types]: /openvox/latest/lang_defined_types.html +[`environment_timeout`]: /openvox/latest/config_file_environment.html#environmenttimeout +[`manifest` setting]: /openvox/latest/config_file_environment.html#manifest [`auth.conf`]: ../../config_file_auth.html [environment cache API]: ../../admin-api/v1/environment-cache.html [Etag]: https://tools.ietf.org/html/rfc7232#section-2.3 diff --git a/docs/_openvox-server_8x/puppet-api/v3/environment_modules.markdown b/docs/_openvox-server_8x/puppet-api/v3/environment_modules.markdown index f01c608cd..6b0e1d5ab 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/environment_modules.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/environment_modules.markdown @@ -142,7 +142,7 @@ The environment must be purely alphanumeric, not 'bog|us' ### No metadata.json file -If your modules do not have a [metadata.json](../../../../openvox/latest/modules_metadata.html) +If your modules do not have a [metadata.json](/openvox/latest/modules_metadata.html) file, OpenVox Server will not be able to determine the version of your module. In this case, OpenVox Server will return a null value for `version` in the response body. diff --git a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown index 636936afa..d1152198c 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown @@ -3,7 +3,7 @@ layout: default title: "OpenVox Server: Puppet API: Environment Transports" --- -[HTTP API]: ../../../openvox/latest/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 diff --git a/docs/_openvox-server_8x/puppet-api/v3/file_content.markdown b/docs/_openvox-server_8x/puppet-api/v3/file_content.markdown index 385375b49..fe2d82cbe 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/file_content.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/file_content.markdown @@ -7,7 +7,7 @@ The `file_content` endpoint returns contents of the specified file. ## `GET /puppet/v3/file_content/:mount_point/:module/:file-path?environment=:environment` -When specifying environment see the [OpenVox API docs](../../../../openvox/latest/http_api/http_file_content.html) +When specifying environment see the [OpenVox API docs](/openvox/latest/http_api/http_file_content.html) ## `GET /puppet/v3/file_content/:mount_point/:module/:file-path?project=:project-ref diff --git a/docs/_openvox-server_8x/puppet-api/v3/static_file_content.markdown b/docs/_openvox-server_8x/puppet-api/v3/static_file_content.markdown index af5b60293..a71a10f6a 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/static_file_content.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/static_file_content.markdown @@ -4,10 +4,10 @@ title: "OpenVox Server: Puppet API: Static File Content" --- [`code-content-command`]: ../../config_file_puppetserver.html -[static catalog]: ../../../../openvox/latest/static_catalogs.html -[catalog]: ../../../../openvox/latest/subsystem_catalog_compilation.html -[file resource]: ../../../../openvox/latest/type.html#file -[environment]: ../../../../openvox/latest/environments_about.html +[static catalog]: /openvox/latest/static_catalogs.html +[catalog]: /openvox/latest/subsystem_catalog_compilation.html +[file resource]: /openvox/latest/type.html#file +[environment]: /openvox/latest/environments_about.html [`auth.conf`]: ../../config_file_auth.html The `static_file_content` endpoint returns the standard output of a @@ -73,7 +73,7 @@ This endpoint returns an error (status 500) if the [`code-content-command`][] se > **Note:** The `code-content-command` and `code-id-command` scripts are not provided in a > default installation or upgrade. For more information about these scripts, see the -> [static catalog documentation](../../../../openvox/latest/static_catalogs.html). +> [static catalog documentation](/openvox/latest/static_catalogs.html). #### Authorization diff --git a/docs/_openvox-server_8x/services_puppetserver.markdown b/docs/_openvox-server_8x/services_puppetserver.markdown index 014f67919..c2cf023d8 100644 --- a/docs/_openvox-server_8x/services_puppetserver.markdown +++ b/docs/_openvox-server_8x/services_puppetserver.markdown @@ -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: @@ -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. @@ -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 @@ -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. From e75c8206d3acfef122101f415ee59d1c179353b1 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sun, 17 May 2026 13:19:35 +0200 Subject: [PATCH 3/4] Update docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown Co-authored-by: Michael Harp Signed-off-by: Martin Alfke --- .../puppet-api/v3/environment_transports.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown index d1152198c..ce8b0904b 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown @@ -3,7 +3,7 @@ layout: default title: "OpenVox Server: Puppet API: Environment Transports" --- -[HTTP API]: /openvox/latest/http_api_index.html +/openvox/latest/http_api/http_api_index.html [environment cache API]: ../../admin-api/v1/environment-cache.html [environment classes API]: ./environment_classes.html [transports schema]: ./environment_transports.json From efae59389ee7564467a22e6eef7d7ec986643c85 Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Sun, 17 May 2026 13:52:10 +0200 Subject: [PATCH 4/4] fix link Signed-off-by: Martin Alfke --- .../puppet-api/v3/environment_transports.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown index ce8b0904b..e441ce702 100644 --- a/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown +++ b/docs/_openvox-server_8x/puppet-api/v3/environment_transports.markdown @@ -3,7 +3,7 @@ layout: default title: "OpenVox Server: Puppet API: Environment Transports" --- -/openvox/latest/http_api/http_api_index.html +[HTTP API]: /openvox/latest/http_api/http_api_index.html [environment cache API]: ../../admin-api/v1/environment-cache.html [environment classes API]: ./environment_classes.html [transports schema]: ./environment_transports.json