mirror of https://github.com/apache/kafka.git
KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md (#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 <s7133700@gmail.com>, TengYao Chi <kitingiao@gmail.com>, PoAn Yang <payang@apache.org>, Jhen-Yung Hsu <jhenyunghsu@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
This commit is contained in:
parent
b5f8aaf2ac
commit
e9ca0bb0f6
22
README.md
22
README.md
|
@ -99,6 +99,8 @@ fail due to code changes. You can just run:
|
||||||
|
|
||||||
./gradlew processMessages processTestMessages
|
./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
|
### Running a Kafka broker
|
||||||
|
|
||||||
Using compiled files:
|
Using compiled files:
|
||||||
|
@ -111,6 +113,8 @@ Using docker image:
|
||||||
|
|
||||||
docker run -p 9092:9092 apache/kafka:latest
|
docker run -p 9092:9092 apache/kafka:latest
|
||||||
|
|
||||||
|
See [docker/README.md](docker/README.md) for detailed information.
|
||||||
|
|
||||||
### Cleaning the build ###
|
### Cleaning the build ###
|
||||||
./gradlew clean
|
./gradlew clean
|
||||||
|
|
||||||
|
@ -263,10 +267,28 @@ default. See https://www.lightbend.com/blog/scala-inliner-optimizer for more det
|
||||||
|
|
||||||
See [tests/README.md](tests/README.md).
|
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 ###
|
### Running in Vagrant ###
|
||||||
|
|
||||||
See [vagrant/README.md](vagrant/README.md).
|
See [vagrant/README.md](vagrant/README.md).
|
||||||
|
|
||||||
|
### Release Kafka ###
|
||||||
|
|
||||||
|
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 ###
|
### 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).
|
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).
|
||||||
|
|
|
@ -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.
|
- 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.
|
- 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.
|
- 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)
|
- `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/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming)
|
- `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):-
|
- 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.
|
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
|
||||||
```
|
```
|
||||||
|
|
||||||
- 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.
|
- 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).
|
- 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/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.
|
- **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.
|
||||||
|
|
||||||
|
|
|
@ -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 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/).
|
- 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 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
|
## 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.
|
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.
|
||||||
|
|
|
@ -6,9 +6,9 @@ Trogdor can run benchmarks and other workloads. Trogdor can also inject faults i
|
||||||
|
|
||||||
Quickstart
|
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)
|
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)"
|
KAFKA_CLUSTER_ID="$(./bin/kafka-storage.sh random-uuid)"
|
||||||
|
|
Loading…
Reference in New Issue