Skip to content

Commit b08545b

Browse files
authored
Merge pull request #318 from miharp/docs/issue-295-openvox-puppet-links
docs: repoint puppet.com/docs links to OpenVox equivalents (openvox, openvox-server)
2 parents 17f5b54 + 92f0d21 commit b08545b

11 files changed

Lines changed: 18 additions & 29 deletions

docs/_openvox-server_8x/ca-api/v1/http_certificate_status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Change the status of the specified certificate. The desired state
4040
is sent in the body of the PUT request as a one-item PSON hash; the two
4141
allowed complete hashes are:
4242

43-
* `{"desired_state":"signed"}` (for signing a certificate signing request, similar to `puppetserver ca sign`). To set the validity period of the signed certificate, specify the `cert_ttl` key in the body of the request, with an integer value. By default, this key specifies the number of seconds, but you can specify another time unit. See [configuration](https://puppet.com/docs/puppet/latest/configuration.html#configuration-settings) for a list of Puppet's accepted time unit markers.
43+
* `{"desired_state":"signed"}` (for signing a certificate signing request, similar to `puppetserver ca sign`). To set the validity period of the signed certificate, specify the `cert_ttl` key in the body of the request, with an integer value. By default, this key specifies the number of seconds, but you can specify another time unit. See [configuration](/openvox/latest/configuration.html#configuration-settings) for a list of Puppet's accepted time unit markers.
4444
* `{"desired_state":"revoked"}` (for revoking a certificate, similar to
4545
`puppetserver ca revoke`).
4646

docs/_openvox-server_8x/external_ssl_termination.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Note: This assumes the default behavior of Puppet 5 and greater of using Puppet
2626
>
2727
> With `allow-header-cert-info` set to 'true', authorization code will use only the client HTTP header values---not an SSL-layer client certificate---to determine the client subject name, authentication status,
2828
> and trusted facts. This is true even if the web server is hosting an HTTPS connection. This applies to validation of the client via rules in the
29-
> [auth.conf](https://puppet.com/docs/puppet/latest/config_file_auth.html) file and any [trusted facts][trusted] extracted from certificate extensions.
29+
> [auth.conf](/openvox/latest/config_file_auth.html) file and any [trusted facts][trusted] extracted from certificate extensions.
3030
>
3131
> If the `client-auth` setting in the `webserver` config block is set to `need` or `want`, the Jetty web server will still validate the client certificate against a certificate authority store, but it will only
3232
> verify the SSL-layer client certificate---not a certificate in an `X-Client-Cert` header.
@@ -67,4 +67,4 @@ characters must be encoded as `%20` and not `+` characters.
6767
> [SERVER-217](https://tickets.puppetlabs.com/browse/SERVER-217).
6868
6969
[pem format]: /docs/background/ssl/cert_anatomy.html#pem-file
70-
[trusted]: https://puppet.com/docs/puppet/latest/lang_facts_and_builtin_vars.html#trusted-facts
70+
[trusted]: /openvox/latest/lang_facts_and_builtin_vars.html#trusted-facts

docs/_openvox-server_8x/puppet_server_metrics.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: "Monitoring OpenVox Server metrics"
77
[Graphite]: https://graphiteapp.org
88
[Grafana]: http://grafana.org
99
[sample Grafana dashboard]: ./sample-puppetserver-metrics-dashboard.json
10-
[static catalogs]: https://puppet.com/docs/puppet/latest/static_catalogs.html
10+
[static catalogs]: /openvox/latest/static_catalogs.html
1111
[HTTP client metrics]: ./http_client_metrics.html
1212
[`grafanadash`]: https://forge.puppet.com/cprice404/grafanadash
1313
[`metrics.conf`]: ./config_file_metrics.html

docs/_openvox-server_8x/puppet_server_metrics_performance.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ For real-world catalogs, you can generally add an absolute minimum of 15MB for e
6969
compilation to compiling a catalog for a basic role that installs Tomcat and Postgres servers.
7070

7171
Your Puppet-managed infrastructure is probably larger and more complex than that test scenario, and every complication adds more to each additional JRuby's memory requirements. (For instance, we recommend
72-
assuming that OpenVox Server will use [at least 512MB per JRuby](https://puppet.com/docs/pe/latest/configuring/config_puppetserver.html) while under load.) You can calculate a similar value unique to your
72+
assuming that OpenVox Server will use [at least 512MB per JRuby](tuning_guide.html) while under load.) You can calculate a similar value unique to your
7373
infrastructure by measuring `puppetserver` memory usage during your infrastructure's catalog compilations and comparing it to compiling a minimal catalog for a similar number of nodes.
7474

7575
The `jruby-metrics` section of the [status API][] endpoint also lists the `requested-instances`, which shows what requests have come in that are waiting to borrow a JRuby instance. This part of the status

docs/_openvox-server_8x/restarting.markdown

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ canonical: "/puppetserver/latest/restarting.html"
55
---
66

77
[logback.xml]: ./config_file_logbackxml.html
8-
[Hiera]: https://puppet.com/docs/puppet/latest/hiera_intro.html
8+
[Hiera]: /openvox/latest/hiera_intro.html
99
[gems]: ./gems.html
10-
[core dependencies]: https://puppet.com/docs/puppet/latest/about_agent.html#what-are-puppet-agent-and-puppet-server
11-
[environment]: https://puppet.com/docs/puppet/latest/environments_about.html
12-
[environment caching]: https://puppet.com/docs/puppet/latest/configuration.html#environmenttimeout
10+
[core dependencies]: /openvox/latest/about_agent.html#what-openvox-agent-provides
11+
[environment]: /openvox/latest/environments_about.html
12+
[environment caching]: /openvox/latest/configuration.html#environment_timeout
1313

1414
Starting in version 2.3.0, you can restart Puppet Server by sending a hangup signal, also known as a [HUP signal or SIGHUP](https://en.wikipedia.org/wiki/SIGHUP), to the running Puppet Server process. The HUP
1515
signal stops Puppet Server and reloads it gracefully, without terminating the JVM process. This is generally _much_ faster than completely stopping and restarting the process. This allows you to quickly load
@@ -46,10 +46,6 @@ OS distributions which use systemd service configurations:
4646

4747
systemctl reload puppetserver
4848

49-
> **Note:** If you're using Puppet Enterprise (PE), you can reload the server from the command line by running `service pe-puppetserver reload`. However if you need to change a setting, do so in console or with
50-
> Heira, and then the agent will reload the server when it applies the change. For more information, see
51-
> [Configuring and tuning Puppet Server](https://puppet.com/docs/pe/2018.1/config_puppetserver.html#configuring_and_tuning_puppet_server).
52-
5349
## Restarting Puppet Server to pick up changes
5450

5551
There are three ways to trigger your Puppet Server environment to refresh and pick up changes you've made. A request to the [HTTP Admin API to flush the JRuby pool](./admin-api/v1/jruby-pool.html) is the
@@ -81,4 +77,4 @@ For these types of changes, you must restart the process by using the operating
8177

8278
> Note: To ensure that the Puppet master and CA service is running in a platform agnostic way, use the `puppet resource service puppetserver ensure=running` command. This command is equivalent to
8379
> `systemctl start puppetserver` on systems that support it. For more information on the resource command and managing a server’s desired state, see
84-
> [Man Page: puppet resource](https://puppet.com/docs/puppet/6.4/man/resource.html) and [Resource Type: service](https://puppet.com/docs/puppet/6.4/types/service.html).
80+
> [Man Page: puppet resource](/openvox/latest/man/resource.html) and [Resource Type: service](/openvox/latest/types/service.html).

docs/_openvox-server_8x/ssl_server_certificate_change_and_virtual_ips.markdown

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ title: "Puppet Server: Known Issues: SSL Server Certificate Change and Virtual I
44
canonical: "/puppetserver/latest/ssl_server_certificate_change_and_virtual_ips.html"
55
---
66

7-
[pe_db_instructions]: https://puppet.com/docs/pe/2017.2/release_notes_known_issues_puppetdb.html#puppetdb-behind-a-load-balancer-causes-puppet-server-errors
8-
97
Puppet Server can often encounter `server certificate change is restricted` errors when it makes HTTPS requests to a group of load-balanced servers behind a virtual IP address. This page describes the issue, workarounds for the issue, and our future plans for handling the issue.
108

119
The behavior described in this page was identified in [SERVER-207](https://tickets.puppet.com/browse/SERVER-207).
@@ -35,9 +33,6 @@ If you need Puppet Server to act as a client to a load-balanced HTTPS service (e
3533

3634
There appear to be ways to fulfill the renegotiation check with certificates that only partially match ([see here for more info](http://hg.openjdk.java.net/bsd-port/bsd-port/jdk/rev/eabde5c42157#l1.186)), but these might not be foolproof, especially because future JDK implementations might disallow these partial matches. The most reliable way is to simply use the same certificates.
3735

38-
The Puppet Enterprise documentation has [instructions for configuring multiple PuppetDB][pe_db_instructions] servers to use a single certificate, but note that this configuration isn't necessarily supported.
39-
40-
4136
### Alternate Workaround
4237

4338
It's also possible to configure the JDK to allow server certificate changes. You can do this by editing the `/etc/sysconfig/puppetserver` file and adding `-Djdk.tls.allowUnsafeServerCertChange=true` to the value of the `JAVA_ARGS` variable.

docs/_openvox_8x/READMEtemplate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Include usage examples for common use cases in the **Usage** section. Show your
4545

4646
## Reference
4747

48-
This section is deprecated. Instead, add reference information to your code as Puppet Strings comments, and then use Strings to generate a REFERENCE.md in your module. For details on how to add code comments and generate documentation with Strings, see the Puppet Strings [documentation](https://puppet.com/docs/puppet/latest/puppet_strings.html) and [style guide](https://puppet.com/docs/puppet/latest/puppet_strings_style.html)
48+
This section is deprecated. Instead, add reference information to your code as Puppet Strings comments, and then use Strings to generate a REFERENCE.md in your module. For details on how to add code comments and generate documentation with Strings, see the Puppet Strings [documentation](https://docs.openvoxproject.org/openvox/latest/openvox_strings.html) and [style guide](https://docs.openvoxproject.org/openvox/latest/openvox_strings_style.html)
4949

5050
If you aren't ready to use Strings yet, manually create a REFERENCE.md in the root of your module directory and list out each of your module's classes, defined types, facts, functions, Puppet tasks, task plans, and resource types and providers, along with the parameters for each.
5151

docs/_openvox_8x/puppet_tasks.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ layout: default
33
title: "Puppet tasks"
44
---
55

6-
[writing]: https://puppet.com/docs/bolt/0.x/writing_tasks_and_plans.html
7-
[bolt]: https://puppet.com/docs/bolt/0.x/bolt.html
8-
[pe_tasks]: https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html
6+
[writing]: /openbolt/latest/writing_tasks.html
7+
[bolt]: /openbolt/latest/getting_started_with_bolt.html
98

109
Puppet tasks are single, ad hoc actions that you can run on target machines in your infrastructure, allowing you to make as-needed changes to remote systems. You can run tasks with the Puppet Enterprise orchestrator or with Puppet's standalone task runner, Bolt.
1110

@@ -19,4 +18,3 @@ Related topics:
1918

2019
* [Writing tasks and plans][writing]
2120
* [Running tasks and plans with Bolt][bolt]
22-
* [Running tasks with the PE orchestrator][pe_tasks]

docs/_openvox_8x/schemas/catalog.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"type": "object",
66
"properties": {
77
"tags": {
8-
"description": "Tags: regex is from https://puppet.com/docs/puppet/latest/lang_reserved.html",
8+
"description": "Tags: regex is from https://docs.openvoxproject.org/openvox/latest/lang_reserved.html",
99
"type": "array",
1010
"items": {
1111
"type": "string",
@@ -59,15 +59,15 @@
5959
}
6060
},
6161
"tags": {
62-
"description": "Tags: regex is from https://puppet.com/docs/puppet/latest/lang_reserved.html",
62+
"description": "Tags: regex is from https://docs.openvoxproject.org/openvox/latest/lang_reserved.html",
6363
"type": "array",
6464
"items": {
6565
"type": "string",
6666
"pattern": "\\A[[:alnum:]_][[:alnum:]_:.-]*\\Z"
6767
}
6868
},
6969
"parameters": {
70-
"description": "Parameters: regex is from https://puppet.com/docs/puppet/latest/lang_reserved.html",
70+
"description": "Parameters: regex is from https://docs.openvoxproject.org/openvox/latest/lang_reserved.html",
7171
"type": "object",
7272
"patternProperties": {
7373
"^[a-z][a-z0-9_]*$": {}

docs/_openvox_8x/services_agent_windows.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,4 +165,4 @@ In addition to local logging, OpenVox agent submits a [report][] to the OpenVox
165165

166166
### Setting Puppet Agent CPU priority
167167

168-
When CPU usage is high, try lowering the priority of the Puppet Agent service. This can be achieved using the [process priority setting](https://puppet.com/docs/puppet/latest/configuration.html#priority), a cross platform configuration option. This can also be set in the OpenVox Server.
168+
When CPU usage is high, try lowering the priority of the Puppet Agent service. This can be achieved using the [process priority setting](configuration.html#priority), a cross platform configuration option. This can also be set in the OpenVox Server.

0 commit comments

Comments
 (0)