Package com.linkedin.venice.controller

Class VeniceParentHelixAdmin

java.lang.Object

com.linkedin.venice.controller.VeniceParentHelixAdmin

All Implemented Interfaces:

Admin, Closeable, AutoCloseable

public class VeniceParentHelixAdmin
extends Object
implements Admin

This class is a wrapper of VeniceHelixAdmin, which will be used in parent controller. There should be only one single Parent Controller, which is the endpoint for all the admin data update. For every admin update operation, it will first push admin operation messages to Kafka, then wait for the admin consumer to consume the message. All validations on the updates should be done before the admin operation message is published to Kafka.

Nested Class Summary

Nested classes/interfaces inherited from interface com.linkedin.venice.controller.Admin

Admin.OfflinePushStatusInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Class<? extends Throwable>>	RETRY_FAILURE_TYPES

Constructor Summary

Constructors

Constructor	Description
VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin, VeniceControllerMultiClusterConfig multiClusterConfigs, boolean sslEnabled, Optional<SSLConfig> sslConfig, Optional<DynamicAccessController> accessController, Optional<AuthorizerService> authorizerService, LingeringStoreVersionChecker lingeringStoreVersionChecker, WriteComputeSchemaConverter writeComputeSchemaConverter, Optional<SupersetSchemaGenerator> externalSupersetSchemaGenerator, PubSubTopicRepository pubSubTopicRepository, DelegatingClusterLeaderInitializationRoutine initRoutineForPushJobDetailsSystemStore, DelegatingClusterLeaderInitializationRoutine initRoutineForHeartbeatSystemStore, DelegatingClusterLeaderInitializationRoutine initRoutineForParentControllerMetadataSystemStore, io.tehuti.metrics.MetricsRepository metricsRepository)
VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin, VeniceControllerMultiClusterConfig multiClusterConfigs, boolean sslEnabled, Optional<SSLConfig> sslConfig, Optional<DynamicAccessController> accessController, Optional<AuthorizerService> authorizerService, LingeringStoreVersionChecker lingeringStoreVersionChecker, io.tehuti.metrics.MetricsRepository metricsRepository)
VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin, VeniceControllerMultiClusterConfig multiClusterConfigs, boolean sslEnabled, Optional<SSLConfig> sslConfig, Optional<AuthorizerService> authorizerService, io.tehuti.metrics.MetricsRepository metricsRepository)
VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin, VeniceControllerMultiClusterConfig multiClusterConfigs, io.tehuti.metrics.MetricsRepository metricsRepository)

Method Summary

