Skip to content

MINOR: Improve RLMM doc#20306

Merged
chia7712 merged 1 commit into
apache:trunkfrom
mapan1984:improve-rlmm-doc
Aug 8, 2025
Merged

MINOR: Improve RLMM doc#20306
chia7712 merged 1 commit into
apache:trunkfrom
mapan1984:improve-rlmm-doc

Conversation

@mapan1984

@mapan1984 mapan1984 commented Aug 5, 2025

Copy link
Copy Markdown
Contributor

Improve RLMM doc:

  1. Distinguish RLMM configs from other tiered storage configs, all RLMM configs need to start with a specific prefix, but the original documentation miss description.
  2. Added description of additional configs for client, which is required when configuring authentication information. This can confuse users, for example: Getting this error after enabling kafka tier storage Aiven-Open/tiered-storage-for-apache-kafka#681

Reviewers: Luke Chen showuon@gmail.com, TengYao Chi kitingiao@gmail.com, Chia-Ping Tsai chia7712@gmail.com

Change-Id: I187156ba38879701af3c3884ab9f7237ad97f79f
@github-actions github-actions Bot added triage PRs from the community docs small Small PRs labels Aug 5, 2025

@showuon showuon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. Could you follow this guide to generate the doc and have some screenshot for us to show how it will look like after this change?

Thank you.

@mapan1984

Copy link
Copy Markdown
Contributor Author

@showuon Here are screenshots related to the changes:
image
image

@showuon showuon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@frankvicky frankvicky left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mapan1984 LGTM

@github-actions github-actions Bot removed the triage PRs from the community label Aug 8, 2025
Comment thread docs/configuration.html
<pre><code class="language-text"># Configs for admin, producer, and consumer clients
&lt;rlmm.prefix&gt;.remote.log.metadata.common.client.&lt;kafka.property&gt; = &lt;value&gt;

# Configs only for producer client

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@showuon Do you know why the admin does not have a config prefix like that?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No special reason behind it. I think it's just that most of the configs in admin is overlapping with producer/consumer. But maybe it'd be better we have a way to set configs to only admin client.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KAFKA-19590 is created for this improvement.

@chia7712 chia7712 merged commit ba97558 into apache:trunk Aug 8, 2025
18 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants