Skip to content
Draft
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
Original file line number Diff line number Diff line change
Expand Up @@ -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-server/latest/http_file_content.html).
When specifying environment see the [OpenVox API docs](../../http_file_content.html).

## `GET /puppet/v3/file_content/:mount_point/:module/:file-path?project=:project-ref`

Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox-server_8x/subcommands.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Because these commands are shipped as a gem alongside Puppet Server, it can be u

**Note:** These commands are available in Puppet 5, but in order to use them, you must update Puppet Server’s `auth.conf` to include a rule allowing the master’s certname to access the `certificate_status` and
`certificate_statuses` endpoints. The same applies to upgrading in open source Puppet: if you're upgrading from Puppet 5 to Puppet 6 and are not regenerating your CA, you must whitelist the master’s certname.
See [Puppet Server Configuration Files: auth.conf](/openvox-server/latest/config_file_auth.html) for details on how to use `auth.conf`.
See [Puppet Server Configuration Files: auth.conf](config_file_auth.html) for details on how to use `auth.conf`.

Example:

Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox-server_9x/subcommands.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Because these commands are shipped as a gem alongside Puppet Server, it can be u

**Note:** These commands are available in Puppet 5, but in order to use them, you must update Puppet Server’s `auth.conf` to include a rule allowing the master’s certname to access the `certificate_status` and
`certificate_statuses` endpoints. The same applies to upgrading in open source Puppet: if you're upgrading from Puppet 5 to Puppet 6 and are not regenerating your CA, you must whitelist the master’s certname.
See [Puppet Server Configuration Files: auth.conf](./config_file_auth.html) for details on how to use `auth.conf`.
See [Puppet Server Configuration Files: auth.conf](config_file_auth.html) for details on how to use `auth.conf`.

Example:

Expand Down
7 changes: 2 additions & 5 deletions docs/_openvox_8x/custom_types.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ title: Custom Types
[module]: modules_fundamentals.html
[custom_functions]: lang_write_functions_in_puppet.html
[custom_facts]: /openfact/latest/custom_facts.html
[pluginsync]: configuration.html#pluginsync
[symbol]: http://www.ruby-doc.org/core/Symbol.html
[ruby_block]: http://www.robertsosinski.com/2008/12/21/understanding-ruby-blocks-procs-and-lambdas/
[markdown]: http://commonmark.org/
Expand Down Expand Up @@ -42,11 +41,9 @@ To use new types and providers, two conditions must be met:
1. The type and providers must be present in a [module][] on the OpenVox Server server. Like other types of plugin (such as [custom functions][custom_functions] and [custom facts][custom_facts]), they should go in the module's `lib` directory:
* Type files should be located at `lib/puppet/type/<TYPE NAME>.rb`.
* Provider files should be located at `lib/puppet/provider/<TYPE NAME>/<PROVIDER NAME>.rb`.
2. If you are using an agent/master Puppet deployment, each agent node must have its [`pluginsync` setting][pluginsync] in puppet.conf set to `true`.
* Starting in Puppet 3.0, this setting defaults to true.
* In Puppet 2.x, it defaults to false and must be explicitly enabled.
2. In an agent/server deployment, agent nodes automatically sync plugins (including custom types and providers) from the server's modules at the start of each run, so no configuration is needed. (The old `pluginsync` setting that once controlled this no longer exists in OpenVox.)

In masterless Puppet using puppet apply, pluginsync is not required, but the module containing the type and providers must be present on each node.
When running without a server using puppet apply, plugin sync is not involved, but the module containing the type and providers must be present on each node.

See [the Plugins In Modules page](./plugins_in_modules.html) for more details on distributing custom types and facts via modules.

Expand Down
4 changes: 2 additions & 2 deletions docs/_openvox_8x/format_report.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ happened during the run: the status of every resource, the events Puppet applied
produced, and metrics about the run as a whole. That object is what [report processors][report processors]
receive, and it is what OpenVox serializes when it sends a report to a server or writes one to disk.