Modifier and Type	Method	Description
void	abortMigration(String srcClusterName, String destClusterName, String storeName)	Abort store migration by sending a ABORT_MIGRATION admin message.
DerivedSchemaEntry	addDerivedSchema(String clusterName, String storeName, int valueSchemaId, int derivedSchemaId, String derivedSchemaStr)	Unsupported operation in the parent controller.
DerivedSchemaEntry	addDerivedSchema(String clusterName, String storeName, int valueSchemaId, String derivedSchemaStr)	Add a new superset schema for the given store with all specified properties by sending a DERIVED_SCHEMA_CREATION admin message.
void	addInstanceToAllowlist(String clusterName, String helixNodeId)	Unsupported operation in the parent controller.
RmdSchemaEntry	addReplicationMetadataSchema(String clusterName, String storeName, int valueSchemaId, int replicationMetadataVersionId, String replicationMetadataSchemaStr)	Create a new ReplicationMetadataSchemaEntry object with the given properties and add it into schema repository by sending REPLICATION_METADATA_SCHEMA_CREATION admin message.
SchemaEntry	addSupersetSchema(String clusterName, String storeName, String valueSchemaStr, int valueSchemaId, String supersetSchemaStr, int supersetSchemaId)	Unsupported operation in the parent controller.
SchemaEntry	addValueSchema(String clusterName, String storeName, String newValueSchemaStr, int schemaId, DirectionalSchemaCompatibilityType expectedCompatibilityType)
SchemaEntry	addValueSchema(String clusterName, String storeName, String newValueSchemaStr, DirectionalSchemaCompatibilityType expectedCompatibilityType)	Add a new value schema for the given store with all specified properties by sending a VALUE_SCHEMA_CREATION admin message.
void	addVersionAndStartIngestion(String clusterName, String storeName, String pushJobId, int versionNumber, int numberOfPartitions, Version.PushType pushType, String remoteKafkaBootstrapServers, long rewindTimeInSecondsOverride, int ignoredRmdVersionID, boolean versionSwapDeferred, int repushSourceVersion)	This method behaves differently in VeniceHelixAdmin and VeniceParentHelixAdmin.
void	autoMigrateStore(String srcClusterName, String destClusterName, String storeName, Optional<Integer> currStep, Optional<Boolean> abortOnFailure)	This method is used to auto-migrate a store from one cluster to another.
int	calculateNumberOfPartitions(String clusterName, String storeName)	Calculate how many partitions are needed for the given store.
void	checkResourceCleanupBeforeStoreCreation(String clusterName, String storeName)	This function will check whether there are still resources left for the requested store in the requested cluster.
List<String>	cleanupInstanceCustomizedStates(String clusterName)	Scan through instance level customized states and remove any lingering ZNodes that are no longer relevant.
void	close()	Cause VeniceParentHelixAdmin and its associated services to stop executing.
StoreComparisonInfo	compareStore(String clusterName, String storeName, String fabricA, String fabricB)	Compare store metadata and version states between two fabrics.
void	completeMigration(String srcClusterName, String destClusterName, String storeName)
void	configureActiveActiveReplication(String clusterName, VeniceUserStoreType storeType, Optional<String> storeName, boolean enableNativeReplicationForCluster, Optional<String> regionsFilter)	Enable/disable active active replications for certain stores (batch only, hybrid only, incremental push, hybrid or incremental push, all) in a cluster.
StoreInfo	copyOverStoreSchemasAndConfigs(String clusterName, String srcFabric, String destFabric, String storeName)
void	createStoragePersona(String clusterName, String name, long quotaNumber, Set<String> storesToEnforce, Set<String> owners)	Creates a new persona with the given parameters.
void	createStore(String clusterName, String storeName, String owner, String keySchema, String valueSchema, boolean isSystemStore, Optional<String> accessPermissions)	Create a store by sending STORE_CREATION admin message to the Kafka admin topic, sending META_SYSTEM_STORE_AUTO_CREATION_VALIDATION admin message, and performing initialization steps for using authorize server to manage ACLs for the input store.
void	deleteAclForStore(String clusterName, String storeName)	Delete the current set of ACL provisioned for a venice store and its associated kafka topic.
protected void	deleteAclsForStore(Store store, String storeName)	Deletes the acls associated with a store
List<Version>	deleteAllVersionsInStore(String clusterName, String storeName)	Delete all of venice versions in given store(including venice resource, kafka topic, offline pushs and all related resources).
void	deleteOldVersionInStore(String clusterName, String storeName, int versionNum)	Delete the given version from the store.
void	deleteStoragePersona(String clusterName, String name)	Deletes the persona with the given name.
void	deleteStore(String clusterName, String storeName, boolean isAbortMigrationCleanup, int largestUsedVersionNumber, boolean waitOnRTTopicDeletion)	Delete a store by sending DELETE_STORE admin message to the Kafka admin topic and clearing all ACLs and release resource for the target store from authorize service.
void	deleteValueSchemas(String clusterName, String storeName, Set<Integer> unusedValueSchemaIds)	Deletes a store's values schema with ids `except` the ids passed in the argument inuseValueSchemaIds
String	discoverCluster(String storeName)	Find the cluster which the given store belongs to.
Map<String,String>	findAllBootstrappingVersions(String clusterName)	Unsupported operation in the parent controller.
String	getAclForStore(String clusterName, String storeName)	Fetch the current set of ACL provisioned for a venice store and its associated kafka topic.
Optional<AdminCommandExecutionTracker>	getAdminCommandExecutionTracker(String clusterName)	Get the tracker used to track the execution of the admin command for the given cluster.
AdminConsumerService	getAdminConsumerService(String clusterName)
Map<String,Long>	getAdminOperationVersionFromControllers(String clusterName)
Map<String,Long>	getAdminTopicMetadata(String clusterName, Optional<String> storeName)	Get AdminTopicMetadata from parent controller
InstanceRemovableStatuses	getAggregatedHealthStatus(String cluster, List<String> instances, List<String> toBeStoppedInstances, boolean isSSLEnabled)
Optional<String>	getAggregateRealTimeTopicSource(String clusterName)	Return the source Kafka boostrap server url for aggregate real-time topic updates
Set<String>	getAllowlist(String clusterName)	Unsupported operation in the parent controller.
Map<String,String>	getAllStorePushStrategyForMigration()
List<Store>	getAllStores(String clusterName)
Map<String,String>	getAllStoreStatuses(String clusterName)	Unsupported operation in the parent controller.
int	getBackupVersion(String clusterName, String storeName)
long	getBackupVersionDefaultRetentionMs()	Returns default backup version retention time.
Map<String,String>	getBackupVersionsForMultiColos(String clusterName, String storeName)
BatchJobHeartbeatValue	getBatchJobHeartbeatValue(BatchJobHeartbeatKey batchJobHeartbeatKey)
String	getChildControllerD2ServiceName(String clusterName)	Get child datacenter controller d2 service name
Map<String,String>	getChildDataCenterControllerD2Map(String clusterName)	Get child datacenter to child controller d2 zk host mapping
Map<String,String>	getChildDataCenterControllerUrlMap(String clusterName)	Get child datacenter to child controller url mapping.
List<String>	getClustersLeaderOf()	Get a list of clusters this controller is a leader of.
Map<String,StoreDataAudit>	getClusterStaleStores(String clusterName)	This function will iterate over all of Helix Parent Admin's child controllers, in order to ask about stale stores.
List<StoragePersona>	getClusterStoragePersonas(String clusterName)
ArrayList<StoreInfo>	getClusterStores(String clusterName)	Unsupported operation in the parent controller.
CompactionManager	getCompactionManager()
VeniceControllerClusterConfig	getControllerConfig(String clusterName)
String	getControllerName()
int	getCurrentVersion(String clusterName, String storeName)	Unsupported operation in the parent controller.
Map<String,Integer>	getCurrentVersionsForMultiColos(String clusterName, String storeName)	Query the current version for the given store.
int	getDatacenterCount(String clusterName)	number of datacenters, 1 if in single cluster mode.
List<StoreInfo>	getDeadStores(String clusterName, String storeName, Map<String,String> params)	Cause Admin.getDeadStores(String, String, Map)
int	getDefaultMaxRecordSizeBytes()
GeneratedSchemaID	getDerivedSchemaId(String clusterName, String storeName, String schemaStr)
Collection<DerivedSchemaEntry>	getDerivedSchemas(String clusterName, String storeName)
Optional<String>	getEmergencySourceRegion(String clusterName)	Return the emergency source region configuration.
protected static ExecutionStatus	getFinalReturnStatus(Map<String,ExecutionStatus> statuses, Set<String> childRegions, int numChildRegionsFailedToFetchStatus, StringBuilder currentReturnStatusDetails)	Based on the global information, start determining the final status to return
int	getFutureVersion(String clusterName, String storeName)	Unsupported operation in the parent controller and returns Store.NON_EXISTING_VERSION.
Map<String,String>	getFutureVersionsForMultiColos(String clusterName, String storeName)
long	getHeartbeatFromSystemStore(String clusterName, String storeName)	Read the latest heartbeat timestamp from system store.
HelixVeniceClusterResources	getHelixVeniceClusterResources(String cluster)
Version	getIncrementalPushVersion(String clusterName, String storeName, String pushJobId)	A couple of extra checks are needed in parent controller 1.
Set<Integer>	getInUseValueSchemaIds(String clusterName, String storeName)
String	getKafkaBootstrapServers(boolean isSSL)	Return the ssl or non-ssl bootstrap servers based on the given flag.
SchemaEntry	getKeySchema(String clusterName, String storeName)
int	getLargestUsedVersion(String clusterName, String storeName)
int	getLargestUsedVersionFromStoreGraveyard(String clusterName, String storeName)	Deprecated but remain here to keep compatibility until Admin.getLargestUsedVersion(String, String) is used.
Long	getLastSucceedExecutionId(String clustername)	Get the id of the last succeed execution in this controller.
Instance	getLeaderController(String clusterName)	Get instance of leader controller.
long	getLocalAdminOperationProtocolVersion()
LogContext	getLogContext()
MetaStoreReader	getMetaStoreReader()
StoreMetaValue	getMetaStoreValue(StoreMetaKey metaKey, String storeName)
MetaStoreWriter	getMetaStoreWriter()	Return a MetaStoreWriter, which can be shared across different Venice clusters.
int	getMinNumberOfUnusedKafkaTopicsToPreserve()
String	getNativeReplicationKafkaBootstrapServerAddress(String sourceFabric)
String	getNativeReplicationSourceFabric(String clusterName, Store store, Optional<String> sourceGridFabric, Optional<String> emergencySourceRegion, String targetedRegions)
Admin.OfflinePushStatusInfo	getOffLinePushStatus(String clusterName, String kafkaTopic)	Queries child clusters for status.
Admin.OfflinePushStatusInfo	getOffLinePushStatus(String clusterName, String kafkaTopic, Optional<String> incrementalPushVersion, String region, String targetedRegions, boolean isTargetRegionPushWithDeferredSwap)
ParentControllerRegionState	getParentControllerRegionState()	Return the state of the region of the parent controller.
StoragePersona	getPersonaAssociatedWithStore(String clusterName, String storeName)
VeniceProperties	getPubSubSSLProperties(String pubSubBrokerAddress)
PubSubTopicRepository	getPubSubTopicRepository()
PushJobDetails	getPushJobDetails(PushJobStatusRecordKey key)
PushStatusStoreReader	getPushStatusStoreReader()
PushStatusStoreWriter	getPushStatusStoreWriter()
HelixReadOnlyZKSharedSchemaRepository	getReadOnlyZKSharedSchemaRepository()	Return a shared read only schema repository for zk shared stores.
HelixReadOnlyZKSharedSystemStoreRepository	getReadOnlyZKSharedSystemStoreRepository()	Return a shared read only store repository for zk shared stores.
Version	getReferenceVersionForStreamingWrites(String clusterName, String storeName, String pushJobId)
String	getRegionName()	Return the region name of this Admin
RegionPushDetails	getRegionPushDetails(String clusterName, String storeName, boolean isPartitionDetailAdded)	Unsupported operation in the parent controller.
List<Replica>	getReplicas(String clusterName, String kafkaTopic)
List<Replica>	getReplicasOfStorageNode(String clusterName, String instanceId)	Unsupported operation in the parent controller.
int	getReplicationFactor(String clusterName, String storeName)
Optional<org.apache.avro.Schema>	getReplicationMetadataSchema(String clusterName, String storeName, int valueSchemaID, int rmdVersionID)
Collection<RmdSchemaEntry>	getReplicationMetadataSchemas(String clusterName, String storeName)
RepushInfo	getRepushInfo(String clusterName, String storeName, Optional<String> fabricName)
String	getRouterD2Service(String clusterName)	Find the router d2 service associated with a given cluster name.
RoutersClusterConfig	getRoutersClusterConfig(String clusterName)	Unsupported operation in the parent controller.
String	getServerD2Service(String clusterName)	Find the server d2 service associated with a given cluster name.
double	getStorageEngineOverheadRatio(String clusterName)
List<String>	getStorageNodes(String clusterName)	Unsupported operation in the parent controller.
Map<String,String>	getStorageNodesStatus(String clusterName, boolean enableReplica)	Unsupported operation in the parent controller.
StorageNodeStatus	getStorageNodesStatus(String clusterName, String instanceId)	Unsupported operation in the parent controller.
StoragePersona	getStoragePersona(String clusterName, String name)
Store	getStore(String clusterName, String storeName)
HelixReadOnlyStoreConfigRepository	getStoreConfigRepo()	Return a shared store config repository.
StoreGraveyard	getStoreGraveyard()
List<StoreInfo>	getStoresForCompaction(String clusterName)	see Admin.getStoresForCompaction(java.lang.String)
TopicManager	getTopicManager()
TopicManager	getTopicManager(String pubSubServerAddress)
SchemaEntry	getValueSchema(String clusterName, String storeName, int id)
int	getValueSchemaId(String clusterName, String storeName, String valueSchemaStr)
Collection<SchemaEntry>	getValueSchemas(String clusterName, String storeName)
VeniceHelixAdmin	getVeniceHelixAdmin()
VeniceWriterFactory	getVeniceWriterFactory()
boolean	hasStore(String clusterName, String storeName)
boolean	hasWritePermissionToBatchJobHeartbeatStore(X509Certificate requesterCert, String batchJobHeartbeatStoreName)	Test if the given certificate has the write-access permission for the given batch-job heartbeat store.
Version	incrementVersionIdempotent(String clusterName, String storeName, String pushJobId, int numberOfPartitions, int replicationFactor, Version.PushType pushType, boolean sendStartOfPush, boolean sorted, String compressionDictionary, Optional<String> sourceGridFabric, Optional<X509Certificate> requesterCert, long rewindTimeInSecondsOverride, Optional<String> emergencySourceRegion, boolean versionSwapDeferred, String targetedRegions, int repushSourceVersion)
void	initiateDataRecovery(String clusterName, String storeName, int version, String sourceFabric, String destinationFabric, boolean copyAllVersionConfigs, Optional<Version> ignored)	Initiate data recovery for a store version given a source fabric.
void	initStorageCluster(String clusterName)	Initialize Venice storage cluster in Helix by: creating and configuring required properties in Helix. waiting resource's (partial) partition to appear in the external view. making sure admin Kafka topics is created. creating a Venice writer for the cluster.
boolean	isActiveActiveReplicationEnabledInAllRegion(String clusterName, String storeName, boolean checkCurrentVersion)	Returns true if A/A replication is enabled in all child controller and parent controller.
boolean	isClusterValid(String clusterName)	Test if a cluster is valid (in Helix cluster list).
NodeRemovableResult	isInstanceRemovable(String clusterName, String instanceId, List<String> lockedNodes)	Unsupported operation in the parent controller.
boolean	isLeaderControllerFor(String clusterName)	Check if this controller itself is the leader controller for a given cluster or not.
boolean	isLeaderControllerOfControllerCluster()	This function can be used to perform cluster-wide operations which need to be performed by a single process only in the whole cluster.
boolean	isParent()	Check whether the controller works as a parent controller
boolean	isResourceStillAlive(String resourceName)	Unsupported operation in the parent controller.
boolean	isRTTopicDeletionPermittedByAllControllers(String clusterName, String storeName)
boolean	isSSLEnabledForPush(String clusterName, String storeName)	Return whether ssl is enabled for the given store for push.
boolean	isSslToKafka()
boolean	isStorageNodeNewerOrEqualTo(String clusterName, String instanceId, StorageNodeStatus oldServerStatus)	Unsupported operation in the parent controller.
boolean	isStoreMigrationAllowed(String clusterName)
Pair<Boolean,String>	isStoreVersionReadyForDataRecovery(String clusterName, String storeName, int version, String sourceFabric, String destinationFabric, Optional<Integer> ignored)	Check if the store version's previous states and resources are cleaned up and ready to start data recovery.
boolean	isTopicTruncated(String kafkaTopicName)
boolean	isTopicTruncatedBasedOnRetention(long retention)
boolean	isTopicTruncatedBasedOnRetention(String kafkaTopicName, long retentionTime)
void	killOfflinePush(String clusterName, String kafkaTopic, boolean isForcedKill)	Kill an offline push if it ran into errors or the corresponding version is being retired.
Map<String,RegionPushDetails>	listStorePushInfo(String clusterName, String storeName, boolean isPartitionDetailEnabled)	This function will look for a single store, given a name and cluster name, and return information about the current push jobs for that store across all regions.
void	migrateStore(String srcClusterName, String destClusterName, String storeName)	Migrate a store from its source cluster to a new destination cluster by sending a MIGRATE_STORE admin message.
Pair<NodeReplicasReadinessState,List<Replica>>	nodeReplicaReadiness(String cluster, String helixNodeId)	Unsupported operation in the parent controller.
void	prepareDataRecovery(String clusterName, String storeName, int version, String sourceFabric, String destinationFabric, Optional<Integer> ignored)	Prepare for data recovery in the destination fabric.
DerivedSchemaEntry	removeDerivedSchema(String clusterName, String storeName, int valueSchemaId, int derivedSchemaId)	Unsupported operation in the parent controller.
void	removeInstanceFromAllowList(String clusterName, String helixNodeId)	Unsupported operation in the parent controller.
void	removeStorageNode(String clusterName, String instanceId)	Unsupported operation in the parent controller.
void	removeStoreFromGraveyard(String clusterName, String storeName)
RepushJobResponse	repushStore(RepushJobRequest repushJobRequest)	This is the entry/exit common point for manual and scheduled repush codepaths.
void	rollbackToBackupVersion(String clusterName, String storeName, String regionFilter)	Set backup version as current version in all child regions.
void	rollForwardToFutureVersion(String clusterName, String storeName, String regionFilter)
void	sendHeartbeatToSystemStore(String clusterName, String systemStoreName, long heartbeatTimestamp)	Send a heartbeat timestamp to targeted system store.
void	sendPushJobDetails(PushJobStatusRecordKey key, PushJobDetails value)
void	setAdminConsumerService(String clusterName, AdminConsumerService service)
void	setStoreCurrentVersion(String clusterName, String storeName, int versionNumber)	Unsupported operation in the parent controller.
void	setStoreLargestUsedRTVersion(String clusterName, String storeName, int versionNumber)	Unsupported operation in the parent controller.
void	setStoreLargestUsedVersion(String clusterName, String storeName, int versionNumber)	Unsupported operation in the parent controller.
void	setStoreOwner(String clusterName, String storeName, String owner)	Update the owner of a specified store by sending SET_STORE_OWNER admin message to the admin topic.
void	setStorePartitionCount(String clusterName, String storeName, int partitionCount)	Update the partition count of a specified store by sending SET_STORE_PARTITION admin message to the admin topic.
void	setStorePushStrategyForMigration(String voldemortStoreName, String strategy)	Set a push-strategy in the ZK path MigrationPushStrategyZKAccessor.MIGRATION_PUSH_STRATEGY_PATH.
void	setStoreReadability(String clusterName, String storeName, boolean desiredReadability)	Update the readability of a specified store by sending ENABLE_STORE_READ or DISABLE_STORE_READ admin message.
void	setStoreReadWriteability(String clusterName, String storeName, boolean isAccessible)	Update both readability and writability of a specified store.
void	setStoreWriteability(String clusterName, String storeName, boolean desiredWriteability)	Update the writability of a specified store by sending ENABLE_STORE_WRITE or DISABLE_STORE_WRITE admin message.
void	skipAdminMessage(String clusterName, long offset, boolean skipDIV, long executionId)	The admin consumption task tries to deal with failures to process an admin message by retrying.
void	stop(String clusterName)	Stop the helix controller for a single cluster.
void	stopVeniceController()	Stop the entire controller but not only the helix controller for a single cluster.
boolean	truncateKafkaTopic(String kafkaTopicName)
boolean	truncateKafkaTopic(String kafkaTopicName, long retentionTime)	Truncate a Kafka topic by setting its retention time to the input value.
void	updateAclForStore(String clusterName, String storeName, String accessPermissions)	Provision a new set of ACL for a venice store and its associated kafka topic.
void	updateAdminOperationProtocolVersion(String clusterName, Long adminOperationProtocolVersion)	Update AdminOperationProtocolVersion in metadata
void	updateAdminTopicMetadata(String clusterName, long executionId, Optional<String> storeName, Optional<Long> offset, Optional<Long> upstreamOffset)	Unsupported operation in the parent controller.
void	updateClusterConfig(String clusterName, UpdateClusterConfigQueryParams params)
void	updateClusterDiscovery(String storeName, String oldCluster, String newCluster, String initiatingCluster)	Update the cluster discovery of a given store by writing to the StoreConfig ZNode.
void	updateDarkClusterConfig(String clusterName, UpdateDarkClusterConfigQueryParams params)
void	updateRoutersClusterConfig(String clusterName, Optional<Boolean> isThrottlingEnable, Optional<Boolean> isQuotaRebalancedEnable, Optional<Boolean> isMaxCapacityProtectionEnabled, Optional<Integer> expectedRouterCount)	Unsupported operation in the parent controller.
void	updateStoragePersona(String clusterName, String name, UpdateStoragePersonaQueryParams queryParams)	Updates a persona with the given parameters by sending a UPDATE_STORAGE_PERSONA admin message.
void	updateStore(String clusterName, String storeName, UpdateStoreQueryParams params)	Update a target store properties by first applying the provided deltas and then sending UPDATE_STORE admin message.
void	updateSystemStoreAclForStore(String clusterName, String regularStoreName, AclBinding systemStoreAclBinding)	Set the AceEntries in provided AclBinding object to be the current set of ACL's for the resource.
void	validateAndMaybeRetrySystemStoreAutoCreation(String clusterName, String storeName, VeniceSystemStoreType veniceSystemStoreType)	Unsupported operation in the parent controller.
StoreDeletedValidation	validateStoreDeleted(String clusterName, String storeName)	Validates that a store has been completely deleted from all venice clusters cross-regionally
List<Version>	versionsForStore(String clusterName, String storeName)
boolean	whetherEnableBatchPushFromAdmin(String clusterName, String storeName)
void	wipeCluster(String clusterName, String fabric, Optional<String> storeName, Optional<Integer> versionNum)	Delete stores from the cluster by sending a ControllerClient.wipeCluster(String, Optional, Optional) request.
void	writeEndOfPush(String clusterName, String storeName, int versionNumber, boolean alsoWriteStartOfPush)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.venice.controller.Admin

