[ 
https://issues.apache.org/jira/browse/KAFKA-19988?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18044719#comment-18044719
 ] 

Gergely Harmadás commented on KAFKA-19988:
------------------------------------------

[~chia7712] Thanks for checking the Jira. I have opened 
[kafka#21137|https://github.com/apache/kafka/pull/21137] for the fix. FYI 
currently {{ops.html}} is out of sync between [kafka 
3.9|https://github.com/apache/kafka/blob/3.9/docs/ops.html] and 
[kafka-site|https://github.com/apache/kafka-site/blob/asf-site/39/ops.html]. 
What I gathered is the following:
 # [kafka#19158|https://github.com/apache/kafka/pull/19158] was opened to kafka 
3.9 but the author was advised to instead open it directly to kafka-site since 
the 3.9 docs was already published
 # [kafka-site#667|https://github.com/apache/kafka-site/pull/667] was merged
 # The newly added section was accidentally overridden in 
[kafka-site#687|https://github.com/apache/kafka-site/pull/687] during the 3.9.1 
release since it was not part of [ops.html in 
kafka|https://github.com/apache/kafka/blob/3.9/docs/ops.html]
 # [kafka-site#695|https://github.com/apache/kafka-site/pull/695] was merged in 
order to revert some 3.9 doc changes that were unexpectedly overwritten 
including the section about the kafka-storage tool command

All in all the section about the kafka-storage tool command is still missing 
from [ops.html in 
kafka|https://github.com/apache/kafka/blob/3.9/docs/ops.html]. I included in my 
PR since I have to modify it anyway and this way there is no chance for an 
accidental removal from kafka-site.

> KRaft migration doc should account for ZK cluster id with a leading dash
> ------------------------------------------------------------------------
>
>                 Key: KAFKA-19988
>                 URL: https://issues.apache.org/jira/browse/KAFKA-19988
>             Project: Kafka
>          Issue Type: Bug
>          Components: docs, documentation, kraft, migration
>    Affects Versions: 3.9.1
>            Reporter: Gergely Harmadás
>            Assignee: Gergely Harmadás
>            Priority: Minor
>             Fix For: 3.9.2
>
>
> When preparing for the migration, there is a small chance that the retrieved 
> cluster id from ZooKeeper contains a leading dash. Currently the 3.9 
> documentation specifies the following during the step "Provisioning the KRaft 
> controller quorum":
> {code:bash}
> # Save the previously retrieved cluster ID from ZooKeeper in a variable 
> called zk-cluster-id
> $ bin/kafka-storage.sh format --standalone -t <zk-cluster-id> -c 
> config/kraft/controller.properties{code}
> However the above command will fail with a less fortunate cluster id like 
> -{{{}Yh6XyBIQ9CeAlMwJ8f7Hg{}}}, eg.:
> {noformat}
> bin/kafka-storage.sh format --standalone -t -Yh6XyBIQ9CeAlMwJ8f7Hg -c 
> config/server.properties
> 25/12/12 09:24:54 INFO  utils.Log4jControllerRegistration$: [main]: 
> Registered `kafka:type=kafka.Log4jController` MBean
> usage: kafka-storage format [-h] --config CONFIG --cluster-id CLUSTER_ID 
> [--add-scram ADD_SCRAM] [--ignore-formatted] [--release-version 
> RELEASE_VERSION] [--feature FEATURE] [--standalone |
>                      --no-initial-controllers | --initial-controllers 
> INITIAL_CONTROLLERS]
> kafka-storage: error: argument --cluster-id/-t: expected one argument
> {noformat}
> A similar problem came up with KRaft which was addressed in KAFKA-13741. In 
> our case the cluster id is already specified, there is no way to change it. I 
> was able to come up with a simple solution by using the full name of the 
> argument like "--cluster-id=<zk-cluster-id>" instead of the shorthand "-t 
> <zk-cluster-id>". Full example:
> {code:bash}
> bin/kafka-storage.sh format --cluster-id=-Yh6XyBIQ9CeAlMwJ8f7Hg -c 
> config/kraft/controller.properties{code}
> I would propose to change the documentation based on my findings so we will 
> be able to cover also ZooKeeper based cluster ids with a leading dash.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to