root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

KAFKA-17740 Update Readme and documentation (#17435) 

Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
This commit is contained in:
Ken Huang 2024-10-18 10:54:02 +08:00 committed by GitHub
parent d9cbbcf69c
commit e01f6a5c1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -4,12 +4,10 @@ See our [web site](https://kafka.apache.org) for details on the project.
You need to have [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed. You need to have [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed.
We build and test Apache Kafka with Java 8, 11, 17 and 21. We set the `release` parameter in javac and scalac We build and test Apache Kafka with 11, 17 and 21. We set the `release` parameter in javac and scalac
to `8` to ensure the generated binaries are compatible with Java 8 or higher (independently of the Java version to `11` to ensure the generated binaries are compatible with Java 11 or higher (independently of the Java version
used for compilation). Java 8 support project-wide has been deprecated since Apache Kafka 3.0, Java 11 support for used for compilation). Java 11 support for the broker and tools has been deprecated since Apache Kafka 3.7 and removal
the broker and tools has been deprecated since Apache Kafka 3.7 and removal of both is planned for Apache Kafka 4.0 ( of both is planned for Apache Kafka 4.0.([KIP-1013](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=284789510) for more details).
see [KIP-750](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=181308223) and
[KIP-1013](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=284789510) for more details).
Scala 2.13 is the only supported version in Apache Kafka. Scala 2.13 is the only supported version in Apache Kafka.
@ -182,15 +180,11 @@ You can run checkstyle using:
The checkstyle warnings will be found in `reports/checkstyle/reports/main.html` and `reports/checkstyle/reports/test.html` files in the The checkstyle warnings will be found in `reports/checkstyle/reports/main.html` and `reports/checkstyle/reports/test.html` files in the
subproject build directories. They are also printed to the console. The build will fail if Checkstyle fails. subproject build directories. They are also printed to the console. The build will fail if Checkstyle fails.
**Please note that `./gradlew spotlessCheck` currently has an issue with Java 21 (see https://github.com/diffplug/spotless/pull/1920), so make sure to run this with JDK 11 or 17**
#### Spotless #### #### Spotless ####
The import order is a part of static check. please call `spotlessApply` (require JDK 11+) to optimize the imports of Java codes before filing pull request. The import order is a part of static check. please call `spotlessApply` to optimize the imports of Java codes before filing pull request.
./gradlew spotlessApply ./gradlew spotlessApply
**Please note that `./gradlew spotlessApply` currently has an issue with Java 21 (see https://github.com/diffplug/spotless/pull/1920), so make sure to run this with JDK 11 or 17**
#### Spotbugs #### #### Spotbugs ####
Spotbugs uses static analysis to look for bugs in the code. Spotbugs uses static analysis to look for bugs in the code.
You can run spotbugs using: You can run spotbugs using:

5
docs/ops.html
View File

@ -1249,10 +1249,9 @@ queued.max.requests=[number of concurrent requests]</code></pre>
<h3 class="anchor-heading"><a id="java" class="anchor-link"></a><a href="#java">6.6 Java Version</a></h3> <h3 class="anchor-heading"><a id="java" class="anchor-link"></a><a href="#java">6.6 Java Version</a></h3>
Java 8, Java 11, Java 17, and Java 21 are supported. Java 11, Java 17, and Java 21 are supported.
<p> <p>
Note that Java 8 support project-wide has been deprecated since Apache Kafka 3.0 and Java 11 support for the broker and tools Note that Java 11 support for the broker and tools has been deprecated since Apache Kafka 3.7. Both will be removed in Apache Kafka 4.0.
has been deprecated since Apache Kafka 3.7. Both will be removed in Apache Kafka 4.0.
<p> <p>
Java 11 and later versions perform significantly better if TLS is enabled, so they are highly recommended (they also include a number of other Java 11 and later versions perform significantly better if TLS is enabled, so they are highly recommended (they also include a number of other
performance improvements: G1GC, CRC32C, Compact Strings, Thread-Local Handshakes and more). performance improvements: G1GC, CRC32C, Compact Strings, Thread-Local Handshakes and more).

2
docs/quickstart.html
View File

@ -42,7 +42,7 @@ $ cd kafka_{{scalaVersion}}-{{fullDotVersion}}</code></pre>
<a href="#quickstart_startserver">Step 2: Start the Kafka environment</a> <a href="#quickstart_startserver">Step 2: Start the Kafka environment</a>
</h4> </h4>
<p class="note">NOTE: Your local environment must have Java 8+ installed.</p> <p class="note">NOTE: Your local environment must have Java 11+ installed.</p>
<p>Apache Kafka can be started using KRaft or ZooKeeper. To get started with either configuration follow one of the sections below but not both.</p> <p>Apache Kafka can be started using KRaft or ZooKeeper. To get started with either configuration follow one of the sections below but not both.</p>

4
docs/upgrade.html
View File

@ -138,6 +138,10 @@
Scala 2.12 support has been removed in Apache Kafka 4.0 Scala 2.12 support has been removed in Apache Kafka 4.0
See <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=181308218">KIP-751</a> for more details See <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=181308218">KIP-751</a> for more details
</li> </li>
<li>
Java 8 support has been removed in Apache Kafka 4.0
See <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=181308223">KIP-750</a> for more details
</li>
<li>The <code>--delete-config</code> option in the <code>kafka-topics</code> command line tool has been deprecated. <li>The <code>--delete-config</code> option in the <code>kafka-topics</code> command line tool has been deprecated.
</li> </li>
</ul> </ul>