From ae44a08051e9f0db78051b159e335f075aab1fe1 Mon Sep 17 00:00:00 2001 From: "Cheng-Kai, Zhang" Date: Wed, 27 Mar 2024 11:11:09 +0800 Subject: [PATCH] MINOR: add docker usage documentation link in README.md (#15600) We have a detail usage guide for running Kafka in docker. However, it might be easy for people to miss it if they only scan through the README. This PR add a basic example command for quick start and link directing users to the detailed usage guide Reviewers: Luke Chen --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d8ee34b6188..27ce0dc0bce 100644 --- a/README.md +++ b/README.md @@ -92,15 +92,25 @@ fail due to code changes. You can just run: ### Running a Kafka broker in KRaft mode +Using compiled files: + KAFKA_CLUSTER_ID="$(./bin/kafka-storage.sh random-uuid)" ./bin/kafka-storage.sh format -t $KAFKA_CLUSTER_ID -c config/kraft/server.properties ./bin/kafka-server-start.sh config/kraft/server.properties +Using docker image: + + docker run -p 9092:9092 apache/kafka:3.7.0 + ### Running a Kafka broker in ZooKeeper mode +Using compiled files: + ./bin/zookeeper-server-start.sh config/zookeeper.properties ./bin/kafka-server-start.sh config/server.properties +>Since ZooKeeper mode is already deprecated and planned to be removed in Apache Kafka 4.0, the docker image only supports running in KRaft mode + ### Cleaning the build ### ./gradlew clean