Repository navigation
NMS-8122: Provisioning docs - #9000
Merged
Merged
Conversation
The file handler page did not say how the path is resolved; FileRequisitionProvider opens it with new File(path) and the external requisition UI rejects paths that do not start with a slash. The page now states that the path must be absolute and warns against using etc/imports as a source directory.
… adapter The SNMP metadata adapter page did not mention opennms:snmp-metadata-provisioning-adapter. The new section covers its node selection options, dry-run versus persist behavior, and caveats, taken from SnmpMetadataProvisioningAdapterCommand and SnmpMetadataProvisioningAdapter.
The docs did not explain how Provisiond picks a node label or what the label source flag means. The new Node Labels page covers requisition, discovered, and manually changed labels, based on DefaultProvisionService, ScanResource, SaveOrUpdateOperation, and NodeLabelDaoImpl.
The path outages page showed one example but provisioning had no procedure for defining node parents. The new section in Directed Discovery covers the UI and requisition attributes, parent lookup rules, and critical interface selection from CoreImportActivities and DefaultProvisionService, and cross-links with path outages.
… introduction
Provisioner.doImport() opens file: URLs with new File(URI) and FileRequisitionProvider uses new File(path), so neither expands ${OPENNMS_HOME}; the example now uses an absolute path and points to the file handler page for the etc/imports warning.
This was referenced Oct 22, 2026
dino2gnt
previously approved these changes
Oct 22, 2026
Contributor
There was a problem hiding this comment.
I'm glad this is actually getting documented. Good work.
marshallmassengill
requested changes
Oct 22, 2026
marshallmassengill
left a comment
marshallmassengill
left a comment
Contributor
There was a problem hiding this comment.
Minor tweak for clarity.
| If the lookup returns a hostname, that hostname becomes the label (source `H`). | ||
| Otherwise, the IP address becomes the label (source `A`). | ||
| . During the node scan, if the label source is still `A` and the SNMP agent returns a non-empty `sysName`, the `sysName` becomes the label (source `S`). | ||
| . On each later scan, if the label source is `H` or `A`, Provisiond repeats the reverse DNS lookup for the node's primary interface and sets the label to the hostname (source `H`) or to the IP address (source `A`). |
Contributor
There was a problem hiding this comment.
Suggested change
| . On each later scan, if the label source is `H` or `A`, Provisiond repeats the reverse DNS lookup for the node's primary interface and sets the label to the hostname (source `H`) or to the IP address (source `A`). | |
| . On each later scan, if the label source is `H` or `A`, Provisiond repeats the reverse DNS lookup for the node's primary interface (or, if it has none, one of its interfaces) and sets the label to the hostname (source `H`) or to the IP address (source `A`). |
…rface DefaultProvisionService.updateNodeHostname falls back to the node's first IP interface when there is no primary one, so the rescan wording now says so.
Contributor
Author
|
@marshallmassengill Applied in c6bb289; it matches |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the provisioning handlers, adapters and node labels, split out of #8984; content checked against the code on develop, one commit per ticket.
reference/…/handlers/file.adocFileRequisitionProvider.java,ConfigurationHelper.tsreference/…/adapters/snmp-metadata.adocSnmpMetadataProvisioningAdapterCommand.javaoperation/…/provisioning/node-label.adoc(new)DefaultProvisionService.java,NodeLabelDaoImpl.javaoperation/…/provisioning/directed-discovery.adoc,path-outages.adocmodel-import.xsd,DefaultProvisionService.setNodeParentAndDependenciesCorrections to existing docs (separate
NMS-8122: Fix …commits, each can be dropped on its own)Provisioner.java,FileRequisitionProvider.javaThe docs build adds no warnings (develop's two existing ones remain).
External References