Merge pull request #6256 from OpenNMS/jira/NMS-15713

NMS-15713: Update docs to capture additional details on BMP config
Updated BMP config section with missing information, restructured the page into separate pages for easier reading/searching.

docs/modules/reference/nav.adoc

@@ -99,7 +99,13 @@
 *** xref:telemetryd/listeners/tcp.adoc[]
 *** xref:telemetryd/listeners/udp.adoc[]
 ** xref:telemetryd/protocols/introduction.adoc[]
-*** xref:telemetryd/protocols/bmp.adoc[]
+*** xref:telemetryd/protocols/bmp/bmp.adoc[]
+**** xref:telemetryd/protocols/bmp/parser.adoc[]
+**** xref:telemetryd/protocols/bmp/minion.adoc[]
+**** xref:telemetryd/protocols/bmp/adapter.adoc[]
+**** xref:telemetryd/protocols/bmp/peer-status.adoc[]
+**** xref:telemetryd/protocols/bmp/integration-adapter.adoc[]
+**** xref:telemetryd/protocols/bmp/persisting-adapter.adoc[]
 *** xref:telemetryd/protocols/nxos.adoc[]
 *** xref:telemetryd/protocols/graphite.adoc[]
 *** xref:telemetryd/protocols/ipfix.adoc[]

docs/modules/reference/pages/telemetryd/protocols/bmp/adapter.adoc

@@ -0,0 +1,32 @@
+
+[[telemetryd-bmp-statistics-adapter]]
+= BMP Telemetry Adapter
+
+The BMP telemetry adapter handles BMP statistics received and parsed by the xref:telemetryd/protocols/bmp/parser.adoc[BMP Parser].
+Statistics received from the router are associated as performance data with that router.
+The router must exist as a regular node in {page-component-title}.
+
+{page-component-title} uses the IP address exported in BMP messages to associate a router with the appropriate {page-component-title} node.
+In addition, the node's metadata can be used to specify a BGP ID, which will be used to associate routers.
+If the parameter `metaDataNodeLookup` is not empty, it will be interpreted as a `context:key` metadata name, which will be used to look up a node that has stored the queried BGP ID as a value in the specified key.
+
+== Facts
+
+[options="autowidth"]
+|===
+| Class Name          | `org.opennms.netmgt.telemetry.protocols.bmp.adapter.BmpTelemetryAdapter`
+|===
+
+== Configuration and use
+
+.Optional parameters for the BMP telemetry adapter
+[options="header", cols="1,3,1"]
+|===
+| Parameter
+| Description
+| Default
+
+| metaDataNodeLookup
+| Enables lookup using BGP IDs.
+| n/a
+|===

docs/modules/reference/pages/telemetryd/protocols/bmp/bmp.adoc

@@ -0,0 +1,10 @@
+
+= BGP Monitoring Protocol
+
+The BGP Monitoring Protocol (BMP) provides a convenient interface for obtaining route views.
+The integration in {page-component-title} lets you use these route views, status updates, and statistics for monitoring and management.
+
+.BMP integration overview
+image::bmp/bmp_integration_overview.png[width=70%]
+
+The following sections provide details about associated parsers, adapters, and listeners.

docs/modules/reference/pages/telemetryd/protocols/bmp/integration-adapter.adoc

@@ -0,0 +1,33 @@
+
+[[telemetryd-openbmp-integration-adapter]]
+= OpenBMP Integration Adapter
+
+The OpenBMP integration adapter can integrate with an existing https://github.com/OpenBMP[OpenBMP] installation.
+It handles BMP messages the xref:telemetryd/protocols/bmp/parser.adoc[BMP Parser] receives and parses, and creates OpenBMP-compatible messages, which are then passed to the OpenBMP Kafka cluster.
+
+This setup replaces the collector component of OpenBMP.
+
+== Facts
+
+[options="autowidth"]
+|===
+| Class Name          | `org.opennms.netmgt.telemetry.protocols.bmp.adapter.openbmp.BmpIntegrationAdapter`
+|===
+
+== Configuration and use
+
+.Optional parameters for the OpenBMP Integration Adapter
+[options="header", cols="1,3,1"]
+|===
+| Parameter
+| Description
+| Default
+| kafka.*
+| Uses options to create OpenBMP Kafka producer.
+Enables all known Kafka settings, but with `kafka.` prefixed.
+| n/a
+
+| topicPrefix
+| Prefix used before each Kafka topic.
+| n/a
+|===

docs/modules/reference/pages/telemetryd/protocols/bmp/minion.adoc

@@ -0,0 +1,20 @@
+
+= Configure BMP Listener on a Minion
+
+To enable and configure a TCP listener for BMP on Minion, connect to the Karaf Console and set the following properties:
+
+NOTE: The protocol must also be enabled on {page-component-title} for the messages to be processed.
+
+.From the Minion's Karaf console
+[source, karaf]
+----
+config:edit --alias tcp-5000 --factory org.opennms.features.telemetry.listeners
+config:property-set name BMP
+config:property-set class-name org.opennms.netmgt.telemetry.listeners.TcpListener
+config:property-set parameters.port 5000
+config:property-set parsers.0.name BMP
+config:property-set parsers.0.class-name org.opennms.netmgt.telemetry.protocols.bmp.parser.BmpParser
+config:update
+----
+
+If you do not specify the queue name, the fallback is the name of the parser.