This page describes **report format 12**, which OpenVox 8 produces. Use it when you write a
This page describes **report format 12**, which OpenVox 8 and later produce. Use it when you write a
[custom report processor][custom report processor] or consume reports from another tool. For an
introduction to how reporting works, see [About reporting][about reporting].

Expand Down Expand Up @@ -73,7 +73,7 @@ run:
| `time` | String | When the run started, in ISO 8601 format with a nine-digit second fraction. |
| `configuration_version` | Integer or String | The configuration version of the catalog. An integer of seconds since the epoch unless you set your own versioning scheme. |
| `transaction_uuid` | String | A UUID identifying the transaction. The agent sends the same UUID when it requests the catalog, which lets you connect a catalog to its report. |
| `report_format` | Integer | The report format version. `12` in OpenVox 8. |
| `report_format` | Integer | The report format version. `12` in OpenVox 8 and later. |
| `puppet_version` | String | The version of OpenVox that produced the report. |
| `status` | String | The outcome of the run: `failed`, `changed`, or `unchanged`. |
| `transaction_completed` | Boolean | Whether the transaction finished evaluating without an unhandled exception. |
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_8x/install_osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ These instructions cover installing `openvox-agent` on macOS systems.
1. Before installing `openvox-agent`, read the [pre-install tasks](./install_pre.html).

2. Download the current macOS package from
<https://downloads.voxpupuli.org/mac>.
<https://downloads.voxpupuli.org/mac/openvox8/>.

The macOS package bundles the runtime it needs, so you do not need to install
Ruby or other OpenVox dependencies separately.
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_8x/install_windows.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: "Installing OpenVox agent: Microsoft Windows"
---

[downloads]: https://downloads.voxpupuli.org/windows
[downloads]: https://downloads.voxpupuli.org/windows/openvox8/

Install `openvox-agent` on Microsoft Windows nodes.

Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_8x/lang_relationships.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -320,4 +320,4 @@ err: Could not apply complete catalog: Found 1 dependency cycle:
Try the '--graph' option and opening the resulting '.dot' file in OmniGraffle or GraphViz
```

To locate the directory containing the graph files, run `puppet agent --configprint graphdir`.
To locate the directory containing the graph files, run `puppet config print graphdir`.
4 changes: 2 additions & 2 deletions docs/_openvox_8x/openvox_platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ title: "OpenVox repositories and packages"
[downloads_page]: https://voxpupuli.org/openvox/install/
[apt_repo]: https://apt.voxpupuli.org
[yum_repo]: https://yum.voxpupuli.org
[windows_downloads]: https://downloads.voxpupuli.org/windows
[mac_downloads]: https://downloads.voxpupuli.org/mac
[windows_downloads]: https://downloads.voxpupuli.org/windows/openvox8/
[mac_downloads]: https://downloads.voxpupuli.org/mac/openvox8/

Use the OpenVox repositories to install the package set that matches your platform.
The public install guide on Vox Pupuli is the best source for current repository
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_8x/services_commands_windows.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Take note of the following when running Puppet commands on Windows:
- The `puppet.conf` configuration file supports Windows and *nix line endings, (CR-LF) and (LF), respectively, and does not support Byte Order Mark (BOM). The file encoding must either be UTF-8 or the current Windows encoding, for example, Windows-1252 code page.
- Specifying file owner, group, or mode for file-based settings is not supported on Windows
- The `puppet.conf` file is allowed to use Windows-CRLF line endings as well as *nix-style LF line endings.
- You can get configuration settings by running: `puppet agent --configprint SETTING`
- You can get configuration settings by running: `puppet config print SETTING`
- You can set configuration settings by running: `puppet config set SETTING VALUE --section SECTION`
- Common configuration settings are: `certname`, `server`, and `runinterval`
- You must restart the Puppet Agent service after making any changes to Puppet’s `runinterval` config file.
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_8x/ssl_custom_ca_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This directory is OpenVox Ruby's `DEFAULT_CERT_DIR` and is included by `set_defa
on every connection. The directory is empty by default — the `openvox-agent` package does
not place any files there — so user-added files survive package upgrades.

