Commit Graph

186 Commits

Author SHA1 Message Date
Federico Valeri d705be05d9
MINOR: Fix other tools' formatting in documentation (#17572)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-10-23 02:24:55 +08:00
Colin Patrick McCabe e3751a838c
KAFKA-17794: Add some formatting safeguards for KIP-853 (#17504)
KIP-853 adds support for dynamic KRaft quorums. This means that the quorum topology is
no longer statically determined by the controller.quorum.voters configuration. Instead, it
is contained in the storage directories of each controller and broker.

Users of dynamic quorums must format at least one controller storage directory with either
the --initial-controllers or --standalone flags.  If they fail to do this, no quorum can be
established. This PR changes the storage tool to warn about the case where a KIP-853 flag has
not been supplied to format a KIP-853 controller. (Note that broker storage directories
can continue to be formatted without a KIP-853 flag.)

There are cases where we don't want to specify initial voters when formatting a controller. One
example is where we format a single controller with --standalone, and then dynamically add 4
more controllers with no initial topology. In this case, we want the 4 later controllers to grab
the quorum topology from the initial one. To support this case, this PR adds the
--no-initial-controllers flag.

Reviewers: José Armando García Sancio <jsancio@apache.org>, Federico Valeri <fvaleri@redhat.com>
2024-10-21 10:06:41 -07:00
Federico Valeri 7aaffed372
MINOR: Add missing extention to tools commands (#17548)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-10-19 22:01:36 +08:00
Ken Huang e01f6a5c1e
KAFKA-17740 Update Readme and documentation (#17435)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-10-18 10:54:02 +08:00
José Armando García Sancio 34c158f67f
MINOR: Replace gt and lt char with html encoding (#17235)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-09-24 19:29:11 +08:00
José Armando García Sancio aee44efd40
KAFKA-17048; Update docs for KIP-853 (#17076)
Change the configurations under config/kraft to use controller.quorum.bootstrap.servers instead of controller.quorum.voters. Add comments explaining how to use the older static quorum configuration where appropriate.

In docs/ops.html, remove the reference to "tentative timelines for ZooKeeper removal" and "Tiered storage is considered as an early access feature" since they are no longer up-to-date. Add KIP-853 information.

In docs/quickstart.html, move the ZK instructions to be after the KRaft instructions. Update the KRaft instructions to use KIP-853.

In docs/security.html, add an explanation of --bootstrap-controller and document controller.quorum.bootstrap.servers instead of controller.quorum.voters.

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Alyssa Huang <ahuang@confluent.io>, Colin P. McCabe <cmccabe@apache.org>
2024-09-18 11:23:58 -07:00
Luke Chen 887b947d8a
MINOR: Update doc for tiered storage GA (#17088)
Reviewers: Satish Duggana <satishd@apache.org>
2024-09-05 15:56:23 +05:30
Eric Chang 4b41071165
KAFKA-17086 add missing Java 21 to ops.html (#16911)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-08-19 00:51:27 +08:00
Luke Chen 03d1a736cb
KAFKA-17300: Add document for new tiered storage feature in v3.9.0. (#16836)
- Added document for disabling tiered storage at topic level
- Added notable changes items in v3.9.0 for tiered storage quota

Reviewers: Satish Duggana <satishd@apache.org>, Kamal Chandraprakash<kamal.chandraprakash@gmail.com>, Abhijeet Kumar<abhijeet.cse.kgp@gmail.com>
2024-08-13 17:31:39 +05:30
Nancy 25b955ddf2
Kafka 16887 : Upgrade the document to add remote copy/fetch quotas metrics values. (#16863)
Reviewers: Abhijeet Kumar<abhijeet.cse.kgp@gmail.com>, Luke Chen <showuon@gmail.com>, Satish Duggana <satishd@apache.org>
2024-08-13 12:29:22 +05:30
Igor Soarez 8c066e625c
MINOR: Update docs, remove JBOD from missing features (#16801)
Reviewers: Josep Prat <josep.prat@aiven.io>
2024-08-06 11:18:14 +01:00
David Arthur b3fd9a5a95
KAFKA-17146 Include note to remove migration znode (#16770)
When reverting the ZK migration, we must also remove the /migration ZNode in order to allow the migration to be re-attempted in the future.

Reviewers: Colin P. McCabe <cmccabe@apache.org>, Chia-Ping Tsai <chia7712@gmail.com>
2024-08-05 03:13:26 +08:00
TingIāu "Ting" Kì baa0fc9722
KAFKA-17042 The migration docs should remind users to set "broker.id.generation.enable" when adding broker.id (#16491)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia771@gmail.com>
2024-07-05 18:21:40 +08:00
Lucas Brutschy 7ab7773617
MINOR: Update 3.8 documentation for Kafka Streams (#16265)
All public interface changes should be briefly mentioned in the
upgrade guide.

Reviewers: Matthias J. Sax <matthias@confluent.io>, Anna Sophie Blee-Goldman <sophie@responsive.dev>, Nick Telford <nick.telford@gmail.com>
2024-06-26 13:55:18 +02:00
Mickael Maison 2b491f9611
MINOR: Add docs for replica.alter.log.dirs.io.max.bytes.per.second config (#16386)
Reviewers: Luke Chen <showuon@gmail.com>
2024-06-19 11:19:59 +02:00
Mickael Maison c4a3d2475f
MINOR: Refresh of the docs (#16375)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-06-18 17:15:47 +02:00
Matthias J. Sax f80deeabbc
MINOR: update Kafka Streams docs with 3.4 KIP information (#16336)
Reviewers: Jim Galasyn <jim.galasyn@confluent.io>, Bill Bejeck <bill@confluent.io>
2024-06-14 15:01:35 -07:00
Matthias J. Sax 92614699e6
MINOR: update Kafka Streams docs with 3.3 KIP information (#16316)
Reviewers: Lucas Brutschy <lbrutschy@confluent.io>, Jim Galasyn <jim.galasyn@confluent.io>
2024-06-13 15:17:00 -07:00
Maciej Moscicki 53841625fc
MINOR: Add fast_commit ext4 config to ops docs (#15496)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
Co-authored-by: Piotr Rzysko <piotr.rzysko@allegro.com>
2024-06-10 12:49:21 +02:00
Sebastien Viale 871b1db044
MINOR: update all-latency-max, range-latency-avg|max and add prefix-scan documentation (#16182)
Reviewers: Matthias J. Sax <matthias@confluent.io>
2024-06-07 14:23:29 -07:00
Sebastien Viale f8ad9ee892
MINOR: update all-latency-avg documentation (#16148)
Change description: from iterator create to close time.

Reviewers: Matthias J. Sax <matthias@confluent.io>
2024-05-31 12:24:01 -07:00
Igor Soarez 269b457d30
MINOR: Add missing docs for migration metrics (#15718)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2024-04-16 16:20:52 +02:00
Igor Soarez 31171d0791
MINOR: Document JBOD limitation during migration (#15692)
Document JBOD limitation during migration when log dir failure.

Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-04-12 14:50:09 +08:00
John Yu cfa7d39360
MINOR : Removed the depreciated information about Zk to Kraft migration. (#15552)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-03-21 10:57:59 +08:00
PoAn Yang 1bb36c2bc1
MINOR: change "inter.broker.protocol version" to inter.broker.protocol.version (#15504)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-03-10 03:28:06 +08:00
Owen Leung 3f3cee1b21
KAFKA-16325 Add missing producer metrics to documentatio (#15466)
Add `buffer-exhausted-rate`, `buffer-exhausted-total`, `bufferpool-wait-ratio` and `metadata-wait-time-ns-total`

Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-03-08 07:07:21 +08:00
Stanislav Kozlovski a512ef1478
MINOR: Add 3.7 JBOD KRaft Early Acces disclaimer (#15418)
This patch adds a small disclaimer to the ops documentation page to mention that JBOD is in early access with 3.7
2024-02-22 23:55:19 +01:00
Paolo Patierno 9118ad653f
Additional fix on the rollback migration documentation (#15317)
This is an additional PR to fix rollback migration documentation related to #15287

Reviewers: Luke Chen <showuon@gmail.com>
2024-02-21 17:43:05 +08:00
Paolo Patierno ddc5d1dc34
MINOR: Added ACLs authorizer change during migration (#15333)
This trivial PR makes clear when it's the right time to switch from AclAuthorizer to StandardAuthorizer during the migration process.

Reviewers: Luke Chen <showuon@gmail.com>
2024-02-16 18:57:22 +08:00
Luke Chen 501f82b91c
KAFKA-15670: add "inter.broker.listener.name" config in KRaft controller config (#14631)
During ZK migrating to KRaft, before entering dual-write mode, the KRaft controller will send RPCs (i.e. UpdateMetadataRequest, LeaderAndIsrRequest, and StopReplicaRequest) to the brokers. Currently, we use the inter broker listener to send the RPC to brokers from the controller. But in the doc, we didn't provide this info to users because the normal KRaft controller won't use inter.broker.listener.names.

This PR adds the missing config in the ZK migrating to KRaft doc.

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Paolo Patierno <ppatierno@live.com>
2024-02-16 18:56:06 +08:00
Colin P. McCabe b8ad609541 Revert "KAFKA-16101: Additional fixes on KRaft migration documentation (#15287)"
This reverts commit 46d76269fa.
2024-02-01 16:17:18 -08:00
Paolo Patierno 46d76269fa
KAFKA-16101: Additional fixes on KRaft migration documentation (#15287)
This PR fixes a couple of things related to the #15193 PR.

When you complete "Enter Migration Mode on the brokers", we are actually in "Enabling the migration on the brokers" referring to the migration guide and the broker doesn't really have node.id yet but still broker.id, so the PR removes a statement saying to replace the one with the other.

Also, during rollback it's not enough just deleting the /controller znode quickly after shutting down controllers because the controller election doesn't start yet until at least one broker is rolled back with the right configuration. Until the rolling and when controllers are down, the brokers just log something like this even if you deleted the znode "quickly":

[2024-01-30 09:27:52,394] DEBUG [zk-broker-0-to-controller-quorum-channel-manager]: Controller isn't cached, looking for local metadata changes (kafka.server.BrokerToControllerRequestThread)
[2024-01-30 09:27:52,394] INFO [zk-broker-0-to-controller-quorum-channel-manager]: Recorded new controller, from now on will use node localhost:9093 (id: 1 rack: null) (kafka.server.BrokerToControllerRequestThread)

You have to reduce the amount of time between deleting the znode and rolling at least one broker, so that an election can start.

Reviewers: Luke Chen <showuon@gmail.com>
2024-01-31 15:24:47 +08:00
Colin Patrick McCabe 5b422613a6
KAFKA-16101: Fix KRaft migration documentation (#15193)
This PR fixes some bugs in the KRaft migration documentation and reorganizes it to be easier to read. (Specifically, there were some steps that were previously out of order.)

In order to keep it all straight, the revert documentation is now in the form of a table which maps the latest migration state to the actions which the system administrator should perform.

Reviewers: Luke Chen <showuon@gmail.com>, David Arthur <mumrah@gmail.com>, Liu Zeyu <zeyu.luke@gmail.com>, Paolo Patierno <ppatierno@live.com>
2024-01-29 14:34:07 -08:00
Ismael Juma 92a67e8571
Note that Java 11 support for broker and tools is deprecated for removal in 4.0 (#15236)
Reviewers: Divij Vaidya <diviv@amazon.com>
2024-01-19 14:08:07 -08:00
Christo Lolov 71b2cd6173
MINOR: Add public documentation for metrics introduced in KIP-963 (#15138)
Reviewers: Satish Duggana <satishd@apache.org>, Kamal Chandraprakash<kamal.chandraprakash@gmail.com>
2024-01-09 08:47:31 +05:30
Paolo Patierno 137fc18713
KAFKA-16005: Add details about rollback during ZK->KRaft migration in docs (#15012)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Luke Chen <showuon@gmail.com>
2023-12-14 14:59:29 +01:00
Mickael Maison 74be72a559
MINOR: Various fixes in the docs (#14914)
- Only use https links
- Fix broken HTML tags
- Replace usage of <tt> which is deprecated with <code>
- Replace hardcoded version numbers

Reviewers: Chris Egerton <fearthecellos@gmail.com>, Greg Harris <gharris1727@gmail.com>
2023-12-04 22:06:49 +01:00
Colin Patrick McCabe 4874bf818a
KAFKA-15311: Fix docs about reverting to ZooKeeper mode during KRaft migration (#14160)
- Remove the outdated statement that delegation tokens aren't supported by KRaft.

- Add an invitation to report migration bugs on JIRA.

- Define terminology such as "zk migration phases".

- Mention MV can't be changed during migration.

- Explain how to revert to ZK mode.

Reviewers: Ron Dagostino <rndgstn@gmail.com>, David Arthur <mumrah@gmail.com>
2023-11-28 14:03:59 -08:00
Bruno Cadonna 81cceedf7e
MINOR: Delete task-level commit sensor (#14677)
The task-level commit metrics were removed without deprecation in KIP-447 and the corresponding PR #8218. However, we forgot to update the docs and to remove the code that creates the task-level commit sensor.
This PR removes the task-level commit metrics from the docs and removes the code that creates the task-level commit sensor. The code was effectively dead since it was only used in tests.

Reviewers: Guozhang Wang <wangguoz@gmail.com>, Matthias J. Sax <matthias@confluent.io>
2023-11-09 15:37:13 +01:00
Luke Chen 7376d2c5b1
MINOR: add quick start for tiered storage feature (#14528)
Some users complained they don't have a way to determine if there is something wrong in the RSM plug-in they implemented, or there's something wrong in Kafka itself. Also, if there are users who just want to try the tiered storage feature out before implementing anything, it would be good we have an RSM implementation by default.

Per the discussion in the KIP, there will be no default RSM implementation in Kafka, but we can use the LocalTieredStorage implemented for integration test, to resolve the issues above.

Reviewers: Christo Lolov <lolovc@amazon.com>, Divij Vaidya <diviv@amazon.com>, Kamal Chandraprakash <kamal.chandraprakash@gmail.com>, Satish Duggana <satishd@apache.org>
2023-10-17 10:30:11 +08:00
bachmanity1 eb187745cd
MINOR: Fix docs for ReplicationBytes(Out|In)PerSec metrics (#14228)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Taras Ledkov
2023-10-16 15:12:38 +02:00
Justine Olshan b5d880a707
KAFKA-15330: Add missing documentation of metrics introduced as part of KAFKA-15028 (#14480)
I've added details for VerificationFailureRate and VerificationTimeMs.

I considered adding the documentation for the AddPartitionsToTxnVerification metrics, but I noticed that all the request metrics simply listed Produce|FetchConsumer|FetchFollower. If we don't already report the AddPartitionsToTxn request metrics in this file, it doesn't make sense to add the verification variant. (As well as all the other APIs we report)

Filed a followup jira if we want to redo that whole section.

Reviewers: Reviewers: Divij Vaidya <diviv@amazon.com>
2023-10-04 13:28:30 -07:00
David Arthur 5f676cce7a KAFKA-15483: Add KIP-938 and KIP-866 metrics to bundled docs (#14421)
Reviewers: Divij Vaidya <diviv@amazon.com>, Ron Dagostino <rdagostino@confluent.io>
2023-10-03 13:51:30 +02:00
Luke Chen ac39342d47
KAFKA-15442: add a section in doc for tiered storage (#14382)
Added 6.11: Tiered Storage section and notable changes ini v3.6.0

Reviewers: Satish Duggana <satishd@apache.org>, Gantigmaa Selenge <gselenge@redhat.com>
2023-09-14 20:21:00 +08:00
Federico Valeri 4405f8f956
MINOR: Fix metadata.version reference in "ZooKeeper to KRaft Migration" documentation (#14366)
In "ZooKeeper to KRaft Migration" documentation, we are still reporting 3.4 as metadata version. Reworking that phrase to make it more clear and avoid the need to update it in the future.

Signed-off-by: Federico Valeri <fedevaleri@gmail.com>

Reviewers: Luke Chen <showuon@gmail.com>
2023-09-12 20:44:04 +08:00
atu-sharm 9ecf6f7f1c
KAFKA-15338: The metric group documentation for metrics added in KAFKA-13945 is incorrect (#14221)
Reviewers: Matthias J. Sax <matthias@confluent.io>
2023-09-07 19:05:14 -07:00
Abhijeet Kumar 37a51e286d
KAFKA-15293 Added documentation for tiered storage metrics (#14331)
Reviewers: Divij Vaidya <diviv@amazon.com>, Satish Duggana <satishd@apache.org>
2023-09-05 22:19:10 +05:30
Matthias J. Sax af1f50fc9e
MINOR: fix docs markup (#14085)
Reviewers: Qichao Chu (@ex172000), Mickael Maison <mickael.maison@gmail.com>
2023-07-25 14:56:58 -07:00
Chase Thomas a82df3000a
MINOR: Update docs to include ZK deprecation notice and information (#14031)
Reviewers: Ismael Juma <ismael@confluent.io>, Mickael Maison <mickael.maison@gmail.com>, Divij Vaidya <diviv@amazon.com>, Matthias J. Sax <matthias@confluent.io>
2023-07-18 14:36:12 -07:00
Gantigmaa Selenge 5cb2504c49
KAFKA-14669: Use the generated docs for MirrorMaker configs in the doc (#13658)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-07-18 11:27:19 -04:00