You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: repoint puppet.com/docs links to OpenVox equivalents (openvox, openvox-server)
In the openvox and openvox-server collections:
- Repoint puppet.com/docs links to OpenVox-hosted equivalents. Within a
collection these are relative (page.html); across collections they're
absolute (/openvox/latest/page.html), per CONTRIBUTING. Includes the
openvox_strings / configuration / lang_reserved renames, and two
anchors corrected to the OpenVox page versions (#environment_timeout,
about_agent#what-openvox-agent-provides). The PE "512MB per JRuby"
sizing reference now points at the OpenVox Server tuning_guide.
- Point the style-guide PDK link at /pdk.html (the OpenVox-hosted PDK
page) instead of puppet.com.
- Remove dead Puppet Enterprise references pointing at puppet.com PE docs
OpenVox doesn't have: the PE-orchestrator related-topics entry in
puppet_tasks.md, the PE-only reload note in restarting.markdown, and
the PE PuppetDB-load-balancer pointer in the SSL virtual-IPs page.
After this, openvox and openvox-server have no puppet.com/docs links.
The other collections (openfact, openvoxdb, ecosystem, openvox-containers)
have none either; openbolt is handled in a separate PR.
Verified: jekyll build passes; every repointed internal target and anchor
resolves; catalog.json still valid JSON (a stable committed file, not
regenerated).
Part of #295
Signed-off-by: Michael Harp <mike@mikeharp.com>
Copy file name to clipboardExpand all lines: docs/_openvox-server_8x/ca-api/v1/http_certificate_status.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ Change the status of the specified certificate. The desired state
40
40
is sent in the body of the PUT request as a one-item PSON hash; the two
41
41
allowed complete hashes are:
42
42
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.
44
44
*`{"desired_state":"revoked"}` (for revoking a certificate, similar to
Copy file name to clipboardExpand all lines: docs/_openvox-server_8x/external_ssl_termination.markdown
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Note: This assumes the default behavior of Puppet 5 and greater of using Puppet
26
26
>
27
27
> 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,
28
28
> 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.
30
30
>
31
31
> 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
32
32
> 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.
Copy file name to clipboardExpand all lines: docs/_openvox-server_8x/puppet_server_metrics_performance.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ For real-world catalogs, you can generally add an absolute minimum of 15MB for e
69
69
compilation to compiling a catalog for a basic role that installs Tomcat and Postgres servers.
70
70
71
71
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
73
73
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.
74
74
75
75
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
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
15
15
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:
46
46
47
47
systemctl reload puppetserver
48
48
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
-
53
49
## Restarting Puppet Server to pick up changes
54
50
55
51
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
81
77
82
78
> 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
83
79
> `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).
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.
10
8
11
9
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
35
33
36
34
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.
37
35
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
-
41
36
### Alternate Workaround
42
37
43
38
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.
Copy file name to clipboardExpand all lines: docs/_openvox_8x/READMEtemplate.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Include usage examples for common use cases in the **Usage** section. Show your
45
45
46
46
## Reference
47
47
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)
49
49
50
50
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.
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.
11
10
@@ -19,4 +18,3 @@ Related topics:
19
18
20
19
*[Writing tasks and plans][writing]
21
20
*[Running tasks and plans with Bolt][bolt]
22
-
*[Running tasks with the PE orchestrator][pe_tasks]
Copy file name to clipboardExpand all lines: docs/_openvox_8x/services_agent_windows.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -165,4 +165,4 @@ In addition to local logging, OpenVox agent submits a [report][] to the OpenVox
165
165
166
166
### Setting Puppet Agent CPU priority
167
167
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