addValueSchema, clearInstanceMonitor, createStore, createStore, incrementVersionIdempotent, incrementVersionIdempotent, isAdminTopicConsumptionEnabled, startInstanceMonitor

Field Details

RETRY_FAILURE_TYPES

public static final List<Class<? extends Throwable>> RETRY_FAILURE_TYPES

Constructor Details

VeniceParentHelixAdmin

public VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin,
 VeniceControllerMultiClusterConfig multiClusterConfigs,
 io.tehuti.metrics.MetricsRepository metricsRepository)

VeniceParentHelixAdmin

public VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin,
 VeniceControllerMultiClusterConfig multiClusterConfigs,
 boolean sslEnabled,
 Optional<SSLConfig> sslConfig,
 Optional<AuthorizerService> authorizerService,
 io.tehuti.metrics.MetricsRepository metricsRepository)

VeniceParentHelixAdmin

public VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin,
 VeniceControllerMultiClusterConfig multiClusterConfigs,
 boolean sslEnabled,
 Optional<SSLConfig> sslConfig,
 Optional<DynamicAccessController> accessController,
 Optional<AuthorizerService> authorizerService,
 LingeringStoreVersionChecker lingeringStoreVersionChecker,
 io.tehuti.metrics.MetricsRepository metricsRepository)

VeniceParentHelixAdmin

public VeniceParentHelixAdmin(VeniceHelixAdmin veniceHelixAdmin,
 VeniceControllerMultiClusterConfig multiClusterConfigs,
 boolean sslEnabled,
 Optional<SSLConfig> sslConfig,
 Optional<DynamicAccessController> accessController,
 Optional<AuthorizerService> authorizerService,
 LingeringStoreVersionChecker lingeringStoreVersionChecker,
 WriteComputeSchemaConverter writeComputeSchemaConverter,
 Optional<SupersetSchemaGenerator> externalSupersetSchemaGenerator,
 PubSubTopicRepository pubSubTopicRepository,
 DelegatingClusterLeaderInitializationRoutine initRoutineForPushJobDetailsSystemStore,
 DelegatingClusterLeaderInitializationRoutine initRoutineForHeartbeatSystemStore,
 DelegatingClusterLeaderInitializationRoutine initRoutineForParentControllerMetadataSystemStore,
 io.tehuti.metrics.MetricsRepository metricsRepository)

Method Details

initStorageCluster

public void initStorageCluster(String clusterName)

Initialize Venice storage cluster in Helix by:

• creating and configuring required properties in Helix.
• waiting resource's (partial) partition to appear in the external view.
• making sure admin Kafka topics is created.
• creating a Venice writer for the cluster.

Specified by:

initStorageCluster in interface Admin

Parameters:

clusterName - Venice cluster name.

isClusterValid

public boolean isClusterValid(String clusterName)

Test if a cluster is valid (in Helix cluster list).

Specified by:

isClusterValid in interface Admin

Parameters:

clusterName - Venice cluster name.

Returns:

true if input cluster is in Helix cluster list; false otherwise.

deleteValueSchemas

public void deleteValueSchemas(String clusterName,
 String storeName,
 Set<Integer> unusedValueSchemaIds)

Description copied from interface: Admin

Deletes a store's values schema with ids `except` the ids passed in the argument inuseValueSchemaIds

Specified by:

deleteValueSchemas in interface Admin

autoMigrateStore

public void autoMigrateStore(String srcClusterName,
 String destClusterName,
 String storeName,
 Optional<Integer> currStep,
 Optional<Boolean> abortOnFailure)

This method is used to auto-migrate a store from one cluster to another.

Specified by:

autoMigrateStore in interface Admin

Parameters:

srcClusterName -

destClusterName -

storeName -

currStep -

abortOnFailure -

getInUseValueSchemaIds

public Set<Integer> getInUseValueSchemaIds(String clusterName,
 String storeName)

Specified by:

getInUseValueSchemaIds in interface Admin

createStore

public void createStore(String clusterName,
 String storeName,
 String owner,
 String keySchema,
 String valueSchema,
 boolean isSystemStore,
 Optional<String> accessPermissions)

Create a store by sending STORE_CREATION admin message to the Kafka admin topic, sending META_SYSTEM_STORE_AUTO_CREATION_VALIDATION admin message, and performing initialization steps for using authorize server to manage ACLs for the input store.

Specified by:

createStore in interface Admin

deleteStore

public void deleteStore(String clusterName,
 String storeName,
 boolean isAbortMigrationCleanup,
 int largestUsedVersionNumber,
 boolean waitOnRTTopicDeletion)

Delete a store by sending DELETE_STORE admin message to the Kafka admin topic and clearing all ACLs and release resource for the target store from authorize service.

Specified by:

deleteStore in interface Admin

deleteAclsForStore

protected void deleteAclsForStore(Store store,
 String storeName)

Deletes the acls associated with a store

Parameters:

store -

storeName -

addVersionAndStartIngestion

public void addVersionAndStartIngestion(String clusterName,
 String storeName,
 String pushJobId,
 int versionNumber,
 int numberOfPartitions,
 Version.PushType pushType,
 String remoteKafkaBootstrapServers,
 long rewindTimeInSecondsOverride,
 int ignoredRmdVersionID,
 boolean versionSwapDeferred,
 int repushSourceVersion)

Description copied from interface: Admin

This method behaves differently in VeniceHelixAdmin and VeniceParentHelixAdmin.

Specified by:

addVersionAndStartIngestion in interface Admin

See Also:

• Admin.addVersionAndStartIngestion(String, String, String, int, int, Version.PushType, String, long, int, boolean, int)

hasWritePermissionToBatchJobHeartbeatStore

public boolean hasWritePermissionToBatchJobHeartbeatStore(X509Certificate requesterCert,
 String batchJobHeartbeatStoreName)
                                                   throws AclException

Test if the given certificate has the write-access permission for the given batch-job heartbeat store.

Specified by:

hasWritePermissionToBatchJobHeartbeatStore in interface Admin

Parameters:

requesterCert - X.509 certificate object.

batchJobHeartbeatStoreName - name of the batch-job heartbeat store.

Returns:

true if input certificate has write-access permission for the given store; false otherwise.

Throws:

AclException

isActiveActiveReplicationEnabledInAllRegion

public boolean isActiveActiveReplicationEnabledInAllRegion(String clusterName,
 String storeName,
 boolean checkCurrentVersion)

Description copied from interface: Admin

Returns true if A/A replication is enabled in all child controller and parent controller. This is implemented only in parent controller. Otherwise, return false.

Specified by:

isActiveActiveReplicationEnabledInAllRegion in interface Admin

See Also:

• Admin.isActiveActiveReplicationEnabledInAllRegion(String, String, boolean)

incrementVersionIdempotent

public Version incrementVersionIdempotent(String clusterName,
 String storeName,
 String pushJobId,
 int numberOfPartitions,
 int replicationFactor,
 Version.PushType pushType,
 boolean sendStartOfPush,
 boolean sorted,
 String compressionDictionary,
 Optional<String> sourceGridFabric,
 Optional<X509Certificate> requesterCert,
 long rewindTimeInSecondsOverride,
 Optional<String> emergencySourceRegion,
 boolean versionSwapDeferred,
 String targetedRegions,
 int repushSourceVersion)

Specified by:

incrementVersionIdempotent in interface Admin

See Also:

• Admin.incrementVersionIdempotent(String, String, String, int, int)

getIncrementalPushVersion

public Version getIncrementalPushVersion(String clusterName,
 String storeName,
 String pushJobId)

