Browse Source

MINOR: Fix errors in javadoc and docs in tiered storage (#14379)

Reviewers: Satish Duggana <satishd@apache.org>
pull/14380/head
Luke Chen 1 year ago committed by GitHub
parent
commit
8a7e5e8ea0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java
  2. 11
      storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteLogMetadataManager.java
  3. 4
      storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java
  4. 6
      storage/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteLogManagerConfig.java

2
clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java

@ -76,7 +76,7 @@ public class TopicConfig { @@ -76,7 +76,7 @@ public class TopicConfig {
"their data. If set to -1, no time limit is applied.";
public static final String REMOTE_LOG_STORAGE_ENABLE_CONFIG = "remote.storage.enable";
public static final String REMOTE_LOG_STORAGE_ENABLE_DOC = "To enable tier storage for a topic, set `remote.storage.enable` as true. " +
public static final String REMOTE_LOG_STORAGE_ENABLE_DOC = "To enable tiered storage for a topic, set this configuration as true. " +
"You can not disable this config once it is enabled. It will be provided in future versions.";
public static final String LOCAL_LOG_RETENTION_MS_CONFIG = "local.retention.ms";

11
storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteLogMetadataManager.java

@ -36,18 +36,17 @@ import java.util.concurrent.CompletableFuture; @@ -36,18 +36,17 @@ import java.util.concurrent.CompletableFuture;
* remote.log.metadata.manager.class.name is not configured.
* </p>
* <p>
* <code>remote.log.metadata.manager.class.path</code> property is about the class path of the RemoteLogStorageManager
* implementation. If specified, the RemoteLogStorageManager implementation and its dependent libraries will be loaded
* <code>remote.log.metadata.manager.class.path</code> property is about the class path of the RemoteLogMetadataManager
* implementation. If specified, the RemoteLogMetadataManager implementation and its dependent libraries will be loaded
* by a dedicated classloader which searches this class path before the Kafka broker class path. The syntax of this
* parameter is same with the standard Java class path string.
* </p>
* <p>
* <code>remote.log.metadata.manager.listener.name</code> property is about listener name of the local broker to which
* it should get connected if needed by RemoteLogMetadataManager implementation. When this is configured all other
* required properties can be passed as properties with prefix of 'remote.log.metadata.manager.listener.
* it should get connected if needed by RemoteLogMetadataManager implementation.
* </p>
* "cluster.id", "broker.id" and all other properties prefixed with "remote.log.metadata." are passed when
* {@link #configure(Map)} is invoked on this instance.
* "cluster.id", "broker.id" and all other properties prefixed with the config: "remote.log.metadata.manager.impl.prefix"
* (default value is "rlmm.config.") are passed when {@link #configure(Map)} is invoked on this instance.
* <p>
*/
@InterfaceStability.Evolving

4
storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageManager.java

@ -22,6 +22,7 @@ import org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata.Custo @@ -22,6 +22,7 @@ import org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata.Custo
import java.io.Closeable;
import java.io.InputStream;
import java.util.Map;
import java.util.Optional;
/**
@ -36,6 +37,9 @@ import java.util.Optional; @@ -36,6 +37,9 @@ import java.util.Optional;
* responsible for storing and fetching metadata about the remote log segments in a strongly consistent manner.
* This allows {@link RemoteStorageManager} to have eventual consistency on metadata (although the data is stored
* in strongly consistent semantics).
* <p>
* All properties prefixed with the config: "remote.log.storage.manager.impl.prefix"
* (default value is "rsm.config.") are passed when {@link #configure(Map)} is invoked on this instance.
*/
@InterfaceStability.Evolving
public interface RemoteStorageManager extends Configurable, Closeable {

6
storage/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteLogManagerConfig.java

@ -61,11 +61,11 @@ public final class RemoteLogManagerConfig { @@ -61,11 +61,11 @@ public final class RemoteLogManagerConfig {
public static final boolean DEFAULT_REMOTE_LOG_STORAGE_SYSTEM_ENABLE = false;
public static final String REMOTE_STORAGE_MANAGER_CLASS_NAME_PROP = "remote.log.storage.manager.class.name";
public static final String REMOTE_STORAGE_MANAGER_CLASS_NAME_DOC = "Fully qualified class name of `RemoteLogStorageManager` implementation.";
public static final String REMOTE_STORAGE_MANAGER_CLASS_NAME_DOC = "Fully qualified class name of `RemoteStorageManager` implementation.";
public static final String REMOTE_STORAGE_MANAGER_CLASS_PATH_PROP = "remote.log.storage.manager.class.path";
public static final String REMOTE_STORAGE_MANAGER_CLASS_PATH_DOC = "Class path of the `RemoteLogStorageManager` implementation. " +
"If specified, the RemoteLogStorageManager implementation and its dependent libraries will be loaded by a dedicated " +
public static final String REMOTE_STORAGE_MANAGER_CLASS_PATH_DOC = "Class path of the `RemoteStorageManager` implementation. " +
"If specified, the RemoteStorageManager implementation and its dependent libraries will be loaded by a dedicated " +
"classloader which searches this class path before the Kafka broker class path. The syntax of this parameter is same " +
"as the standard Java class path string.";

Loading…
Cancel
Save