Skip to content

NMS-19123: Installation and sizing docs - #8995

Closed
joseanesONMS wants to merge 5 commits into
developfrom
jira/NMS-19123-install-docs-smoke
Closed

joseanesONMS wants to merge 5 commits into
developfrom
jira/NMS-19123-install-docs-smoke

Conversation

@joseanesONMS

@joseanesONMS joseanesONMS commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

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

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

External References

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.
@joseanesONMS

Copy link
Copy Markdown
Contributor Author

Reopened as #9005 from a branch without the -smoke suffix; this PR is docs-only, so it doesn't need a smoke run.

@joseanesONMS
joseanesONMS deleted the jira/NMS-19123-install-docs-smoke branch October 22, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant