Skip to content

Commit dfa2532

Browse files
committed
NMS-19060: Cleanup docs build for CentOS 10 support
* Fix includes and removed duplicate include for CentOS 9 and 10. * Simplify variables for compatible versions used in the system requirements. * Fixed build warnings for Kafka topic placeholders and masquarded them so that they are not tried to be resolved as an Antora variable. Signed-off-by: Ronny Trommer <ronny@no42.org>
1 parent a80a96c commit dfa2532

File tree

6 files changed

+53
-50
lines changed

6 files changed

+53
-50
lines changed

docs/antora.yml

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,12 @@ asciidoc:
77
package-prefix: opennms
88
experimental: true
99
source-language: asciidoc@
10-
xrefstyle: short@
11-
compatible-centos7: '7.x'
12-
compatible-centos-stream9: '9.x'
13-
compatible-centos-stream10: '10.x'
14-
compatible-rhel7: '7.x'
15-
compatible-rhel8: '8.x'
16-
compatible-rhel9: '9.x'
17-
compatible-rhel10: '10.x'
18-
compatible-ubuntu: '20.04 LTS'
19-
compatible-debian: '9 - 11'
20-
compatible-rocky-linux: '9.x'
10+
xrefstyle: short@´
11+
compatible-centos: '9.x, 10.x'
12+
compatible-rhel: '8.x, 9.x, 10.x'
13+
compatible-ubuntu: '20.04 LTS - 24.04 LTS'
14+
compatible-debian: '9 - 12'
15+
compatible-rocky-linux: '9.x, 10.x'
2116
compatible-opennms-plugin: '9 - 11.2'
2217
compatible-oia: '1.6.1'
2318
compatible-cassandra: '4.17.0'
@@ -27,9 +22,9 @@ asciidoc:
2722
compatible-postgresql: '13.x - 15.x'
2823
compatible-rrdtool: '1.7.x'
2924
jasperreportsversion: '6.3.0'
30-
latest-meridian-stable: '2023'
25+
latest-meridian-stable: '2025'
3126
postgresql-version: '15'
32-
jmx-prom-exporter-version: '1.3.0'
27+
jmx-prom-exporter-version: '1.4.0'
3328
nav:
3429
- modules/ROOT/nav.adoc
3530
- modules/releasenotes/nav.adoc
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.Add Adoptium repository. See official https://adoptium.net/installation[docs] for more information.
2+
[source, console]
3+
----
4+
sudo bash -c 'cat <<EOF > /etc/yum.repos.d/adoptium.repo
5+
[Adoptium]
6+
name=Adoptium
7+
baseurl=https://packages.adoptium.net/artifactory/rpm/${DISTRIBUTION_NAME:-$(. /etc/os-release; echo $ID)}/\$releasever/\$basearch
8+
enabled=1
9+
gpgcheck=1
10+
gpgkey=https://packages.adoptium.net/artifactory/api/gpg/key/public
11+
EOF'
12+
----
13+
14+
.Install Temurin Java {compatible-javajdk}
15+
[source, console, subs="attributes"]
16+
----
17+
sudo dnf install temurin-{compatible-javajdk}-jdk
18+
----

docs/modules/deployment/pages/core/getting-started.adoc

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
[[getting-started-core]]
33
= Installation and Configuration
4-
:description: Install and configure OpenNMS instance including PostgreSQL set up on CentOS/RHEL 9, Debian/Ubuntu, and Docker.
4+
:description: Install and configure OpenNMS instance including PostgreSQL set up on CentOS 9, Debian/Ubuntu, and Docker.
55

66
This section explains how to install and configure a new {page-component-title} instance, including the following tasks:
77

@@ -70,26 +70,25 @@ include::../time-sync.adoc[]
7070
== Set up PostgreSQL
7171

7272
TIP: PostgreSQL 14 and 15 use the `scram-sha-256` https://www.postgresql.org/docs/14/auth-password.html[password authentication] method by default.
73-
If you use older versions of PostgreSQL, you should change the method in `postgresql.conf` and in `pg_hba.conf` before installing the {page-component-title} core instance.
73+
If you use older versions of PostgreSQL, you should change the method to `md5` in the `pg_hba.conf` before installing the {page-component-title} core instance.
7474

7575
== Pool size and maximum database connections
7676

77-
You must configure the PostgreSQL https://www.postgresql.org/docs/15/runtime-config-connection.html[max_connections] setting to at least twice the maximum pool size in {page-component-title}.
77+
You must configure the PostgreSQL https://www.postgresql.org/docs/15/runtime-config-connection.html[max_connections] setting to allow at least 70 connections.
78+
The number of connections is defined by the `maxPool` setting for each datasource (opennms 50 + opennms-admin 10 + opennms-monitoring 10).
79+
The `maxSize` is not used with the `HikariCPConnectionFactory`, which is deprecated and just here for backward compatibility.
7880

79-
The default maximum pool size value in {page-component-title} is 50, but it applies to each connect in `opennms-datasources.xml`: `opennms` (the main connection used at runtime) and `opennms-admin` (the connection used during administrative operations, including installation).
80-
Therefore, your `max_connections` setting should be at least 100.
81-
82-
If you change the default pool size, make sure you also update the `max_connections`.
81+
If you change the max pool size, make sure you also update the `max_connections`.
8382
You typically set this in `PG_HOME/data/postgresql.conf`, but you may also use the `ALTER SYSTEM` syntax.
84-
You must restart the PostgreSQL server for the changes to take effect.
83+
You must restart the PostgreSQL server to take effect.
8584

8685
NOTE: You may find https://pgtune.leopard.in.ua/[PGTune] useful to calculate configuration parameters for PostgreSQL.
8786
As with all third-party tools, we do not endorse or guarantee it.
8887
Use it at your own discretion.
8988

9089
[{tabs}]
9190
====
92-
CentOS/RHEL 9::
91+
CentOS 9::
9392
+
9493
--
9594
include::centos-rhel9/postgresql.adoc[]
@@ -124,7 +123,7 @@ Do not expose the web console or sign in pages directly to the Internet without
124123

125124
[{tabs}]
126125
====
127-
CentOS/RHEL 9::
126+
CentOS 9::
128127
+
129128
--
130129
include::centos-rhel9/install-core.adoc[]
@@ -163,18 +162,12 @@ endif::[]
163162

164163
[{tabs}]
165164
====
166-
CentOS/RHEL 9::
165+
CentOS 9/10::
167166
+
168167
--
169168
include::centos-rhel/initialize-core.adoc[]
170169
--
171170
172-
CentOS 10::
173-
+
174-
--
175-
include::centos/initialize-core.adoc[]
176-
--
177-
178171
ifeval::["{page-component-title}" == "Horizon"]
179172
Debian/Ubuntu::
180173
+

docs/modules/deployment/pages/core/message-broker/kafka-topics.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,26 @@ All IPC topics use the following format:
1212

1313
Where:
1414

15-
* `{instanceId}` = OpenNMS instance ID (default: `OpenNMS`)
16-
* `{component}` = IPC component type (e.g., `rpc-request`, `rpc-response`, `Sink`, `twin`)
17-
* `{endpoint}` = Module or endpoint identifier
18-
* `{location}` = Minion location (where applicable)
15+
* `\{instanceId}` = OpenNMS instance ID (default: `OpenNMS`)
16+
* `\{component}` = IPC component type (e.g., `rpc-request`, `rpc-response`, `Sink`, `twin`)
17+
* `\{endpoint}` = Module or endpoint identifier
18+
* `\{location}` = Minion location (where applicable)
1919

2020
== RPC Topics
2121

2222
RPC (Remote Procedure Call) topics are used for request/response communication between Core and Minion.
2323

2424
=== Request Topics (per location)
2525

26-
Format: `{instanceId}.{location}.rpc-request`
26+
Format: `\{instanceId}.\{location}.rpc-request`
2727

2828
Example: `OpenNMS.Default.rpc-request`
2929

3030
NOTE: One request topic is required per Minion location.
3131

