You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: README.md
+22
Original file line number
Diff line number
Diff line change
@@ -99,6 +99,8 @@ fail due to code changes. You can just run:
99
99
100
100
./gradlew processMessages processTestMessages
101
101
102
+
See [Apache Kafka Message Definitions](clients/src/main/resources/common/message/README.md) for details on Apache Kafka message protocol.
103
+
102
104
### Running a Kafka broker
103
105
104
106
Using compiled files:
@@ -111,6 +113,8 @@ Using docker image:
111
113
112
114
docker run -p 9092:9092 apache/kafka:latest
113
115
116
+
See [docker/README.md](docker/README.md) for detailed information.
117
+
114
118
### Cleaning the build ###
115
119
./gradlew clean
116
120
@@ -263,10 +267,28 @@ default. See https://www.lightbend.com/blog/scala-inliner-optimizer for more det
263
267
264
268
See [tests/README.md](tests/README.md).
265
269
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
+
266
276
### Running in Vagrant ###
267
277
268
278
See [vagrant/README.md](vagrant/README.md).
269
279
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
+
270
292
### Contribution ###
271
293
272
294
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).
Copy file name to clipboardExpand all lines: docker/README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -27,11 +27,11 @@ Building image and running tests using github actions
27
27
- This is the recommended way to build, test and get a CVE report for the docker image.
28
28
- 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.
29
29
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.
31
31
32
32
- 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.
35
35
36
36
- Example(jvm):-
37
37
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.
- 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.
Copy file name to clipboardExpand all lines: docker/native/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
- The Native Apache Kafka Docker Image can launch brokers with sub-second startup time and minimal memory footprint by leveraging native Kafka executable.
5
5
- 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/).
6
6
- 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).
8
8
9
9
## Native-Image reachability metadata
10
10
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.
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)
0 commit comments