A couple of extra checks are needed in parent controller 1. check batch job statuses across child controllers. (We cannot only check the version status in parent controller since they are marked as STARTED) 2. check if the topic is marked to be truncated or not. (This could be removed if we don't preserve incremental push topic in parent Kafka anymore

Specified by:

getIncrementalPushVersion in interface Admin

getReferenceVersionForStreamingWrites

public Version getReferenceVersionForStreamingWrites(String clusterName,
 String storeName,
 String pushJobId)

Specified by:

getReferenceVersionForStreamingWrites in interface Admin

getCurrentVersion

public int getCurrentVersion(String clusterName,
 String storeName)

Unsupported operation in the parent controller.

Specified by:

getCurrentVersion in interface Admin

getCurrentVersionsForMultiColos

public Map<String,Integer> getCurrentVersionsForMultiColos(String clusterName,
 String storeName)

Query the current version for the given store. In parent colo, Venice do not update the current version because there is not offline push monitor. So parent controller will query each prod controller and return the map.

Specified by:

getCurrentVersionsForMultiColos in interface Admin

getRepushInfo

public RepushInfo getRepushInfo(String clusterName,
 String storeName,
 Optional<String> fabricName)

Specified by:

getRepushInfo in interface Admin

Returns:

a RepushInfo object with store information retrieved from the specified cluster and fabric.

getFutureVersionsForMultiColos

public Map<String,String> getFutureVersionsForMultiColos(String clusterName,
 String storeName)

Specified by:

getFutureVersionsForMultiColos in interface Admin

See Also:

• Admin.getFutureVersionsForMultiColos(String, String)

getBackupVersionsForMultiColos

public Map<String,String> getBackupVersionsForMultiColos(String clusterName,
 String storeName)

Specified by:

getBackupVersionsForMultiColos in interface Admin

getFutureVersion

public int getFutureVersion(String clusterName,
 String storeName)

Unsupported operation in the parent controller and returns Store.NON_EXISTING_VERSION.

Specified by:

getFutureVersion in interface Admin

getBackupVersion

public int getBackupVersion(String clusterName,
 String storeName)

Specified by:

getBackupVersion in interface Admin

deleteAllVersionsInStore

public List<Version> deleteAllVersionsInStore(String clusterName,
 String storeName)

Description copied from interface: Admin

Delete all of venice versions in given store(including venice resource, kafka topic, offline pushs and all related resources).

Specified by:

deleteAllVersionsInStore in interface Admin

See Also:

• Admin.deleteAllVersionsInStore(String, String)

deleteOldVersionInStore

public void deleteOldVersionInStore(String clusterName,
 String storeName,
 int versionNum)

Description copied from interface: Admin

Delete the given version from the store. If the given version is the current version, an exception will be thrown.

Specified by:

deleteOldVersionInStore in interface Admin

See Also:

• Admin.deleteOldVersionInStore(String, String, int)

versionsForStore

public List<Version> versionsForStore(String clusterName,
 String storeName)

Specified by:

versionsForStore in interface Admin

Returns:

all versions of the specified store from a cluster.

getAllStores

public List<Store> getAllStores(String clusterName)

Specified by:

getAllStores in interface Admin

Returns:

all stores in the specified cluster.

getAllStoreStatuses

public Map<String,String> getAllStoreStatuses(String clusterName)

Unsupported operation in the parent controller.

Specified by:

getAllStoreStatuses in interface Admin

Returns:

a map whose key is store name and value is store's status.

getStore

public Store getStore(String clusterName,
 String storeName)

Specified by:

getStore in interface Admin

Returns:

Store object reference from the input store name.

hasStore

public boolean hasStore(String clusterName,
 String storeName)

Specified by:

hasStore in interface Admin

See Also:

• VeniceHelixAdmin.hasStore(String, String)

setStoreCurrentVersion

public void setStoreCurrentVersion(String clusterName,
 String storeName,
 int versionNumber)

Unsupported operation in the parent controller.

Specified by:

setStoreCurrentVersion in interface Admin

rollForwardToFutureVersion

public void rollForwardToFutureVersion(String clusterName,
 String storeName,
 String regionFilter)

Specified by:

rollForwardToFutureVersion in interface Admin

rollbackToBackupVersion

public void rollbackToBackupVersion(String clusterName,
 String storeName,
 String regionFilter)

Set backup version as current version in all child regions.

Specified by:

rollbackToBackupVersion in interface Admin

setStoreLargestUsedVersion

public void setStoreLargestUsedVersion(String clusterName,
 String storeName,
 int versionNumber)

Unsupported operation in the parent controller.

Specified by:

setStoreLargestUsedVersion in interface Admin

setStoreLargestUsedRTVersion

public void setStoreLargestUsedRTVersion(String clusterName,
 String storeName,
 int versionNumber)

Unsupported operation in the parent controller.

Specified by:

setStoreLargestUsedRTVersion in interface Admin

setStoreOwner

public void setStoreOwner(String clusterName,
 String storeName,
 String owner)

Update the owner of a specified store by sending SET_STORE_OWNER admin message to the admin topic.

Specified by:

setStoreOwner in interface Admin

setStorePartitionCount

public void setStorePartitionCount(String clusterName,
 String storeName,
 int partitionCount)

Update the partition count of a specified store by sending SET_STORE_PARTITION admin message to the admin topic.

Specified by:

setStorePartitionCount in interface Admin

setStoreReadability

public void setStoreReadability(String clusterName,
 String storeName,
 boolean desiredReadability)

Update the readability of a specified store by sending ENABLE_STORE_READ or DISABLE_STORE_READ admin message.

Specified by:

setStoreReadability in interface Admin

setStoreWriteability

public void setStoreWriteability(String clusterName,
 String storeName,
 boolean desiredWriteability)

Update the writability of a specified store by sending ENABLE_STORE_WRITE or DISABLE_STORE_WRITE admin message.

Specified by:

setStoreWriteability in interface Admin

setStoreReadWriteability

public void setStoreReadWriteability(String clusterName,
 String storeName,
 boolean isAccessible)

Update both readability and writability of a specified store.

Specified by:

setStoreReadWriteability in interface Admin

updateStore

public void updateStore(String clusterName,
 String storeName,
 UpdateStoreQueryParams params)

Update a target store properties by first applying the provided deltas and then sending UPDATE_STORE admin message.

Specified by:

updateStore in interface Admin

Parameters:

clusterName - name of the Venice cluster.

storeName - name of the to-be-updated store.

params - to-be-updated store properties.

updateClusterConfig

public void updateClusterConfig(String clusterName,
 UpdateClusterConfigQueryParams params)

Specified by:

updateClusterConfig in interface Admin

See Also:

• VeniceHelixAdmin.updateClusterConfig(String, UpdateClusterConfigQueryParams)

updateDarkClusterConfig

public void updateDarkClusterConfig(String clusterName,
 UpdateDarkClusterConfigQueryParams params)

Specified by:

updateDarkClusterConfig in interface Admin

getStorageEngineOverheadRatio

public double getStorageEngineOverheadRatio(String clusterName)

Specified by:

getStorageEngineOverheadRatio in interface Admin

See Also:

• VeniceHelixAdmin.getStorageEngineOverheadRatio(String)

getKeySchema

public SchemaEntry getKeySchema(String clusterName,
 String storeName)

Specified by:

getKeySchema in interface Admin

See Also:

• VeniceHelixAdmin.getKeySchema(String, String)

getValueSchemas

public Collection<SchemaEntry> getValueSchemas(String clusterName,
 String storeName)

Specified by:

getValueSchemas in interface Admin

See Also:

• VeniceHelixAdmin.getValueSchemas(String, String)

getDerivedSchemas

public Collection<DerivedSchemaEntry> getDerivedSchemas(String clusterName,
 String storeName)

Specified by:

getDerivedSchemas in interface Admin

See Also:

• VeniceHelixAdmin.getDerivedSchemas(String, String)

getValueSchemaId

public int getValueSchemaId(String clusterName,
 String storeName,
 String valueSchemaStr)

Specified by:

getValueSchemaId in interface Admin

See Also:

• VeniceHelixAdmin.getValueSchemaId(String, String, String)

getDerivedSchemaId

public GeneratedSchemaID getDerivedSchemaId(String clusterName,
 String storeName,
 String schemaStr)

Specified by:

getDerivedSchemaId in interface Admin

See Also:

• VeniceHelixAdmin.getDerivedSchemaId(String, String, String)

getValueSchema

public SchemaEntry getValueSchema(String clusterName,
 String storeName,
 int id)

Specified by:

getValueSchema in interface Admin

See Also:

• VeniceHelixAdmin.getValueSchema(String, String, int)

addValueSchema

public SchemaEntry addValueSchema(String clusterName,
 String storeName,
 String newValueSchemaStr,
 DirectionalSchemaCompatibilityType expectedCompatibilityType)

Add a new value schema for the given store with all specified properties by sending a VALUE_SCHEMA_CREATION admin message.

Specified by:

addValueSchema in interface Admin

Returns:

an SchemaEntry object composed of a schema and its corresponding id.

addSupersetSchema

public SchemaEntry addSupersetSchema(String clusterName,
 String storeName,
 String valueSchemaStr,
 int valueSchemaId,
 String supersetSchemaStr,
 int supersetSchemaId)

Unsupported operation in the parent controller.

Specified by:

addSupersetSchema in interface Admin

addValueSchema

public SchemaEntry addValueSchema(String clusterName,
 String storeName,
 String newValueSchemaStr,
 int schemaId,
 DirectionalSchemaCompatibilityType expectedCompatibilityType)

Specified by:

addValueSchema in interface Admin

addDerivedSchema

public DerivedSchemaEntry addDerivedSchema(String clusterName,
 String storeName,
 int valueSchemaId,
 String derivedSchemaStr)

Add a new superset schema for the given store with all specified properties by sending a DERIVED_SCHEMA_CREATION admin message.

Specified by:

addDerivedSchema in interface Admin

Returns:

an DerivedSchemaEntry object composed of a derived schema and its corresponding id.

addDerivedSchema

public DerivedSchemaEntry addDerivedSchema(String clusterName,
 String storeName,
 int valueSchemaId,
 int derivedSchemaId,
 String derivedSchemaStr)

Unsupported operation in the parent controller.

Specified by:

addDerivedSchema in interface Admin

removeDerivedSchema

public DerivedSchemaEntry removeDerivedSchema(String clusterName,
 String storeName,
 int valueSchemaId,
 int derivedSchemaId)

Unsupported operation in the parent controller.

Specified by:

removeDerivedSchema in interface Admin

Returns:

the derived schema that is deleted or null if the schema doesn't exist

getReplicationMetadataSchemas

public Collection<RmdSchemaEntry> getReplicationMetadataSchemas(String clusterName,
 String storeName)

Specified by:

getReplicationMetadataSchemas in interface Admin

See Also:

• VeniceHelixAdmin.getReplicationMetadataSchemas(String, String)

getReplicationMetadataSchema

public Optional<org.apache.avro.Schema> getReplicationMetadataSchema(String clusterName,
 String storeName,
 int valueSchemaID,
 int rmdVersionID)

Specified by:

getReplicationMetadataSchema in interface Admin

See Also:

• VeniceHelixAdmin.getReplicationMetadataSchema(String, String, int, int)

addReplicationMetadataSchema

public RmdSchemaEntry addReplicationMetadataSchema(String clusterName,
 String storeName,
 int valueSchemaId,
 int replicationMetadataVersionId,
 String replicationMetadataSchemaStr)

Create a new ReplicationMetadataSchemaEntry object with the given properties and add it into schema repository by sending REPLICATION_METADATA_SCHEMA_CREATION admin message.

Specified by:

addReplicationMetadataSchema in interface Admin

validateAndMaybeRetrySystemStoreAutoCreation

public void validateAndMaybeRetrySystemStoreAutoCreation(String clusterName,
 String storeName,
 VeniceSystemStoreType veniceSystemStoreType)

Unsupported operation in the parent controller.

Specified by:

validateAndMaybeRetrySystemStoreAutoCreation in interface Admin

getStorageNodes

public List<String> getStorageNodes(String clusterName)

Unsupported operation in the parent controller.

Specified by:

getStorageNodes in interface Admin

getStorageNodesStatus

public Map<String,String> getStorageNodesStatus(String clusterName,
 boolean enableReplica)

Unsupported operation in the parent controller.

Specified by:

getStorageNodesStatus in interface Admin

removeStorageNode

public void removeStorageNode(String clusterName,
 String instanceId)

Unsupported operation in the parent controller.

Specified by:

removeStorageNode in interface Admin

getOffLinePushStatus

public Admin.OfflinePushStatusInfo getOffLinePushStatus(String clusterName,
 String kafkaTopic)

Queries child clusters for status. Of all responses, return highest of (in order) NOT_CREATED, NEW, STARTED, PROGRESS. If all responses are COMPLETED, returns COMPLETED. If any response is ERROR and all responses are terminal (COMPLETED or ERROR), returns ERROR If any response is ERROR and any response is not terminal, returns PROGRESS ARCHIVED is treated as NOT_CREATED If error in querying half or more of clusters, returns PROGRESS. (so that polling will continue)

Specified by:

getOffLinePushStatus in interface Admin

Parameters:

clusterName -

kafkaTopic -

Returns:

getOffLinePushStatus

public Admin.OfflinePushStatusInfo getOffLinePushStatus(String clusterName,
 String kafkaTopic,
 Optional<String> incrementalPushVersion,
 String region,
 String targetedRegions,
 boolean isTargetRegionPushWithDeferredSwap)

Specified by:

getOffLinePushStatus in interface Admin

See Also:

• Admin.getOffLinePushStatus(String, String)

getFinalReturnStatus

protected static ExecutionStatus getFinalReturnStatus(Map<String,ExecutionStatus> statuses,
 Set<String> childRegions,
 int numChildRegionsFailedToFetchStatus,
 StringBuilder currentReturnStatusDetails)

Based on the global information, start determining the final status to return

Parameters:

statuses -

childRegions -

numChildRegionsFailedToFetchStatus -

currentReturnStatusDetails -

Returns:

getKafkaBootstrapServers

public String getKafkaBootstrapServers(boolean isSSL)

Description copied from interface: Admin

Return the ssl or non-ssl bootstrap servers based on the given flag.

Specified by:

getKafkaBootstrapServers in interface Admin

Returns:

kafka bootstrap servers url, if there are multiple will be comma separated.

See Also:

• VeniceHelixAdmin.getKafkaBootstrapServers(boolean)

getRegionName

public String getRegionName()

Description copied from interface: Admin

Return the region name of this Admin

Specified by:

getRegionName in interface Admin

Returns:

the region name of this controller

getNativeReplicationKafkaBootstrapServerAddress

public String getNativeReplicationKafkaBootstrapServerAddress(String sourceFabric)

Specified by:

getNativeReplicationKafkaBootstrapServerAddress in interface Admin

See Also:

• VeniceHelixAdmin.getNativeReplicationKafkaBootstrapServerAddress(String)

getNativeReplicationSourceFabric

public String getNativeReplicationSourceFabric(String clusterName,
 Store store,
 Optional<String> sourceGridFabric,
 Optional<String> emergencySourceRegion,
 String targetedRegions)

Specified by:

getNativeReplicationSourceFabric in interface Admin

See Also:

• VeniceHelixAdmin.getNativeReplicationSourceFabric(String, Store, Optional, Optional, String)

isSSLEnabledForPush

public boolean isSSLEnabledForPush(String clusterName,
 String storeName)

Description copied from interface: Admin

Return whether ssl is enabled for the given store for push.

Specified by:

isSSLEnabledForPush in interface Admin

See Also:

• VeniceHelixAdmin.isSSLEnabledForPush(String, String)

isSslToKafka

public boolean isSslToKafka()

Specified by:

isSslToKafka in interface Admin

See Also:

• VeniceHelixAdmin.isSslToKafka()

getTopicManager

public TopicManager getTopicManager()

Specified by:

getTopicManager in interface Admin

See Also:

• VeniceHelixAdmin.getTopicManager()

getTopicManager

public TopicManager getTopicManager(String pubSubServerAddress)

Specified by:

getTopicManager in interface Admin

See Also:

• VeniceHelixAdmin.getTopicManager(String)

getAggregatedHealthStatus

public InstanceRemovableStatuses getAggregatedHealthStatus(String cluster,
 List<String> instances,
 List<String> toBeStoppedInstances,
 boolean isSSLEnabled)

Specified by:

getAggregatedHealthStatus in interface Admin

isRTTopicDeletionPermittedByAllControllers

public boolean isRTTopicDeletionPermittedByAllControllers(String clusterName,
 String storeName)

Specified by:

isRTTopicDeletionPermittedByAllControllers in interface Admin

isLeaderControllerFor

public boolean isLeaderControllerFor(String clusterName)

Description copied from interface: Admin

Check if this controller itself is the leader controller for a given cluster or not. Note that the controller can be either a parent controller or a child controller since a cluster must have a leader child controller and a leader parent controller. The point is not to be confused the concept of leader-standby with parent-child controller architecture.

Specified by:

isLeaderControllerFor in interface Admin

See Also:

• VeniceHelixAdmin.isLeaderControllerFor(String)

calculateNumberOfPartitions

public int calculateNumberOfPartitions(String clusterName,
 String storeName)

Description copied from interface: Admin

Calculate how many partitions are needed for the given store.

Specified by:

calculateNumberOfPartitions in interface Admin

See Also:

• Admin.calculateNumberOfPartitions(String, String)

getReplicationFactor

public int getReplicationFactor(String clusterName,
 String storeName)

Specified by:

getReplicationFactor in interface Admin

See Also:

• VeniceHelixAdmin.getReplicationFactor(String, String)

getDatacenterCount

public int getDatacenterCount(String clusterName)

Description copied from interface: Admin

number of datacenters, 1 if in single cluster mode. Could be more if this is a parent controller

Specified by:

getDatacenterCount in interface Admin

See Also:

• Admin.getDatacenterCount(String)

getReplicas

public List<Replica> getReplicas(String clusterName,
 String kafkaTopic)

Specified by:

getReplicas in interface Admin

See Also:

• VeniceHelixAdmin.getReplicas(String, String)

getReplicasOfStorageNode

public List<Replica> getReplicasOfStorageNode(String clusterName,
 String instanceId)

Unsupported operation in the parent controller.

Specified by:

getReplicasOfStorageNode in interface Admin

isInstanceRemovable

public NodeRemovableResult isInstanceRemovable(String clusterName,
 String instanceId,
 List<String> lockedNodes)

Unsupported operation in the parent controller.

Specified by:

isInstanceRemovable in interface Admin

Parameters:

clusterName - The cluster were the hosts belong.

instanceId - nodeId of helix participant. HOST_PORT.

lockedNodes - A list of helix nodeIds whose resources are assumed to be unusable (stopped).

nodeReplicaReadiness

public Pair<NodeReplicasReadinessState,List<Replica>> nodeReplicaReadiness(String cluster,
 String helixNodeId)

Unsupported operation in the parent controller.

Specified by:

nodeReplicaReadiness in interface Admin

initiateDataRecovery

public void initiateDataRecovery(String clusterName,
 String storeName,
 int version,
 String sourceFabric,
 String destinationFabric,
 boolean copyAllVersionConfigs,
 Optional<Version> ignored)

Description copied from interface: Admin

Initiate data recovery for a store version given a source fabric.

Specified by:

initiateDataRecovery in interface Admin

Parameters:

clusterName - of the store.

storeName - of the store.

version - of the store.

sourceFabric - to be used as the source for data recovery.

copyAllVersionConfigs - a boolean to indicate whether all version configs should be copied from the source fabric or only the essential version configs and generate the rest based on destination fabric's Store configs.

ignored - source fabric's Version configs used to configure the recovering version in the destination fabric.

See Also:

• Admin.initiateDataRecovery(String, String, int, String, String, boolean, Optional)

prepareDataRecovery

public void prepareDataRecovery(String clusterName,
 String storeName,
 int version,
 String sourceFabric,
 String destinationFabric,
 Optional<Integer> ignored)

Description copied from interface: Admin

Prepare for data recovery in the destination fabric. The interested store version might have lingering states and resources in the destination fabric from previous failed attempts. Perform some basic checks to make sure the store version in the destination fabric is capable of performing data recovery and cleanup any lingering states and resources.

Specified by:

prepareDataRecovery in interface Admin

See Also:

• Admin.prepareDataRecovery(String, String, int, String, String, Optional)

isStoreVersionReadyForDataRecovery

public Pair<Boolean,String> isStoreVersionReadyForDataRecovery(String clusterName,
 String storeName,
 int version,
 String sourceFabric,
 String destinationFabric,
 Optional<Integer> ignored)

Description copied from interface: Admin

Check if the store version's previous states and resources are cleaned up and ready to start data recovery.

Specified by:

isStoreVersionReadyForDataRecovery in interface Admin

Returns:

whether is ready to start data recovery and the reason if it's not ready.

See Also:

• Admin.isStoreVersionReadyForDataRecovery(String, String, int, String, String, Optional)

getLeaderController

public Instance getLeaderController(String clusterName)

Description copied from interface: Admin

Get instance of leader controller. If there is no leader controller for the given cluster, throw a VeniceException.

Specified by:

getLeaderController in interface Admin

See Also:

• Admin.getLeaderController(String)

addInstanceToAllowlist

public void addInstanceToAllowlist(String clusterName,
 String helixNodeId)

Unsupported operation in the parent controller.

Specified by:

addInstanceToAllowlist in interface Admin

removeInstanceFromAllowList

public void removeInstanceFromAllowList(String clusterName,
 String helixNodeId)

Unsupported operation in the parent controller.

Specified by:

removeInstanceFromAllowList in interface Admin

getAllowlist

public Set<String> getAllowlist(String clusterName)

Unsupported operation in the parent controller.

Specified by:

getAllowlist in interface Admin

killOfflinePush

public void killOfflinePush(String clusterName,
 String kafkaTopic,
 boolean isForcedKill)

Description copied from interface: Admin

Kill an offline push if it ran into errors or the corresponding version is being retired.

Specified by:

killOfflinePush in interface Admin

isForcedKill - should be set to true when killing the push job for retiring the corresponding version.

See Also:

• Admin.killOfflinePush(String, String, boolean)

getStorageNodesStatus

public StorageNodeStatus getStorageNodesStatus(String clusterName,
 String instanceId)

Unsupported operation in the parent controller.

Specified by:

getStorageNodesStatus in interface Admin

isStorageNodeNewerOrEqualTo

public boolean isStorageNodeNewerOrEqualTo(String clusterName,
 String instanceId,
 StorageNodeStatus oldServerStatus)

Unsupported operation in the parent controller.

Specified by:

isStorageNodeNewerOrEqualTo in interface Admin

setAdminConsumerService

public void setAdminConsumerService(String clusterName,
 AdminConsumerService service)

Specified by:

setAdminConsumerService in interface Admin

See Also:

• Admin.setAdminConsumerService(String, AdminConsumerService)

getAdminConsumerService

public AdminConsumerService getAdminConsumerService(String clusterName)

Specified by:

getAdminConsumerService in interface Admin

skipAdminMessage

public void skipAdminMessage(String clusterName,
 long offset,
 boolean skipDIV,
 long executionId)

Description copied from interface: Admin

The admin consumption task tries to deal with failures to process an admin message by retrying. If there is a message that cannot be processed for some reason, we will need to forcibly skip that message in order to unblock the task from consuming subsequent messages.

Specified by:

skipAdminMessage in interface Admin

skipDIV - tries to skip only the DIV check for the blocking message.

See Also:

• Admin.skipAdminMessage(String, long, boolean, long)

getLastSucceedExecutionId

public Long getLastSucceedExecutionId(String clustername)

Description copied from interface: Admin

Get the id of the last succeed execution in this controller.

Specified by:

getLastSucceedExecutionId in interface Admin

See Also:

• Admin.getLastSucceedExecutionId(String)

getAdminCommandExecutionTracker

public Optional<AdminCommandExecutionTracker> getAdminCommandExecutionTracker(String clusterName)

Description copied from interface: Admin

Get the tracker used to track the execution of the admin command for the given cluster.

Specified by:

getAdminCommandExecutionTracker in interface Admin

See Also:

• Admin.getAdminCommandExecutionTracker(String)

getAdminTopicMetadata

public Map<String,Long> getAdminTopicMetadata(String clusterName,
 Optional<String> storeName)

Get AdminTopicMetadata from parent controller

Specified by:

getAdminTopicMetadata in interface Admin

updateAdminTopicMetadata

public void updateAdminTopicMetadata(String clusterName,
 long executionId,
 Optional<String> storeName,
 Optional<Long> offset,
 Optional<Long> upstreamOffset)

Unsupported operation in the parent controller.

Specified by:

updateAdminTopicMetadata in interface Admin

updateAdminOperationProtocolVersion

public void updateAdminOperationProtocolVersion(String clusterName,
 Long adminOperationProtocolVersion)

Update AdminOperationProtocolVersion in metadata

Specified by:

updateAdminOperationProtocolVersion in interface Admin

getAdminOperationVersionFromControllers

public Map<String,Long> getAdminOperationVersionFromControllers(String clusterName)

Specified by:

getAdminOperationVersionFromControllers in interface Admin

getLocalAdminOperationProtocolVersion

public long getLocalAdminOperationProtocolVersion()

Specified by:

getLocalAdminOperationProtocolVersion in interface Admin

getControllerName

public String getControllerName()

Specified by:

getControllerName in interface Admin

getRoutersClusterConfig

public RoutersClusterConfig getRoutersClusterConfig(String clusterName)

Unsupported operation in the parent controller.

Specified by:

getRoutersClusterConfig in interface Admin

updateRoutersClusterConfig

public void updateRoutersClusterConfig(String clusterName,
 Optional<Boolean> isThrottlingEnable,
 Optional<Boolean> isQuotaRebalancedEnable,
 Optional<Boolean> isMaxCapacityProtectionEnabled,
 Optional<Integer> expectedRouterCount)

Unsupported operation in the parent controller.

Specified by:

updateRoutersClusterConfig in interface Admin

getAllStorePushStrategyForMigration

public Map<String,String> getAllStorePushStrategyForMigration()

Specified by:

getAllStorePushStrategyForMigration in interface Admin

Returns:

all push-strategies defined in the ZK path MigrationPushStrategyZKAccessor.MIGRATION_PUSH_STRATEGY_PATH

setStorePushStrategyForMigration

public void setStorePushStrategyForMigration(String voldemortStoreName,
 String strategy)

Set a push-strategy in the ZK path MigrationPushStrategyZKAccessor.MIGRATION_PUSH_STRATEGY_PATH.

Specified by:

setStorePushStrategyForMigration in interface Admin

discoverCluster

public String discoverCluster(String storeName)

Description copied from interface: Admin

Find the cluster which the given store belongs to. Return the pair of the cluster name and the d2 service associated with that cluster.

Specified by:

discoverCluster in interface Admin

See Also:

• Admin.discoverCluster(String)

getRouterD2Service

public String getRouterD2Service(String clusterName)

Description copied from interface: Admin

Find the router d2 service associated with a given cluster name.

Specified by:

getRouterD2Service in interface Admin

See Also:

• Admin.getRouterD2Service(String)

getServerD2Service

public String getServerD2Service(String clusterName)

Description copied from interface: Admin

Find the server d2 service associated with a given cluster name.

Specified by:

getServerD2Service in interface Admin

See Also:

• Admin.getServerD2Service(String)

findAllBootstrappingVersions

public Map<String,String> findAllBootstrappingVersions(String clusterName)

Unsupported operation in the parent controller.

Specified by:

findAllBootstrappingVersions in interface Admin

getVeniceWriterFactory

public VeniceWriterFactory getVeniceWriterFactory()

Specified by:

getVeniceWriterFactory in interface Admin

Returns:

a VeniceWriterFactory object used by the Venice controller to create the venice writer.

getPubSubSSLProperties

public VeniceProperties getPubSubSSLProperties(String pubSubBrokerAddress)

Specified by:

getPubSubSSLProperties in interface Admin

stop

public void stop(String clusterName)

Description copied from interface: Admin

Stop the helix controller for a single cluster.

Specified by:

stop in interface Admin

See Also:

• Admin.stop(String)

stopVeniceController

public void stopVeniceController()

Description copied from interface: Admin

Stop the entire controller but not only the helix controller for a single cluster.

Specified by:

stopVeniceController in interface Admin

See Also:

• Admin.stopVeniceController()

close

public void close()

Cause VeniceParentHelixAdmin and its associated services to stop executing.

Specified by:

close in interface Admin

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isLeaderControllerOfControllerCluster

public boolean isLeaderControllerOfControllerCluster()

Description copied from interface: Admin

This function can be used to perform cluster-wide operations which need to be performed by a single process only in the whole cluster. There could be a race condition during leader controller failover, and so long operation should have some way of guarding against that.

Specified by:

isLeaderControllerOfControllerCluster in interface Admin

See Also:

• VeniceHelixAdmin.isLeaderControllerOfControllerCluster()

isTopicTruncated

public boolean isTopicTruncated(String kafkaTopicName)

Specified by:

isTopicTruncated in interface Admin

See Also:

• VeniceHelixAdmin.isTopicTruncated(String)

isTopicTruncatedBasedOnRetention

public boolean isTopicTruncatedBasedOnRetention(long retention)

Specified by:

isTopicTruncatedBasedOnRetention in interface Admin

See Also:

• VeniceHelixAdmin.isTopicTruncatedBasedOnRetention(long)

isTopicTruncatedBasedOnRetention

public boolean isTopicTruncatedBasedOnRetention(String kafkaTopicName,
 long retentionTime)

Specified by:

isTopicTruncatedBasedOnRetention in interface Admin

getMinNumberOfUnusedKafkaTopicsToPreserve

public int getMinNumberOfUnusedKafkaTopicsToPreserve()

Specified by:

getMinNumberOfUnusedKafkaTopicsToPreserve in interface Admin

See Also:

• VeniceHelixAdmin.getMinNumberOfUnusedKafkaTopicsToPreserve()

truncateKafkaTopic

public boolean truncateKafkaTopic(String kafkaTopicName)

Specified by:

truncateKafkaTopic in interface Admin

Returns:

false indicates that the truncate operation has already been done before; true if it's the first time truncating this topic.

See Also:

• VeniceHelixAdmin.truncateKafkaTopic(String)

truncateKafkaTopic

public boolean truncateKafkaTopic(String kafkaTopicName,
 long retentionTime)

Description copied from interface: Admin

Truncate a Kafka topic by setting its retention time to the input value.

Specified by:

truncateKafkaTopic in interface Admin

Parameters:

kafkaTopicName - the name of the topic to truncate.

retentionTime - the retention time in milliseconds to set for the topic.

Returns:

true if truncating this topic successfully. false otherwise.

See Also:

• Admin.truncateKafkaTopic(String, long)

isResourceStillAlive

public boolean isResourceStillAlive(String resourceName)

Unsupported operation in the parent controller.

Specified by:

isResourceStillAlive in interface Admin

updateClusterDiscovery

public void updateClusterDiscovery(String storeName,
 String oldCluster,
 String newCluster,
 String initiatingCluster)

Description copied from interface: Admin

Update the cluster discovery of a given store by writing to the StoreConfig ZNode.

Specified by:

updateClusterDiscovery in interface Admin

Parameters:

storeName - of the store.

oldCluster - for the store.

newCluster - for the store.

initiatingCluster - that is making the update. This is needed because in the case of store migration sometimes the update is not made by the leader of the current cluster but instead the leader of the source cluster.

See Also:

• Admin.updateClusterDiscovery(String, String, String, String)

sendPushJobDetails

public void sendPushJobDetails(PushJobStatusRecordKey key,
 PushJobDetails value)

Specified by:

sendPushJobDetails in interface Admin

See Also:

• VeniceHelixAdmin.sendPushJobDetails(PushJobStatusRecordKey, PushJobDetails)

getPushJobDetails

public PushJobDetails getPushJobDetails(PushJobStatusRecordKey key)

Specified by:

getPushJobDetails in interface Admin

See Also:

• VeniceHelixAdmin.getPushJobDetails(PushJobStatusRecordKey)

getBatchJobHeartbeatValue

public BatchJobHeartbeatValue getBatchJobHeartbeatValue(BatchJobHeartbeatKey batchJobHeartbeatKey)

Specified by:

getBatchJobHeartbeatValue in interface Admin

See Also:

• VeniceHelixAdmin.getBatchJobHeartbeatValue(BatchJobHeartbeatKey)

writeEndOfPush

public void writeEndOfPush(String clusterName,
 String storeName,
 int versionNumber,
 boolean alsoWriteStartOfPush)

Specified by:

writeEndOfPush in interface Admin

See Also:

• VeniceHelixAdmin.writeEndOfPush(String, String, int, boolean)

whetherEnableBatchPushFromAdmin

public boolean whetherEnableBatchPushFromAdmin(String clusterName,
 String storeName)

Specified by:

whetherEnableBatchPushFromAdmin in interface Admin

isStoreMigrationAllowed

public boolean isStoreMigrationAllowed(String clusterName)

Specified by:

isStoreMigrationAllowed in interface Admin

See Also:

• VeniceHelixAdmin.isStoreMigrationAllowed(String)

migrateStore

public void migrateStore(String srcClusterName,
 String destClusterName,
 String storeName)

Migrate a store from its source cluster to a new destination cluster by sending a MIGRATE_STORE admin message.

Specified by:

migrateStore in interface Admin

completeMigration

public void completeMigration(String srcClusterName,
 String destClusterName,
 String storeName)

Specified by:

completeMigration in interface Admin

See Also:

• VeniceHelixAdmin.updateClusterDiscovery(String, String, String, String)

abortMigration

public void abortMigration(String srcClusterName,
 String destClusterName,
 String storeName)

Abort store migration by sending a ABORT_MIGRATION admin message.

Specified by:

abortMigration in interface Admin

getMetaStoreValue

public StoreMetaValue getMetaStoreValue(StoreMetaKey metaKey,
 String storeName)

Specified by:

getMetaStoreValue in interface Admin

updateAclForStore

public void updateAclForStore(String clusterName,
 String storeName,
 String accessPermissions)

Description copied from interface: Admin

Provision a new set of ACL for a venice store and its associated kafka topic.

Specified by:

updateAclForStore in interface Admin

See Also:

• Admin.updateAclForStore(String, String, String)

updateSystemStoreAclForStore

public void updateSystemStoreAclForStore(String clusterName,
 String regularStoreName,
 AclBinding systemStoreAclBinding)

Set the AceEntries in provided AclBinding object to be the current set of ACL's for the resource.

getAclForStore

public String getAclForStore(String clusterName,
 String storeName)

Description copied from interface: Admin

Fetch the current set of ACL provisioned for a venice store and its associated kafka topic.

Specified by:

getAclForStore in interface Admin

Returns:

The string representation of the accessPermissions. It will return empty string in case store is not present.

See Also:

• Admin.getAclForStore(String, String)

deleteAclForStore

public void deleteAclForStore(String clusterName,
 String storeName)

Description copied from interface: Admin

Delete the current set of ACL provisioned for a venice store and its associated kafka topic.

Specified by:

deleteAclForStore in interface Admin

See Also:

• Admin.deleteAclForStore(String, String)

configureActiveActiveReplication

public void configureActiveActiveReplication(String clusterName,
 VeniceUserStoreType storeType,
 Optional<String> storeName,
 boolean enableNativeReplicationForCluster,
 Optional<String> regionsFilter)

Description copied from interface: Admin

Enable/disable active active replications for certain stores (batch only, hybrid only, incremental push, hybrid or incremental push, all) in a cluster. If storeName is not empty, only the specified store might be updated.

Specified by:

configureActiveActiveReplication in interface Admin

See Also:

• Admin.configureActiveActiveReplication(String, VeniceUserStoreType, Optional, boolean, Optional)

getClusterStaleStores

public Map<String,StoreDataAudit> getClusterStaleStores(String clusterName)

This function will iterate over all of Helix Parent Admin's child controllers, in order to ask about stale stores.

Specified by:

getClusterStaleStores in interface Admin

getStoresForCompaction

public List<StoreInfo> getStoresForCompaction(String clusterName)

see Admin.getStoresForCompaction(java.lang.String)

Specified by:

getStoresForCompaction in interface Admin

Parameters:

clusterName - , the name of the cluster to search for stores that are ready for compaction

Returns:

the list of stores ready for compaction

repushStore

public RepushJobResponse repushStore(RepushJobRequest repushJobRequest)
                              throws Exception

This is the entry/exit common point for manual and scheduled repush codepaths. This being the common point allows streamlined logging for the repushStore endpoint. This function triggers repush store downstream. see Admin.repushStore(com.linkedin.venice.controller.repush.RepushJobRequest)

Specified by:

repushStore in interface Admin

Parameters:

repushJobRequest - contains params for repush job

Returns:

data model of repush job run info

Throws:

Exception

getCompactionManager

public CompactionManager getCompactionManager()

Specified by:

getCompactionManager in interface Admin

getDeadStores

public List<StoreInfo> getDeadStores(String clusterName,
 String storeName,
 Map<String,String> params)

Cause Admin.getDeadStores(String, String, Map)

Specified by:

getDeadStores in interface Admin

params - Parameters for dead store detection including: - "includeSystemStores": boolean (default: false) - "lookBackMS": long (optional) - Future extension points

Returns:

list of stores infos that are considered dead. A store is considered dead if it exists but has no user traffic in it's read or write path.

getLargestUsedVersionFromStoreGraveyard

public int getLargestUsedVersionFromStoreGraveyard(String clusterName,
 String storeName)

Description copied from interface: Admin

Deprecated but remain here to keep compatibility until Admin.getLargestUsedVersion(String, String) is used.

Specified by:

getLargestUsedVersionFromStoreGraveyard in interface Admin

getLargestUsedVersion

public int getLargestUsedVersion(String clusterName,
 String storeName)

Specified by:

getLargestUsedVersion in interface Admin

getClusterStores

public ArrayList<StoreInfo> getClusterStores(String clusterName)

Unsupported operation in the parent controller.

Specified by:

getClusterStores in interface Admin

getRegionPushDetails

public RegionPushDetails getRegionPushDetails(String clusterName,
 String storeName,
 boolean isPartitionDetailAdded)

Unsupported operation in the parent controller.

Specified by:

getRegionPushDetails in interface Admin

listStorePushInfo

public Map<String,RegionPushDetails> listStorePushInfo(String clusterName,
 String storeName,
 boolean isPartitionDetailEnabled)

This function will look for a single store, given a name and cluster name, and return information about the current push jobs for that store across all regions.

Specified by:

listStorePushInfo in interface Admin

checkResourceCleanupBeforeStoreCreation

public void checkResourceCleanupBeforeStoreCreation(String clusterName,
 String storeName)

This function will check whether there are still resources left for the requested store in the requested cluster. This function will check both parent colo and all prod colos.

Specified by:

checkResourceCleanupBeforeStoreCreation in interface Admin

isParent

public boolean isParent()

Description copied from interface: Admin

Check whether the controller works as a parent controller

Specified by:

isParent in interface Admin

Returns:

true if it works as a parent controller. Otherwise, return false.

See Also:

• Admin.isParent()

getParentControllerRegionState

public ParentControllerRegionState getParentControllerRegionState()

Description copied from interface: Admin

Return the state of the region of the parent controller.

Specified by:

getParentControllerRegionState in interface Admin

Returns:

ParentControllerRegionState.ACTIVE which means that the parent controller in the region is serving requests. Otherwise, return ParentControllerRegionState.PASSIVE

See Also:

• Admin.getParentControllerRegionState()

getChildDataCenterControllerUrlMap

public Map<String,String> getChildDataCenterControllerUrlMap(String clusterName)

Description copied from interface: Admin

Get child datacenter to child controller url mapping.

Specified by:

getChildDataCenterControllerUrlMap in interface Admin

Returns:

A map of child datacenter -> child controller url

See Also:

• Admin.getChildDataCenterControllerUrlMap(String)

getChildDataCenterControllerD2Map

public Map<String,String> getChildDataCenterControllerD2Map(String clusterName)

Description copied from interface: Admin

Get child datacenter to child controller d2 zk host mapping

Specified by:

getChildDataCenterControllerD2Map in interface Admin

Returns:

A map of child datacenter -> child controller d2 zk host

See Also:

• Admin.getChildDataCenterControllerD2Map(String)

getChildControllerD2ServiceName

public String getChildControllerD2ServiceName(String clusterName)

Description copied from interface: Admin

Get child datacenter controller d2 service name

Specified by:

getChildControllerD2ServiceName in interface Admin

Returns:

d2 service name

See Also:

• Admin.getChildControllerD2ServiceName(String)

getStoreConfigRepo

public HelixReadOnlyStoreConfigRepository getStoreConfigRepo()

Description copied from interface: Admin

Return a shared store config repository.

Specified by:

getStoreConfigRepo in interface Admin

See Also:

• Admin.getStoreConfigRepo()

getReadOnlyZKSharedSystemStoreRepository

public HelixReadOnlyZKSharedSystemStoreRepository getReadOnlyZKSharedSystemStoreRepository()

Description copied from interface: Admin

Return a shared read only store repository for zk shared stores.

Specified by:

getReadOnlyZKSharedSystemStoreRepository in interface Admin

See Also:

• Admin.getReadOnlyZKSharedSystemStoreRepository()

getReadOnlyZKSharedSchemaRepository

public HelixReadOnlyZKSharedSchemaRepository getReadOnlyZKSharedSchemaRepository()

Description copied from interface: Admin

Return a shared read only schema repository for zk shared stores.

Specified by:

getReadOnlyZKSharedSchemaRepository in interface Admin

See Also:

• Admin.getReadOnlyZKSharedSystemStoreRepository()

getMetaStoreWriter

public MetaStoreWriter getMetaStoreWriter()

Description copied from interface: Admin

Return a MetaStoreWriter, which can be shared across different Venice clusters.

Specified by:

getMetaStoreWriter in interface Admin

See Also:

• Admin.getMetaStoreWriter()

getMetaStoreReader

public MetaStoreReader getMetaStoreReader()

Specified by:

getMetaStoreReader in interface Admin

getEmergencySourceRegion

public Optional<String> getEmergencySourceRegion(@Nonnull
 String clusterName)

Description copied from interface: Admin

Return the emergency source region configuration.

Specified by:

getEmergencySourceRegion in interface Admin

See Also:

• Admin.getEmergencySourceRegion(String)

getAggregateRealTimeTopicSource

public Optional<String> getAggregateRealTimeTopicSource(String clusterName)

Description copied from interface: Admin

Return the source Kafka boostrap server url for aggregate real-time topic updates

Specified by:

getAggregateRealTimeTopicSource in interface Admin

See Also:

• Admin.getAggregateRealTimeTopicSource(String)

getClustersLeaderOf

public List<String> getClustersLeaderOf()

Description copied from interface: Admin

Get a list of clusters this controller is a leader of.

Specified by:

getClustersLeaderOf in interface Admin

Returns:

a list of clusters this controller is a leader of.

See Also:

• Admin.getClustersLeaderOf()

getVeniceHelixAdmin

public VeniceHelixAdmin getVeniceHelixAdmin()

getBackupVersionDefaultRetentionMs

public long getBackupVersionDefaultRetentionMs()

Description copied from interface: Admin

Returns default backup version retention time.

Specified by:

getBackupVersionDefaultRetentionMs in interface Admin

See Also:

• Admin.getBackupVersionDefaultRetentionMs()

getDefaultMaxRecordSizeBytes

public int getDefaultMaxRecordSizeBytes()

Specified by:

getDefaultMaxRecordSizeBytes in interface Admin

Returns:

The default value of VeniceWriter.maxRecordSizeBytes which is provided to the VPJ and Consumer as a controller config to dynamically control the setting per cluster.

See Also:

• Admin.getDefaultMaxRecordSizeBytes()

wipeCluster

public void wipeCluster(String clusterName,
 String fabric,
 Optional<String> storeName,
 Optional<Integer> versionNum)

Delete stores from the cluster by sending a ControllerClient.wipeCluster(String, Optional, Optional) request.

Specified by:

wipeCluster in interface Admin

compareStore

public StoreComparisonInfo compareStore(String clusterName,
 String storeName,
 String fabricA,
 String fabricB)
                                 throws IOException

Description copied from interface: Admin

Compare store metadata and version states between two fabrics.

Specified by:

compareStore in interface Admin

Throws:

IOException

See Also:

• Admin.compareStore(String, String, String, String)

copyOverStoreSchemasAndConfigs

public StoreInfo copyOverStoreSchemasAndConfigs(String clusterName,
 String srcFabric,
 String destFabric,
 String storeName)

Specified by:

copyOverStoreSchemasAndConfigs in interface Admin

See Also:

• Admin.copyOverStoreSchemasAndConfigs(String, String, String, String)

createStoragePersona

public void createStoragePersona(String clusterName,
 String name,
 long quotaNumber,
 Set<String> storesToEnforce,
 Set<String> owners)

Creates a new persona with the given parameters.

Specified by:

createStoragePersona in interface Admin

See Also:

• StoragePersonaRepository.addPersona(String, long, Set, Set)

getStoragePersona

public StoragePersona getStoragePersona(String clusterName,
 String name)

Specified by:

getStoragePersona in interface Admin

See Also:

• VeniceHelixAdmin.getStoragePersona(String, String)

deleteStoragePersona

public void deleteStoragePersona(String clusterName,
 String name)

Deletes the persona with the given name. If no persona is found, this method does nothing.

Specified by:

deleteStoragePersona in interface Admin

updateStoragePersona

public void updateStoragePersona(String clusterName,
 String name,
 UpdateStoragePersonaQueryParams queryParams)

Updates a persona with the given parameters by sending a UPDATE_STORAGE_PERSONA admin message.

Specified by:

updateStoragePersona in interface Admin

getPersonaAssociatedWithStore

public StoragePersona getPersonaAssociatedWithStore(String clusterName,
 String storeName)

Specified by:

getPersonaAssociatedWithStore in interface Admin

See Also:

• VeniceHelixAdmin.getPersonaAssociatedWithStore(String, String)

getClusterStoragePersonas

public List<StoragePersona> getClusterStoragePersonas(String clusterName)

Specified by:

getClusterStoragePersonas in interface Admin

See Also:

• VeniceHelixAdmin.getClusterStoragePersonas(String)

cleanupInstanceCustomizedStates

public List<String> cleanupInstanceCustomizedStates(String clusterName)

Description copied from interface: Admin

Scan through instance level customized states and remove any lingering ZNodes that are no longer relevant. This operation shouldn't be needed under normal circumstances. It's intended to cleanup ZNodes that failed to be deleted due to bugs and errors.

Specified by:

cleanupInstanceCustomizedStates in interface Admin

Parameters:

clusterName - to perform the cleanup.

Returns:

list of deleted ZNode paths.

getStoreGraveyard

public StoreGraveyard getStoreGraveyard()

Specified by:

getStoreGraveyard in interface Admin

removeStoreFromGraveyard

public void removeStoreFromGraveyard(String clusterName,
 String storeName)

Specified by:

removeStoreFromGraveyard in interface Admin

getPushStatusStoreReader

public PushStatusStoreReader getPushStatusStoreReader()

Specified by:

getPushStatusStoreReader in interface Admin

getPushStatusStoreWriter

public PushStatusStoreWriter getPushStatusStoreWriter()

Specified by:

getPushStatusStoreWriter in interface Admin

sendHeartbeatToSystemStore

public void sendHeartbeatToSystemStore(String clusterName,
 String systemStoreName,
 long heartbeatTimestamp)

Description copied from interface: Admin

Send a heartbeat timestamp to targeted system store.

Specified by:

sendHeartbeatToSystemStore in interface Admin

getHeartbeatFromSystemStore

public long getHeartbeatFromSystemStore(String clusterName,
 String storeName)

Description copied from interface: Admin

Read the latest heartbeat timestamp from system store. If it failed to read from system store, this method should return -1.

Specified by:

getHeartbeatFromSystemStore in interface Admin

getHelixVeniceClusterResources

public HelixVeniceClusterResources getHelixVeniceClusterResources(String cluster)

Specified by:

getHelixVeniceClusterResources in interface Admin

Returns:

the aggregate resources required by controller to manage a Venice cluster.

getPubSubTopicRepository

public PubSubTopicRepository getPubSubTopicRepository()

Specified by:

getPubSubTopicRepository in interface Admin

getLogContext

public LogContext getLogContext()

Specified by:

getLogContext in interface Admin

getControllerConfig

public VeniceControllerClusterConfig getControllerConfig(String clusterName)

Specified by:

getControllerConfig in interface Admin

validateStoreDeleted

public StoreDeletedValidation validateStoreDeleted(String clusterName,
 String storeName)

Validates that a store has been completely deleted from all venice clusters cross-regionally

Specified by:

validateStoreDeleted in interface Admin

Parameters:

clusterName - the name of the cluster to check

storeName - the name of the store to validate deletion for

Returns:

StoreDeletedValidation indicating whether the store is fully deleted or what resources remain

See Also:

• Admin.validateStoreDeleted(String, String)