You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "KevinZTW (via GitHub)" <gi...@apache.org> on 2024/03/26 02:07:16 UTC
[PR] MINOR: add docker usage documentation link in README.md [kafka]
KevinZTW opened a new pull request, #15600:
URL: https://github.com/apache/kafka/pull/15600
*More detailed description of your change,
if necessary. The PR title and PR message become
the squashed commit message, so use a separate
comment to ping reviewers.*
*Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.*
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "KevinZTW (via GitHub)" <gi...@apache.org>.
KevinZTW commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1540387857
##########
README.md:
##########
@@ -285,6 +295,7 @@ See [tests/README.md](tests/README.md).
See [vagrant/README.md](vagrant/README.md).
+
Review Comment:
thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "showuon (via GitHub)" <gi...@apache.org>.
showuon merged PR #15600:
URL: https://github.com/apache/kafka/pull/15600
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "showuon (via GitHub)" <gi...@apache.org>.
showuon commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1538541164
##########
README.md:
##########
@@ -285,6 +285,16 @@ See [tests/README.md](tests/README.md).
See [vagrant/README.md](vagrant/README.md).
+### Running in Docker ###
+You could use the official docker image to run Kafka in Docker. It is available at [Docker Hub](https://hub.docker.com/r/apache/kafka).
+
+For example, to start a single-node Kafka, you can run the following command:
+
+ docker compose -f docker/examples/jvm/single-node/plaintext/docker-compose.yml up
+
+
Review Comment:
nit: additional empty line
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "KevinZTW (via GitHub)" <gi...@apache.org>.
KevinZTW commented on PR #15600:
URL: https://github.com/apache/kafka/pull/15600#issuecomment-2020642076
> Thanks for the PR. I'm thinking we can put the running with docker below these 2 sections since they are all doing the same thing: `Running a Kafka broker in KRaft mode` `Running a Kafka broker in ZooKeeper mode`
>
> WDYT?
>
> Also, in our [quick start guide section in doc](https://kafka.apache.org/quickstart), we use different command to run the image. I think we should be consistent.
Thanks for reviewing my PR! And I totally agree with you, I think that would make it easier to be found 😄 And we should align with the quick start in other places. I revise a bit base on those points, could you help me have a look again?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "showuon (via GitHub)" <gi...@apache.org>.
showuon commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1540361241
##########
README.md:
##########
@@ -87,15 +87,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 is planned to be removed in Apache Kafka 4.0, the docker image only support running in KRaft mode
Review Comment:
nit: Since ZooKeeper [mode is already deprecated and] planned to be removed in Apache Kafka 4.0, the docker image only support[s] running in KRaft mode.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "showuon (via GitHub)" <gi...@apache.org>.
showuon commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1540318413
##########
README.md:
##########
@@ -285,6 +295,7 @@ See [tests/README.md](tests/README.md).
See [vagrant/README.md](vagrant/README.md).
+
Review Comment:
additional empty line
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "KevinZTW (via GitHub)" <gi...@apache.org>.
KevinZTW commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1539402356
##########
README.md:
##########
@@ -285,6 +285,16 @@ See [tests/README.md](tests/README.md).
See [vagrant/README.md](vagrant/README.md).
+### Running in Docker ###
+You could use the official docker image to run Kafka in Docker. It is available at [Docker Hub](https://hub.docker.com/r/apache/kafka).
+
+For example, to start a single-node Kafka, you can run the following command:
+
+ docker compose -f docker/examples/jvm/single-node/plaintext/docker-compose.yml up
+
+
Review Comment:
thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "KevinZTW (via GitHub)" <gi...@apache.org>.
KevinZTW commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1540391571
##########
README.md:
##########
@@ -87,15 +87,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 is planned to be removed in Apache Kafka 4.0, the docker image only support running in KRaft mode
Review Comment:
thanks for the advice! I've made the adjustment as suggested
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: add docker usage documentation link in README.md [kafka]
Posted by "KevinZTW (via GitHub)" <gi...@apache.org>.
KevinZTW commented on code in PR #15600:
URL: https://github.com/apache/kafka/pull/15600#discussion_r1540387857
##########
README.md:
##########
@@ -285,6 +295,7 @@ See [tests/README.md](tests/README.md).
See [vagrant/README.md](vagrant/README.md).
+
Review Comment:
thanks...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org