fix: issues with kcat guide (#485)

* fix: issues with kcat guide Reports have been made about missing binary name and also kcat not working at all (no messages produced on mac) * fix: minor line update * fix: apply review comment Co-authored-by: Stetson Robinson <[email protected]> Co-authored-by: Stetson Robinson <[email protected]>
redhat-developer · Apr 29, 2022 · 11f2c56 · 11f2c56
1 parent 1b46d76
commit 11f2c56
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/kafka/kcat-kafka/README.adoc b/docs/kafka/kcat-kafka/README.adoc
@@ -112,6 +112,8 @@ For more information about Kafkacat configuration options, see https://github.co
 
 NOTE: Kafkacat does not yet fully support SASL/OAUTHBEARER authentication, so connecting to a Kafka instance requires only the bootstrap server and the service account credentials for SASL/PLAIN authentication.
 
+NOTE: Kafkacat have been recently renamed to kcat. If you use latest version of kafkacat please replace all occurences referencing kafkacat binary to kcat 
+
 .Prerequisites
 ifndef::qs[]
 * You have the bootstrap server endpoint for your Kafka instance. To relocate the server endpoint, select your Kafka instance in the {product-kafka} web console, select the options menu (three vertical dots), and click *Connection*.
@@ -164,6 +166,8 @@ $ kafkacat -t my-first-kafka-topic -b "$KAFKA_HOST" \
 
 NOTE: {product-kafka} also supports the SASL/OAUTHBEARER mechanism for authentication, which is the recommended authentication mechanism to use. However, Kafkacat does not yet fully support OAUTHBEARER, so this example uses SASL/PLAIN.
 
+NOTE: A Kafkacat producer might behave differently depending on the operating system. For example, on Mac operating systems, messages are sent by redirecting them to the Kafkacat binary in the format `echo "message" | kafkacat ...`.
+
 --
 . With Kafkacat running in producer mode, enter messages into Kafkacat that you want to produce to the Kafka topic.
 +