3232
=== Response Topic (global)
3333

34-
Format: `{instanceId}.rpc-response`
34+
Format: `\{instanceId}.rpc-response`
3535

3636
Example: `OpenNMS.rpc-response`
3737

@@ -41,7 +41,7 @@ NOTE: A single response topic is used for all RPC responses.
4141

4242
Sink topics are used for one-way message streaming from Minion to Core (e.g., events, traps, telemetry, flows).
4343

44-
Format: `{instanceId}.Sink.{moduleId}`
44+
Format: `\{instanceId}.Sink.\{moduleId}`
4545

4646
=== Required Sink Topic
4747

@@ -80,7 +80,7 @@ These topics are only needed when the corresponding feature is enabled:
8080

8181
=== Telemetry/Flow Sink Topics
8282

83-
Telemetry and flow topics use the module ID format `Telemetry-{queueName}`. The queue name is defined in `telemetryd-configuration.xml`.
83+
Telemetry and flow topics use the module ID format `Telemetry-\{queueName}`. The queue name is defined in `telemetryd-configuration.xml`.
8484

8585
NOTE: These are default queue names. If queue names were customized in `telemetryd-configuration.xml`, topic names will differ.
8686

@@ -117,7 +117,7 @@ NOTE: These are default queue names. If queue names were customized in `telemetr
117117
| Graphite metrics
118118
|===
119119

120-
NOTE: The actual telemetry topic names depend on your telemetry daemon configuration. The queue name is specified in `telemetryd-configuration.xml` and the module ID is `Telemetry-{queueName}`.
120+
NOTE: The actual telemetry topic names depend on your telemetry daemon configuration. The queue name is specified in `telemetryd-configuration.xml` and the module ID is `Telemetry-\{queueName}`.
121121

122122
.Example Sink Topics
123123
----
@@ -139,15 +139,15 @@ Twin topics are used for configuration synchronization between Core and Minion.
139139

140140
=== Request Topic (global)
141141

142-
Format: `{instanceId}.twin.request`
142+
Format: `\{instanceId}.twin.request`
143143

144144
Example: `OpenNMS.twin.request`
145145

146146
=== Response Topics
147147

148-
Global response topic: `{instanceId}.twin.response`
148+
Global response topic: `\{instanceId}.twin.response`
149149

150-
Per-location response topic: `{instanceId}.twin.response.{location}`
150+
Per-location response topic: `\{instanceId}.twin.response.\{location}`
151151

152152
.Example Twin Topics
153153
----

docs/modules/deployment/pages/core/system-requirements.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,10 @@ OpenNMS {page-component-title} requires one of the following operating systems:
3535
| Operating System | Compatible Versions (64-bit)
3636

3737
| RHEL
38-
| {compatible-rhel9} +
39-
{compatible-rhel10}
38+
| {compatible-rhel}
4039

4140
| CentOS
42-
| {compatible-centos-stream9} +
43-
{compatible-centos-stream10}
41+
| {compatible-centos}
4442

4543
ifeval::["{page-component-title}" == "Horizon"]
4644
| Debian
@@ -94,4 +92,4 @@ Components marked with an asterisk are required:
9492
|===
9593

9694
== Containerized environments
97-
See xref:deployment:core/containers.adoc[containerized deployment] for information on deploying {page-component-title} via Kubernetes or OpenShift.
95+
See xref:deployment:core/containers.adoc[containerized deployment] for information on deploying {page-component-title} via Kubernetes or OpenShift.

docs/modules/deployment/pages/minion/system-requirements.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@ OpenNMS {page-component-title} runs on the following operating systems:
3535
| Operating System | Supported Versions (64-bit)
3636

3737
| RHEL
38-
| {compatible-rhel8} +
39-
{compatible-rhel9}
38+
| {compatible-rhel}
4039

4140
| CentOS
42-
| {compatible-centos-stream}
41+
| {compatible-centos}
4342

4443
ifeval::["{page-component-title}" == "Horizon"]
4544
| Debian

0 commit comments

Comments
 (0)