Skip to content

MINOR: Inline "Running a Kafka broker in KRaft mode" in README.md #12750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ijuma merged 1 commit into from
Oct 18, 2022
Merged

MINOR: Inline "Running a Kafka broker in KRaft mode" in README.md #12750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,17 @@ fail due to code changes. You can just run:

./gradlew processMessages processTestMessages

### Running a Kafka broker in KRaft mode

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

@jsancio jsancio Oct 14, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have a ### heading with something like "Running a Kafka Broker" with 2 #### heading, one for KRaft-mode and one for ZK-mode?

The ### Running a Kafka Broker should mention that only one subsection should be followed. In other words the Kafka cluster should have one KRaft-mode server or ZK-mode server but not both.

@ijuma ijuma Oct 16, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For better or worse, the README is not structured as a quick start - you are not supposed to follow every step in it. Instead, it is meant as a useful set of things one may want to do. The thing you suggested doesn't fit with everything else we have in my opinion. What do you think?

### Running a Kafka broker in ZooKeeper mode

./bin/zookeeper-server-start.sh config/zookeeper.properties
./bin/kafka-server-start.sh config/server.properties

### Running a Kafka broker in KRaft (Kafka Raft metadata) mode

See [config/kraft/README.md](https://github.com/apache/kafka/blob/trunk/config/kraft/README.md).

### Cleaning the build ###
./gradlew clean

Expand Down