Skip to content

Commit e9ca0bb

Browse files
authored
KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md (apache#19420)
There are few README not added because I am not sure if they need to be mentioned in root README. ``` ./test-common/test-common-internal-api/src/main/java/org/apache/kafka/common/test/api/README.md ./storage/src/test/java/org/apache/kafka/tiered/storage/README.md ./.github/workflows/README.md ./raft/README.md ./committer-tools/README.md ``` Reviewers: Ken Huang <[email protected]>, TengYao Chi <[email protected]>, PoAn Yang <[email protected]>, Jhen-Yung Hsu <[email protected]>, Chia-Ping Tsai <[email protected]>
1 parent b5f8aaf commit e9ca0bb

File tree

4 files changed

+30
-8
lines changed

4 files changed

+30
-8
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ fail due to code changes. You can just run:
9999

100100
./gradlew processMessages processTestMessages
101101

102+
See [Apache Kafka Message Definitions](clients/src/main/resources/common/message/README.md) for details on Apache Kafka message protocol.
103+
102104
### Running a Kafka broker
103105

104106
Using compiled files:
@@ -111,6 +113,8 @@ Using docker image:
111113

112114
docker run -p 9092:9092 apache/kafka:latest
113115

116+
See [docker/README.md](docker/README.md) for detailed information.
117+
114118
### Cleaning the build ###
115119
./gradlew clean
116120

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

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

270+
### Using Trogdor for testing ###
271+
272+
We use Trogdor as a test framework for Apache Kafka. You can use it to run benchmarks and other workloads.
273+
274+
See [trogdor/README.md](trogdor/README.md).
275+
266276
### Running in Vagrant ###
267277

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

280+
### Release Kafka ###
281+
282+
See [release/README.md](release/README.md).
283+
284+
### Official Documentation ###
285+
286+
See [docs/README.md](docs/README.md).
287+
288+
### Kafka client examples ###
289+
290+
See [examples/README.md](examples/README.md).
291+
270292
### Contribution ###
271293

272294
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).

docker/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Building image and running tests using github actions
2727
- This is the recommended way to build, test and get a CVE report for the docker image.
2828
- 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.
2929

30-
- 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.
30+
- 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.
3131

3232
- image-type - This is the type of image that we intend to build. This will be dropdown menu type selection in the workflow.
33-
- `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)
34-
- `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)
33+
- `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)
34+
- `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.
3535

3636
- Example(jvm):-
3737
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.
@@ -210,6 +210,6 @@ python generate_kafka_pr_template.py --image-type=jvm
210210
```
211211

212212
- 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.
213-
- 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).
214-
- **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.
213+
- 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).
214+
- **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.
215215

docker/native/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- The Native Apache Kafka Docker Image can launch brokers with sub-second startup time and minimal memory footprint by leveraging native Kafka executable.
55
- 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/).
66
- This image is experimental and intended for local development and testing purposes only; it is not recommended for production use.
7-
- This is introduced with [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker).
7+
- This is introduced with [KIP-974](https://cwiki.apache.org/confluence/x/KZizDw).
88

99
## Native-Image reachability metadata
1010
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.

trogdor/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Trogdor can run benchmarks and other workloads. Trogdor can also inject faults i
66

77
Quickstart
88
=========================================================
9-
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)
9+
First, we want to [start a single-node Kafka cluster](https://github.com/apache/kafka/blob/trunk/README.md#running-a-kafka-broker)
1010

11-
Running Kafka in Kraft mode:
11+
Running Kafka:
1212

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

0 commit comments

Comments
 (0)