Skip to content

NMS-20333: Update ALEC documentation for the LLM features and configuration page - #179

Open
joseanesONMS wants to merge 1 commit into
developfrom
ja/NMS-20333-docs
Open

joseanesONMS wants to merge 1 commit into
developfrom
ja/NMS-20333-docs

Conversation

@joseanesONMS

Copy link
Copy Markdown
Contributor

Brings the ALEC docs in line with what 3.0 ships: the LLM features, the ALEC Configuration page, and the real prerequisites.

The docs still described an Elasticsearch requirement and first-run prompts that no longer exist, so this trims those and adds the missing pieces rather than rewriting pages.

  • Installation overview: Elasticsearch prerequisite removed; supported versions stated as Horizon 32.0.0+ / Meridian 2025.1.0+ from the Integration API range in the pom.
  • Pre-installation: alarm-history and flows Elasticsearch sections removed; download location added.
  • Quick Start step 1: describes the Configuration page and its three tabs; two obsolete screenshots deleted.
  • LLM Root Cause Analysis: new LLM Setup section covering endpoint, model, key, token budgets and the usage summary.
  • Clustering engine: the "change the engine only via Karaf" note corrected.

External References

… page

Drops the Elasticsearch prerequisite and the alarm-history setup, which
ALEC no longer needs, and states the supported OpenNMS versions from the
Integration API range the plugin is built against. The Quick Start now
describes the ALEC Configuration page and its three tabs instead of
first-run prompts that no longer exist, the shared LLM Setup tab and token
budgets get their own section, and the note that the engine can only be
changed from the Karaf shell is corrected.
@github-actions github-actions Bot added the docs label Sep 17, 2026
@github-actions
github-actions Bot requested a review from indigo423 September 17, 2026 18:19
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