Skip to content

Commit 0fc2b59

Browse files
authored
Merge branch 'master' into docs/retire-ldap-node-classifier-278
2 parents bf7dae4 + 9c786f0 commit 0fc2b59

11 files changed

Lines changed: 73 additions & 72 deletions

File tree

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
---
2+
- release: 8.14.1
3+
jetty: 12.1.10
24
- release: 8.14.0
5+
jetty: 12.1.10
36
- release: 8.13.0
7+
jetty: 10.0.26
48
- release: 8.12.1
9+
jetty: 10.0.26
510
- release: 8.12.0
11+
jetty: 10.0.26

_data/server_release_contents/openvox_8x.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
- release: 8.14.1
3+
jruby: 9.4.12.1
24
- release: 8.14.0
35
jruby: 9.4.12.1
46
- release: 8.13.0

docs/_ecosystem_8x/devkit/migrating.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,22 @@ If you get an error about a command not being available, you probably just need
1616

1717
{% include alert.html type="tip" content="There are a few exceptions to this pattern. For example, Jig is an installed package and VoxBox is a Docker container." %}
1818

19-
| You used to type... | Now you type... |
20-
|---------------------|------------------|
21-
| `pdk new module` | `jig new module` |
22-
| `pdk new class` | `jig new class` |
23-
| `pdk build` | `jig build` |
24-
| `pdk release` | `jig release` |
25-
| `pdk convert` | _not needed_ |
26-
| `pdk update` | `jig update` |
27-
| `pdk validate` | `jig validate` |
28-
| `pdk test unit` | `jig test unit` |
29-
30-
`jig update`, `jig validate`, and `jig test unit` are thin wrappers around `bundle exec msync update`, `bundle exec rake validate lint`, and `bundle exec rake spec` respectively, so they still need the module's gems installed (`bundle install`).
31-
You can keep running the underlying `bundle exec` commands directly if you prefer.
19+
Jig also contains thin wrappers around the `bundle exec` commands, so in many cases you can use the CLI patterns you're used to typing.
20+
Because Jig does not attempt to hide the Bundler environment from you, it will still need the module's gems installed (`bundle install`) and ModuleSync configured properly.
21+
22+
{% include alert.html type="tip" title="Choosing command forms" content="If you want quick and familiar commands to run locally, then use the Jig wrapper commands. If you're running tests and such in CI or if you need to pass custom options then invoke the tools directly." %}
23+
24+
| You used to type... | Now you type... | Or run tools directly... |
25+
|---------------------|------------------|----------------------------------|
26+
| `pdk new module` | `jig new module` | |
27+
| `pdk new class` | `jig new class` | |
28+
| `pdk build` | `jig build` | |
29+
| `pdk release` | `jig release` | |
30+
| `pdk convert` | _not needed_ | |
31+
| `pdk update` | `jig update`* | `bundle exec msync update`* |
32+
| `pdk validate` | `jig validate` | `bundle exec rake validate lint` |
33+
| `pdk test unit` | `jig test unit` | `bundle exec rake spec` |
34+
35+
{% include alert.html type="note" title="*NOTE" content="`pdk update` operates in context of a single module. In contrast, the replacement ModuleSync commands (`jig update` and `bundle exec msync update`) should be run in the template repository to push updates to all your modules at once. [Read more](modulesync.html)." %}
3236

3337
Browse through the individual subpages of this Developer Tooling section to learn more about each component.

docs/_openvox_8x/component_versions.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,10 @@ on its own 5.x line). There is no single "OpenVox platform version" that pins al
2626
of them at once, so each component is shown in its own table, keyed by that
2727
component's release.
2828

29-
The bundled-component columns are **generated** from upstream release metadata (the
30-
per-release SBOMs published by [openvox-sbom-tools][sbom_tools] for the agent and
31-
OpenBolt, and component pins for the server), so they don't drift. Columns that
32-
aren't bundled or pinned anywhere (Java and PostgreSQL) are supported-version
33-
requirements maintained by hand; see the note under each table.
29+
The bundled-component columns are **generated** from the per-release SBOMs published
30+
by [openvox-sbom-tools][sbom_tools] for every component, so they don't drift. Columns
31+
that aren't bundled anywhere (Java and PostgreSQL) are supported-version requirements
32+
maintained by hand; see the note under each table.
3433

3534
<!-- markdownlint-disable MD055 MD056 -->
3635

@@ -48,8 +47,8 @@ changes; this page is only a pointer.
4847

4948
## Server components
5049

51-
These ship with the `openvox-server` package. JRuby is the bundled version,
52-
resolved from the server's pinned `jruby-utils`/`jruby-deps`.
50+
These ship with the `openvox-server` package. JRuby is the bundled version, read
51+
from the server's per-release SBOM.
5352

5453
| OpenVox Server release | JRuby | Java |
5554
| --- | --- | --- |
@@ -67,15 +66,19 @@ OpenVoxDB ships in the `openvoxdb` package on its own release line. The
6766
agents talk to OpenVoxDB) is released in lockstep at the **same version** as
6867
`openvoxdb`, so it is not listed separately.
6968

70-
| OpenVoxDB release | PostgreSQL |
71-
| --- | --- |
72-
{% for r in site.data.openvoxdb_release_contents[nav_key] %}| {{ r.release }} | 11+ (14+ recommended) |
69+
Jetty is the bundled HTTP server, read from the OpenVoxDB SBOM.
70+
71+
| OpenVoxDB release | Jetty | Java | PostgreSQL |
72+
| --- | --- | --- | --- |
73+
{% for r in site.data.openvoxdb_release_contents[nav_key] %}| {{ r.release }} | {{ r.jetty }} | 11, 17 | 11+ (14+ recommended) |
7374
{% endfor %}
7475

75-
> **PostgreSQL is not bundled.** OpenVoxDB connects to a PostgreSQL server you
76-
> install separately (the `puppet-openvoxdb` module can install it for you). The
77-
> PostgreSQL column shows the supported minimum (PostgreSQL 11; version 14 or newer
78-
> recommended), not a per-release pin; see [Configuring PostgreSQL][openvoxdb_postgres].
76+
> **Java and PostgreSQL are not bundled.** OpenVoxDB runs on a JVM and connects to a
77+
> PostgreSQL server you install separately (the `puppet-openvoxdb` module can install
78+
> PostgreSQL for you). The Java column shows the currently supported major versions,
79+
> and the PostgreSQL column the supported minimum (PostgreSQL 11; version 14 or newer
80+
> recommended) — neither is a per-release pin. See
81+
> [Configuring PostgreSQL][openvoxdb_postgres].
7982
8083
## OpenBolt
8184

docs/_openvox_8x/config_important_settings.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ These settings should usually go in `[server]`. However, if you're using Puppet
125125
### Basics
126126

127127
* [`dns_alt_names`][dns_alt_names] --- A list of hostnames the server is allowed to use when acting as an OpenVox Server. The hostname your agents use in their `server` setting **must** be included in either this setting or the master's `certname` setting. Note that this setting is only used when initially generating the OpenVox Server's certificate --- if you need to change the DNS names, you must:
128-
1. Turn off the Puppet server service (or your Rack server).
128+
1. Turn off the Puppet server service.
129129
2. Run `sudo puppetserver ca clean --certname <SERVER'S CERTNAME>`.
130130
3. Run `sudo puppetserver ca generate --certname <SERVER'S CERTNAME> --subject-alt-names <ALT NAME 1>,<ALT NAME 2>,...`.
131131
4. Re-start the Puppet server service.

docs/_openvox_8x/config_print.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ To see the settings the OpenVox Server service would use:
7878
* Specify `--section server`.
7979
* Use the `--environment` option to specify the environment you want settings for, or let it default to `production`.
8080
* Remember to use `sudo`.
81-
* If your OpenVox Server is managed as a rack application (e.g. with Passenger), check the `config.ru` file to make sure it's using the [confdir][] and [vardir][] that you expect. If it's using non-standard ones, you will need to specify them on the command line with the `--confdir` and `--vardir` options; otherwise you might not see the correct values for settings.
81+
* If your OpenVox Server uses a non-standard [confdir][] or [vardir][], specify them on the command line with the `--confdir` and `--vardir` options; otherwise you might not see the correct values for settings.
8282

8383
### Examples
8484

docs/_openvox_8x/dirs_codedir.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ When Puppet is running as either root, a Windows user with administrator privile
2020

2121
The system codedir is what you usually want to use, since you will usually run Puppet's commands and services as root or `puppet`. (Note that admin commands like `puppet module` must be run with `sudo` to use the same codedir as OpenVox agent or OpenVox Server.)
2222

23-
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--codedir` to the system codedir. The example `config.ru` file provided with the Puppet source does this.
24-
2523
### Configuration
2624

2725
The location of the codedir can be configured in puppet.conf with [the `codedir` setting][codedir], but note that Puppet Server doesn't use that setting; it has its own `jruby-puppet.master-code-dir` setting [in puppetserver.conf][puppetserver_conf]. If you're using a non-default codedir, _you must change both settings._

docs/_openvox_8x/dirs_confdir.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ The system confdir is what you usually want to use, since you will usually run P
2121
services as root or `puppet`. (Note that admin commands like `puppetserver ca` must be run with `sudo`
2222
to use the same confdir as OpenVox agent or OpenVox Server.)
2323

24-
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--confdir` to the system confdir. The example `config.ru` file provided with the Puppet source does this.
25-
2624
### Configuration
2725

2826
Puppet's confdir can be specified on the command line with the `--confdir` option, but it can't be set

docs/_openvox_8x/dirs_vardir.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ The system cache directory is what you usually want to use, since you will usual
2424
and services as root or `puppet`. (Note that admin commands like `puppetserver ca` must be run with
2525
`sudo` to use the same directories as OpenVox agent or OpenVox Server.)
2626

27-
> **Note:** When OpenVox Server is running as a Rack application, the `config.ru` file must explicitly set `--vardir` to the system cache directory. The example `config.ru` file provided with the Puppet source does this.
28-
2927
### Configuring the location of the cache directory
3028

3129
You can specify Puppet's cache directory on the command line by using the `--vardir` option, but you can't set it in `puppet.conf`. If `--vardir` isn't specified when a Puppet application is started, it will always use the default cache directory location.

docs/_openvox_8x/static_catalogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The script's standard output becomes the file's `code_content`, provided the scr
117117
Starting in Puppet 4.4 and OpenVox Server 2.3.0, the global `static_catalogs` setting is enabled by default, whether you upgrade Puppet or perform a clean installation.
118118
However, the default configuration doesn't include the `code-id-command` and `code-content-command` scripts or settings needed to produce static catalogs, and even when configured to produce static catalogs OpenVox Server doesn't inline metadata for all types of file resources.
119119

120-
Static catalogs are produced only by OpenVox Server. The Ruby OpenVox server never produces static catalogs, even when served by WEBrick or Passenger.
120+
Static catalogs are produced only by OpenVox Server.
121121

122122
OpenVox Server also won't produce static catalogs for an agent under the following circumstances:
123123

0 commit comments

Comments
 (0)