Skip to content

Commit ba97558

Browse files
authored
MINOR: Improve RLMM doc (#20306)
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: Aiven-Open/tiered-storage-for-apache-kafka#681 Reviewers: Luke Chen <[email protected]>, TengYao Chi <[email protected]>, Chia-Ping Tsai <[email protected]>
1 parent bf42924 commit ba97558

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/configuration.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,23 @@ <h4><a id="org.apache.kafka.automatic.config.providers"></a><a id="systempropert
329329
<h3 class="anchor-heading"><a id="tieredstorageconfigs" class="anchor-link"></a><a href="#tieredstorageconfigs">3.11 Tiered Storage Configs</a></h3>
330330
Below is the Tiered Storage configuration.
331331
<!--#include virtual="generated/remote_log_manager_config.html" -->
332+
333+
<h4 class="anchor-heading"><a id="rlmmconfigs" class="anchor-link"></a><a href="#rlmmconfigs">3.11.1 RLMM Configs</a></h4>
334+
<p>Below is the configuration for <code>TopicBasedRemoteLogMetadataManager</code>, which is the default implementation of <code>RemoteLogMetadataManager</code>.</p>
335+
<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>
332336
<!--#include virtual="generated/remote_log_metadata_manager_config.html" -->
333337

338+
<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>
339+
<p>Additional configurations can be provided for different types of clients using the following configuration properties: </p>
340+
<pre><code class="language-text"># Configs for admin, producer, and consumer clients
341+
&lt;rlmm.prefix&gt;.remote.log.metadata.common.client.&lt;kafka.property&gt; = &lt;value&gt;
342+
343+
# Configs only for producer client
344+
&lt;rlmm.prefix&gt;.remote.log.metadata.producer.&lt;kafka.property&gt; = &lt;value&gt;
345+
346+
# Configs only for consumer client
347+
&lt;rlmm.prefix&gt;.remote.log.metadata.consumer.&lt;kafka.property&gt; = &lt;value&gt;</code></pre>
348+
334349
<h3 class="anchor-heading">
335350
<a id="config_providers" class="anchor-link"></a>
336351
<a href="#config_providers">3.12 Configuration Providers</a>

0 commit comments

Comments
 (0)