NMS-19123: Installation and sizing docs by joseanesONMS · Pull Request #9005 · OpenNMS/opennms

joseanesONMS · 2026-10-22T12:44:39Z

Documents the installation, sizing and UI limits, split out of #8984; content checked against the code on develop, one commit per ticket.

Ticket	Topic	Page(s) added/changed	Source of truth
NMS-13596	`scvcli` reference	`operation/…/scv-configuration.adoc`	`features/scv/scvcli/*`
NMS-8460	Newts evaluate strategy for sizing	`deployment/…/newts/configuration.adoc`	`features/timeseries-evaluate/*`
NMS-19123	Supported RHEL versions	`deployment/…/core/install.adoc`, `minion/install.adoc`	`docs/antora.yml`
NMS-15365	KAR plugins in the core container	`deployment/…/core/docker/initialize.adoc`	`opennms-container/core/Dockerfile`, `entrypoint.sh`
NMS-12003	Surveillance Dashboard alarm and notification limits	`operation/…/visualizations/dashboard.adoc`	`DefaultSurveillanceViewService.java`

Not addressed

NMS-19123 (overview table): already fixed by NMS-19060 in deployment/…/core/system-requirements.adoc; this PR only aligns the page descriptions.
NMS-14932 (IPLIKE): held back until NMS-19980: Translate IPLIKE filter expressions to indexable native PostgreSQL inet predicates #8634 merges.
NMS-19267: develop does not claim or test Debian 13 (compatible-debian: '11, 12'), so install steps cannot be verified.

