Skip to content

KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md #19420

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
chia7712 merged 5 commits into from
Apr 15, 2025
Merged

KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md #19420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2e7b78e
KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md
johnny94 Apr 9, 2025
4089ba0
Address feedback
johnny94 Apr 9, 2025
2725f42
Address feedback
johnny94 Apr 10, 2025
3747ed5
Address feedback
johnny94 Apr 10, 2025
cc731ed
Fix
johnny94 Apr 15, 2025
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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ fail due to code changes. You can just run:

./gradlew processMessages processTestMessages

See [Apache Kafka Message Definitions](clients/src/main/resources/common/message/README.md) for details on Apache Kafka message protocol.

### Running a Kafka broker

Using compiled files:
Expand All @@ -111,6 +113,8 @@ Using docker image:

docker run -p 9092:9092 apache/kafka:3.7.0

See [docker/README.md](docker/README.md) for detailed information.

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

Expand Down Expand Up @@ -263,10 +267,28 @@ default. See https://www.lightbend.com/blog/scala-inliner-optimizer for more det

See [tests/README.md](tests/README.md).

### Using Trogdor for testing ###

We use Trogdor as a test framework for Apache Kafka. You can use it to run benchmarks and other workloads.

See [trogdor/README.md](trogdor/README.md).

### Running in Vagrant ###

See [vagrant/README.md](vagrant/README.md).

### Release Kafka ###
Copy link
Copy Markdown
Member

@ijuma ijuma Apr 16, 2025

Choose a reason for hiding this comment

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

This is not something a regular person can do and hence it doesn't seem like something we should link from the main readme.

Copy link
Copy Markdown
Member

@chia7712 chia7712 Apr 16, 2025

Choose a reason for hiding this comment

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

The original idea was to list all README.md files in the root directory, without filtering the content for specific readers. I'm fine to remove the "Release Kafka", and the "Official Documentation" could be removed too as the file "docs/README.md" has nothing to read


See [release/README.md](release/README.md).

### Official Documentation ###

See [docs/README.md](docs/README.md).

### Kafka client examples ###

See [examples/README.md](examples/README.md).

### Contribution ###

Apache Kafka is interested in building the community; we would welcome any thoughts or [patches](https://issues.apache.org/jira/browse/KAFKA). You can reach us [on the Apache mailing lists](http://kafka.apache.org/contact.html).
Expand Down
10 changes: 5 additions & 5 deletions docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Building image and running tests using github actions
- This is the recommended way to build, test and get a CVE report for the docker image.
- Just choose the image type and provide kafka url to `Docker Build Test` workflow. It will generate a test report and CVE report that can be shared with the community.

- kafka-url - This is the url to download kafka tarball from. For example kafka tarball url from (https://archive.apache.org/dist/kafka). For building RC image this will be an RC tarball url.
- kafka-url - This is the url to download kafka tarball from. For example kafka tarball url from [Kafka archive](https://archive.apache.org/dist/kafka). For building RC image this will be an RC tarball url.

- image-type - This is the type of image that we intend to build. This will be dropdown menu type selection in the workflow.
- `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/display/KAFKA/KIP-975%3A+Docker+Image+for+Apache+Kafka)
- `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming)
- `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/x/z5izDw)
- `native` image type is for graalvm based `native` Kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/x/KZizDw). Or you can see [native/README.md](native/README.md) for more information.

- Example(jvm):-
To build and test a jvm image type ensuring kafka to be containerised should be https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz (it is recommended to use scala 2.13 binary tarball), following inputs in github actions workflow are recommended.
Expand Down Expand Up @@ -210,6 +210,6 @@ python generate_kafka_pr_template.py --image-type=jvm
```

- kafka-version - This is the version to create the Docker official images static Dockerfile and assets for, as well as the version to build and test the Docker official image for.
- image-type - This is the type of image that we intend to build. This will be dropdown menu type selection in the workflow. `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/display/KAFKA/KIP-975%3A+Docker+Image+for+Apache+Kafka).
- **NOTE:** As of now [KIP-1028](https://cwiki.apache.org/confluence/display/KAFKA/KIP-1028%3A+Docker+Official+Image+for+Apache+Kafka) only aims to release JVM based Docker Official Images and not GraalVM based native Apache Kafka docker image.
- image-type - This is the type of image that we intend to build. This will be dropdown menu type selection in the workflow. `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/x/z5izDw).
- **NOTE:** As of now [KIP-1028](https://cwiki.apache.org/confluence/x/0AmpEQ) only aims to release JVM based Docker Official Images and not GraalVM based native Apache Kafka docker image.

2 changes: 1 addition & 1 deletion docker/native/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- The Native Apache Kafka Docker Image can launch brokers with sub-second startup time and minimal memory footprint by leveraging native Kafka executable.
- The native Kafka executable is built by compiling Apache Kafka code ahead-of-time using the [GraalVM native-image tool](https://www.graalvm.org/jdk21/reference-manual/native-image/).
- This image is experimental and intended for local development and testing purposes only; it is not recommended for production use.
- This is introduced with [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker).
- This is introduced with [KIP-974](https://cwiki.apache.org/confluence/x/KZizDw).

## Native-Image reachability metadata
The native-image tool performs static analysis while building a native binary to determine the dynamic features(the dynamic language features of the JVM, including reflection and resource handling, compute the dynamically-accessed program elements such as invoked methods or resource URLs at runtime), but it cannot always exhaustively predict all uses.
Expand Down
4 changes: 2 additions & 2 deletions trogdor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Trogdor can run benchmarks and other workloads. Trogdor can also inject faults i

Quickstart
=========================================================
First, we want to [start a single-node Kafka cluster in KRaft mode](https://github.com/apache/kafka/blob/trunk/README.md#running-a-kafka-broker-in-kraft-mode)
Copy link
Copy Markdown
Contributor Author

@johnny94 johnny94 Apr 9, 2025

Choose a reason for hiding this comment

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

running-a-kafka-borker-in-kraft-mode no longer exist by #18301.
Also modified the sentence to align with the PR

First, we want to [start a single-node Kafka cluster](https://github.com/apache/kafka/blob/trunk/README.md#running-a-kafka-broker)

Running Kafka in Kraft mode:
Running Kafka:

```
KAFKA_CLUSTER_ID="$(./bin/kafka-storage.sh random-uuid)"
Expand Down