Class PhysicalClusterMetadata

java.lang.Object

io.confluent.kafka.multitenant.BasePhysicalClusterMetadata<io.confluent.kafka.multitenant.KafkaLogicalClusterMetadata>

io.confluent.kafka.multitenant.PhysicalClusterMetadata

All Implemented Interfaces:

org.apache.kafka.common.Configurable, org.apache.kafka.common.Reconfigurable, org.apache.kafka.server.multitenant.MultiTenantMetadata

public class PhysicalClusterMetadata
extends io.confluent.kafka.multitenant.BasePhysicalClusterMetadata<io.confluent.kafka.multitenant.KafkaLogicalClusterMetadata>

File-based implementation of physical cluster metadata that reads LKC metadata from JSON files on disk. This was the original K1 CCloud sidecar approach where a K8s sidecar would write <lkc>.json files to a watched directory.

In production, all CCloud clusters now use TopicBasedPhysicalClusterMetadata instead, which reads LKC metadata as protobuf from the _confluent-logical_clusters internal topic. This class is retained for use in integration tests, where writing JSON files is simpler than producing to an internal topic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PhysicalClusterMetadata.State

Field Summary

Fields

Modifier and Type	Field	Description
SslCertificateManager	sslCertificateManager
TenantLifecycleManager	tenantLifecycleManager

Fields inherited from interface org.apache.kafka.server.multitenant.MultiTenantMetadata

CONFLUENT_ENV_ID

Constructor Summary

Constructors

Constructor	Description
PhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics)
PhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics, org.apache.kafka.common.utils.Time time)

Method Summary

Modifier and Type	Method	Description
void	close(String brokerSessionUuid)
void	configure(Map<String,?> configs)	Loads the cache and starts listening for directory events in directory specified in ConfluentConfigs.MULTITENANT_METADATA_DIR_CONFIG config.
String	dedicatedLogicalClusterId()
boolean	isUp()	Returns true if cache is loaded and listening for metadata, otherwise returns false.
Set<String>	kafkaLogicalClusterIds()
Set<String>	logicalClusterIds()
Set<String>	logicalClusterIdsIncludingStale()
io.confluent.kafka.multitenant.KafkaLogicalClusterMetadata	metadata(String logicalClusterId)
Map<org.apache.kafka.common.Endpoint, CompletableFuture<Void>>	start(Map<String,Object> interBrokerClientConfigs, Collection<org.apache.kafka.common.Endpoint> endpoints)
void	startClients(Function<String, org.apache.kafka.clients.admin.Admin> adminClientSupplier)

Methods inherited from class io.confluent.kafka.multitenant.BasePhysicalClusterMetadata

getInstance, getTenantMetadataForDedicatedCluster, reconfigurableConfigs, reconfigure, validateReconfiguration

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.kafka.server.multitenant.MultiTenantMetadata

ensureOpen, firstActiveUserLkcMetadata, registerTenantCallback, registerTenantDeactivatedCallback, registerTenantMetadataUpdateCallback

Field Details

tenantLifecycleManager

public TenantLifecycleManager tenantLifecycleManager

sslCertificateManager

public SslCertificateManager sslCertificateManager

Constructor Details

PhysicalClusterMetadata

public PhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics)

PhysicalClusterMetadata

public PhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics,
 org.apache.kafka.common.utils.Time time)

Method Details

configure

public void configure(Map<String,?> configs)

Loads the cache and starts listening for directory events in directory specified in ConfluentConfigs.MULTITENANT_METADATA_DIR_CONFIG config. Adds the instance for the given broker session UUID, specified in KafkaConfig.BrokerSessionUuidProp, to the static instance map. The caller of this method must call close() when done to remove the instance from the static map. In addition to events in the directory, we are scheduling a full reload of the directory every MULTITENANT_METADATA_RELOAD_DELAY_MS to make sure nothing is missed

Parameters:

configs - broker configuration

Throws:

org.apache.kafka.common.config.ConfigException - if KafkaConfig.BrokerSessionUuidProp is not set, or ConfluentConfigs.MULTITENANT_METADATA_DIR_CONFIG is not set.

UnsupportedOperationException - if another instance of this class with the same broker session UUID was already configured.

close

public void close(String brokerSessionUuid)

startClients

public void startClients(Function<String, org.apache.kafka.clients.admin.Admin> adminClientSupplier)

start

public Map<org.apache.kafka.common.Endpoint, CompletableFuture<Void>> start(Map<String,Object> interBrokerClientConfigs,
 Collection<org.apache.kafka.common.Endpoint> endpoints)

isUp

public boolean isUp()

Returns true if cache is loaded and listening for metadata, otherwise returns false.

dedicatedLogicalClusterId

public String dedicatedLogicalClusterId()

kafkaLogicalClusterIds

public Set<String> kafkaLogicalClusterIds()

logicalClusterIds

public Set<String> logicalClusterIds()

logicalClusterIdsIncludingStale

public Set<String> logicalClusterIdsIncludingStale()

Specified by:

logicalClusterIdsIncludingStale in class io.confluent.kafka.multitenant.BasePhysicalClusterMetadata<io.confluent.kafka.multitenant.KafkaLogicalClusterMetadata>

metadata

public io.confluent.kafka.multitenant.KafkaLogicalClusterMetadata metadata(String logicalClusterId)

Specified by:

metadata in interface org.apache.kafka.server.multitenant.MultiTenantMetadata

Specified by:

metadata in class io.confluent.kafka.multitenant.BasePhysicalClusterMetadata<io.confluent.kafka.multitenant.KafkaLogicalClusterMetadata>