Skip to content

Commit ae44a08

Browse files
authored
MINOR: add docker usage documentation link in README.md (apache#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 <[email protected]>
1 parent 3e64f8f commit ae44a08

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,25 @@ fail due to code changes. You can just run:
9292

9393
### Running a Kafka broker in KRaft mode
9494

95+
Using compiled files:
96+
9597
KAFKA_CLUSTER_ID="$(./bin/kafka-storage.sh random-uuid)"
9698
./bin/kafka-storage.sh format -t $KAFKA_CLUSTER_ID -c config/kraft/server.properties
9799
./bin/kafka-server-start.sh config/kraft/server.properties
98100

101+
Using docker image:
102+
103+
docker run -p 9092:9092 apache/kafka:3.7.0
104+
99105
### Running a Kafka broker in ZooKeeper mode
100106

107+
Using compiled files:
108+
101109
./bin/zookeeper-server-start.sh config/zookeeper.properties
102110
./bin/kafka-server-start.sh config/server.properties
103111

112+
>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
113+
104114
### Cleaning the build ###
105115
./gradlew clean
106116

0 commit comments

Comments
 (0)