The docs build adds no warnings (develop's two existing ones remain).

External References

Jira (Issue Tracker): https://opennms.atlassian.net/browse/NMS-19123
Related: NMS-13596, NMS-8460, NMS-15365, NMS-12003

The install guides used scvcli without a reference for its commands, options, or use on Minion and Sentinel. The section follows ScvCli and its set, get, get-all, list, and delete commands, and the bin/scvcli scripts that run it from the etc directory.

The Newts recommendations said to raise cache.max_entries and ring_buffer_size without a way to estimate them. The new section describes the evaluate time series strategy, its EvaluationMetrics.log output, and its dump frequency properties, following features/timeseries-evaluate (EvaluateStats and its Spring context) and TimeSeries.Strategy.

The OS table in system requirements already reads from the compatible-* attributes in docs/antora.yml (RHEL/CentOS 9 and 10), but the core and Minion install page descriptions still advertised CentOS/RHEL 9 only and 7-9. They now match the install tabs and the attributes.

The container docs never explained how to add a plugin KAR. The image keeps the Karaf deploy directory at /opt/opennms/deploy, and entrypoint.sh copies the opennms, etc, and Jetty WEB-INF overlay directories on every start, which is the same mechanism the smoke tests use (OpenNMSContainer binds KARs into deploy and writes featuresBoot.d through the overlay).

The dashboard page claimed notifications disappear once acknowledged and were capped at 100, and that alarms are filtered by severity. DefaultSurveillanceViewService shows a display-only severity by notification age and state, keeps acknowledged notifications for seven days, and caps unacknowledged alarms at 100 without a severity filter.

dino2gnt · 2026-10-22T14:02:56Z

 [[install-minion]]
 = Install Minion
-:description: How to install OpenNMS Minion on CentOS/RHEL 7-9, Debian/Ubuntu, Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC.
+:description: How to install OpenNMS Minion on CentOS/RHEL 9 and 10, Debian/Ubuntu, Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC.


Suggested change

:description: How to install OpenNMS Minion on CentOS/RHEL 9 and 10, Debian/Ubuntu, Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC.

:description: How to install OpenNMS Minion on CentOS/RHEL, Debian/Ubuntu, or Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC.

dino2gnt · 2026-10-22T14:04:43Z

+.Store database credentials on {page-component-title} Core and prompt for the password
+[source, console]
+----
+sudo -u opennms ${OPENNMS_HOME}/bin/scvcli set postgres opennms


Suggested change

sudo -u opennms ${OPENNMS_HOME}/bin/scvcli set postgres opennms

scvcli set postgres opennms

dino2gnt · 2026-10-22T14:04:58Z

+.Store credentials with an attribute and read the password from a file
+[source, console]
+----
+sudo -u opennms ${OPENNMS_HOME}/bin/scvcli set corp-directory svc-monitor --from-stdin --attribute domain=CORP < /path/to/password.txt


Suggested change

sudo -u opennms ${OPENNMS_HOME}/bin/scvcli set corp-directory svc-monitor --from-stdin --attribute domain=CORP < /path/to/password.txt

scvcli set corp-directory svc-monitor --from-stdin --attribute domain=CORP < /path/to/password.txt

dino2gnt · 2026-10-22T14:05:10Z

+.Show an entry on a Minion
+[source, console]
+----
+sudo -u minion ${MINION_HOME}/bin/scvcli get opennms.broker


Suggested change

sudo -u minion ${MINION_HOME}/bin/scvcli get opennms.broker

scvcli get opennms.broker

The page description no longer lists RHEL versions, which the supported-platform pages already state.

The examples now call scvcli directly; one sentence above them gives the full paths for Core and Minion, since the packages do not put scvcli on the PATH, and says to run it as the service user so the keystore stays readable.

joseanesONMS · 2026-10-22T14:35:49Z

@dino2gnt Applied all four (e106da9, 80a2d98). Since the packages don't put scvcli on the PATH, one line above the examples gives the full Core and Minion paths and says to run it as the service user, so the keystore stays readable.

dino2gnt · 2026-10-22T14:39:40Z

Since the packages don't put scvcli on the PATH

Not entirely accurate.

[root@37horizon etc]# cat /etc/profile.d/opennms.sh
#!/bin/bash

OPENNMS_HOME=/opt/opennms
if ! echo "$PATH" | grep "$OPENNMS_HOME/bin" >/dev/null 2>&1; then
        PATH="$PATH:$OPENNMS_HOME/bin"
fi

export OPENNMS_HOME PATH
[root@37horizon etc]# rpm -q --whatprovides /etc/profile.d/opennms.sh
opennms-core-37.0.0-0.20260711.1.noarch
[root@37horizon etc]# which scvcli
/opt/opennms/bin/scvcli

marshallmassengill

I think this is good. It may be worth a note or something about the path but it's not a huge deal.

joseanesONMS added 5 commits October 22, 2026 08:25

joseanesONMS requested review from cgorantla and marshallmassengill October 22, 2026 12:44

github-actions Bot requested a review from indigo423 October 22, 2026 12:44

github-actions Bot added the docs label Oct 22, 2026

This was referenced Oct 22, 2026

NMS-19123: Installation and sizing docs #8995

Closed

NMS-11035: Documentation gaps #8984

Closed

marshallmassengill requested a review from dino2gnt October 22, 2026 12:51

dino2gnt requested changes Oct 22, 2026

View reviewed changes

joseanesONMS added 2 commits October 22, 2026 10:34

NMS-19123: Use Dino's Minion install description

e106da9

The page description no longer lists RHEL versions, which the supported-platform pages already state.

NMS-13596: Show scvcli examples without the install path

80a2d98

The examples now call scvcli directly; one sentence above them gives the full paths for Core and Minion, since the packages do not put scvcli on the PATH, and says to run it as the service user so the keystore stays readable.

joseanesONMS requested a review from dino2gnt October 22, 2026 14:35

marshallmassengill approved these changes Oct 22, 2026

View reviewed changes

Navigation Menu

Repository navigation

NMS-19123: Installation and sizing docs - #9005

NMS-19123: Installation and sizing docs#9005
joseanesONMS wants to merge 7 commits into
developfrom
jira/NMS-19123-install-docs

joseanesONMS commented Oct 22, 2026 •

edited by atlassian Bot

Loading

Uh oh!

dino2gnt Oct 22, 2026

Uh oh!

dino2gnt Oct 22, 2026

Uh oh!

dino2gnt Oct 22, 2026

Uh oh!

dino2gnt Oct 22, 2026

Uh oh!

joseanesONMS commented Oct 22, 2026

Uh oh!

dino2gnt commented Oct 22, 2026

Uh oh!

marshallmassengill left a comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	:description: How to install OpenNMS Minion on CentOS/RHEL 9 and 10, Debian/Ubuntu, Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC.
	:description: How to install OpenNMS Minion on CentOS/RHEL, Debian/Ubuntu, or Docker, and configure with message brokers: Kafka, ActiveMQ, Embedded ActiveMQ, gRPC.

	sudo -u opennms ${OPENNMS_HOME}/bin/scvcli set postgres opennms
	scvcli set postgres opennms

	sudo -u opennms ${OPENNMS_HOME}/bin/scvcli set corp-directory svc-monitor --from-stdin --attribute domain=CORP < /path/to/password.txt
	scvcli set corp-directory svc-monitor --from-stdin --attribute domain=CORP < /path/to/password.txt

	sudo -u minion ${MINION_HOME}/bin/scvcli get opennms.broker
	scvcli get opennms.broker

Conversation

joseanesONMS commented Oct 22, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

External References

Uh oh!

dino2gnt Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

dino2gnt Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

dino2gnt Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

dino2gnt Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

joseanesONMS commented Oct 22, 2026

Uh oh!

dino2gnt commented Oct 22, 2026

Uh oh!

marshallmassengill left a comment

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

joseanesONMS commented Oct 22, 2026 •

edited by atlassian Bot

Loading