> **Note:** `openssl rehash` is not supported on Windows as of OpenVox 8. Use the
> **Note:** `openssl rehash` is not available on Windows. Use the
> `SSL_CERT_FILE` approach below on Windows nodes.

If you prefer a one-liner that skips rehash, appending directly to `cert.pem` also works,
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_9x/custom_types.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To use new types and providers, two conditions must be met:
1. The type and providers must be present in a [module][] on the OpenVox Server server. Like other types of plugin (such as [custom functions][custom_functions] and [custom facts][custom_facts]), they should go in the module's `lib` directory:
* Type files should be located at `lib/puppet/type/<TYPE NAME>.rb`.
* Provider files should be located at `lib/puppet/provider/<TYPE NAME>/<PROVIDER NAME>.rb`.
2. In an agent/server deployment, agent nodes automatically sync plugins (including custom types and providers) from the server's modules at the start of each run, so no configuration is needed. (The old `pluginsync` setting that controlled this was removed in OpenVox 9.)
2. In an agent/server deployment, agent nodes automatically sync plugins (including custom types and providers) from the server's modules at the start of each run, so no configuration is needed. (The old `pluginsync` setting that once controlled this no longer exists in OpenVox.)

When running without a server using puppet apply, plugin sync is not involved, but the module containing the type and providers must be present on each node.

Expand Down
4 changes: 2 additions & 2 deletions docs/_openvox_9x/format_report.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ happened during the run: the status of every resource, the events Puppet applied
produced, and metrics about the run as a whole. That object is what [report processors][report processors]
receive, and it is what OpenVox serializes when it sends a report to a server or writes one to disk.

This page describes **report format 12**, which OpenVox 8 produces. Use it when you write a
This page describes **report format 12**, which OpenVox 8 and later produce. Use it when you write a
[custom report processor][custom report processor] or consume reports from another tool. For an
introduction to how reporting works, see [About reporting][about reporting].

Expand Down Expand Up @@ -73,7 +73,7 @@ run:
| `time` | String | When the run started, in ISO 8601 format with a nine-digit second fraction. |
| `configuration_version` | Integer or String | The configuration version of the catalog. An integer of seconds since the epoch unless you set your own versioning scheme. |
| `transaction_uuid` | String | A UUID identifying the transaction. The agent sends the same UUID when it requests the catalog, which lets you connect a catalog to its report. |
| `report_format` | Integer | The report format version. `12` in OpenVox 8. |
| `report_format` | Integer | The report format version. `12` in OpenVox 8 and later. |
| `puppet_version` | String | The version of OpenVox that produced the report. |
| `status` | String | The outcome of the run: `failed`, `changed`, or `unchanged`. |
| `transaction_completed` | Boolean | Whether the transaction finished evaluating without an unhandled exception. |
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_9x/openvox_platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ OpenVox publishes packages through these channels:
- Windows downloads: [downloads.voxpupuli.org/windows][windows_downloads]
- macOS downloads: [downloads.voxpupuli.org/mac][mac_downloads]

On Linux systems, install the appropriate `openvox8-release` package for your
On Linux systems, install the appropriate `openvox9-release` package for your
distribution first. That package configures the repository and its signing keys.

## Package names
Expand Down
2 changes: 1 addition & 1 deletion docs/_openvox_9x/ssl_custom_ca_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This directory is OpenVox Ruby's `DEFAULT_CERT_DIR` and is included by `set_defa
on every connection. The directory is empty by default — the `openvox-agent` package does
not place any files there — so user-added files survive package upgrades.

> **Note:** `openssl rehash` is not supported on Windows as of OpenVox 8. Use the
> **Note:** `openssl rehash` is not available on Windows. Use the
> `SSL_CERT_FILE` approach below on Windows nodes.

If you prefer a one-liner that skips rehash, appending directly to `cert.pem` also works,
Expand Down
Loading