Merge pull request #6341 from OpenNMS/kafka-doc

OpenNMS · Jul 11, 2023 · 83f772b · 83f772b
2 parents f2b0fc2 + 51fc6f5
commit 83f772b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/docs/modules/deployment/pages/core/message-broker/kafka.adoc b/docs/modules/deployment/pages/core/message-broker/kafka.adoc
@@ -16,6 +16,8 @@ org.opennms.core.ipc.kafka.bootstrap.servers=my-kafka-ip-1:9092,my-kafka-ip-2:90
 <2> Ensure that messages are not consumed from Kafka for Sink until the system has fully initialized. Default is 60 seconds.
 <3> Connect to the following Kafka nodes and adjust the IPs or FQDNs with the Kafka port (9092) accordingly.
 
+NOTE: Enabling Kafka broker settings requires that you have a Kafka cluster installed and running.
+
 NOTE: If you set more than one Kafka node as `bootstrap.servers`, the driver attempts to connect to the first entry.
       If that is successful, the client discovers and knows the whole broker topology.
       The other entries are used only if the connection to the first entry fails.

diff --git a/docs/modules/operation/pages/deep-dive/kafka-producer/enable-kafka.adoc b/docs/modules/operation/pages/deep-dive/kafka-producer/enable-kafka.adoc
@@ -3,8 +3,8 @@
 
 The Kafka Producer is disabled by default and can be enabled as follows.
 
-First, log in to the Karaf shell of your {page-component-title} instance and configure the Kafka client settings to point to your Kafka broker.
-See link:https://kafka.apache.org/10/documentation.html#producerconfigs[Producer Configs] for a complete list of available options.
+First, log in to the Karaf shell of your {page-component-title} instance and configure the Kafka client settings to point to your Kafka server(s).
+See link:https://kafka.apache.org/documentation/#producerconfigs[Producer Configs] for a complete list of available options.
 
 .Connect to Karaf shell
 [source, console]
@@ -16,11 +16,11 @@ ssh -p 8101 admin@localhost
 [source, karaf]
 ----
 config:edit org.opennms.features.kafka.producer.client
-config:property-set bootstrap.servers kafka-broker-ip:9092 <1>
+config:property-set bootstrap.servers kafka-server-ip:9092 <1>
 config:update
 ----
-<1> Set the Kafka broker IP by replacing the kafka-broker-ip and port you want to connect to.
-    Add multiple hosts in a comma-separated list, for example, `kafka-broker-1:9092,kafka-broker-2:9092`
+<1> Set the Kafka server IP or hostname by replacing the kafka-server-ip and port of an existing Kafka cluster that you want to connect to.
+    Add multiple hosts in a comma-separated list; for example, `kafka-server-1:9092,kafka-server-2:9092`
 
 Next, install the `opennms-kafka-producer` feature from that same shell using: