Skip to content

NMS-14138: Elasticsearch feature matrix and MIB converter docs cleanup - #9010

Open
joseanesONMS wants to merge 2 commits into
developfrom
jira/NMS-14138-elasticsearch-mib-docs
Open

joseanesONMS wants to merge 2 commits into
developfrom
jira/NMS-14138-elasticsearch-mib-docs

Conversation

@joseanesONMS

@joseanesONMS joseanesONMS commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Removes the stale Elasticsearch feature matrix and the retired MIB converter mentions from the docs, split out of #8985.

Ticket What was removed or changed Proof it was unused Upgrade impact
NMS-14138 Elasticsearch Feature Matrix (incl. Situation feedback row); the Flow support page stays No xref or include into it Docs only; Alarm history still ships (opennms-alarm-history-elastic), so its page moved unchanged to Alarms instead of being dropped
NMS-11731 mib2opennms / mib2events mentions removed from the MIB page Neither tool is shipped (no bin script or packaging) Docs only

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

External References

… history page

The feature matrix only restated feature names that their own pages already document; the situation feedback REST API stays documented in development/rest/situation-feedback.adoc.
The alarm history page is moved, unchanged, to deep-dive/alarms/history.adoc, which until now only included it, because the alarm history feature still ships.
The flow support page stays, as the review asked.

git grep finds no xref or include into the removed page outside operation/nav.adoc, which is updated.
Neither tool ships with Horizon any more: git grep finds no bin script, assembly descriptor, RPM spec or Debian packaging entry for mib2opennms or mib2events, only historical uei.opennms.org/mib2opennms/* event UEIs and a code comment in the MIB compiler parser.
The SNMP MIB Compiler page therefore stops pointing operators at them and keeps the web UI MIB compiler as the only documented path; the example UEIs elsewhere are left alone because they are identifiers, not tool references.

@cgorantla cgorantla left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if anyone is using this feature. This may be one of the items for deprecation.
Wouldn't want to update docs for it right now.

@marshallmassengill marshallmassengill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if anyone is using this feature. This may be one of the items for deprecation. Wouldn't want to update docs for it right now.

@cgorantla It's not really adding anything new. This is moving the page to a better spot for it.

As for the feature itself, it's worth keeping as it answers a compliance/regulatory question we get a lot for keeping alarm history. I do think we should come back to it being ES only once we get the drift stuff merged in down the road. We can add OpenSearch or at least make this more agnostic at that point.

I'm good with this. Should be approved from a docs standpoint.

This branch has not been deployed

No deployments
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.

3 participants