Skip to content

MINOR: Improve RLMM doc #20306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chia7712 merged 1 commit into from
Aug 8, 2025
Merged

MINOR: Improve RLMM doc #20306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/configuration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,8 +329,23 @@ <h4><a id="org.apache.kafka.automatic.config.providers"></a><a id="systempropert
<h3 class="anchor-heading"><a id="tieredstorageconfigs" class="anchor-link"></a><a href="#tieredstorageconfigs">3.11 Tiered Storage Configs</a></h3>
Below is the Tiered Storage configuration.
<!--#include virtual="generated/remote_log_manager_config.html" -->

<h4 class="anchor-heading"><a id="rlmmconfigs" class="anchor-link"></a><a href="#rlmmconfigs">3.11.1 RLMM Configs</a></h4>
<p>Below is the configuration for <code>TopicBasedRemoteLogMetadataManager</code>, which is the default implementation of <code>RemoteLogMetadataManager</code>.</p>
<p>All configurations here should start with the prefix defined by <code>remote.log.metadata.manager.impl.prefix</code>, for example, <code>rlmm.config.remote.log.metadata.consume.wait.ms</code>.</p>
<!--#include virtual="generated/remote_log_metadata_manager_config.html" -->

<p>The implementation of <code>TopicBasedRemoteLogMetadataManager</code> needs to create admin, producer, and consumer clients for the internal topic <code>__remote_log_metadata</code>.</p>
<p>Additional configurations can be provided for different types of clients using the following configuration properties: </p>
<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

@chia7712 chia7712 Aug 8, 2025

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?

@showuon showuon Aug 8, 2025

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.

@showuon showuon Aug 8, 2025

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.

&lt;rlmm.prefix&gt;.remote.log.metadata.producer.&lt;kafka.property&gt; = &lt;value&gt;

# Configs only for consumer client
&lt;rlmm.prefix&gt;.remote.log.metadata.consumer.&lt;kafka.property&gt; = &lt;value&gt;</code></pre>

<h3 class="anchor-heading">
<a id="config_providers" class="anchor-link"></a>
<a href="#config_providers">3.12 Configuration Providers</a>
Expand Down