Package com.linkedin.venice.controller

Class ZkHelixAdminClient

java.lang.Object

com.linkedin.venice.controller.ZkHelixAdminClient

All Implemented Interfaces:

HelixAdminClient

public class ZkHelixAdminClient
extends Object
implements HelixAdminClient

The purpose of this class is to abstract Helix operations out of the VeniceHelixAdmin and eventually rename it to VeniceAdmin. This is one implementation of the HelixAdminClient interface which uses Zk based Helix API. In the future we might move to the Helix REST API.

Constructor Summary

Constructors

Constructor	Description
ZkHelixAdminClient(VeniceControllerMultiClusterConfig multiClusterConfigs, io.tehuti.metrics.MetricsRepository metricsRepository)

Method Summary

Modifier and Type	Method	Description
void	addClusterToGrandCluster(String clusterName)	Add the specified cluster as a resource to the grand cluster to be managed by HaaS controllers.
void	addVeniceStorageClusterToControllerCluster(String clusterName)	Add the given Venice storage cluster's cluster resource to the controller cluster.
void	close()	Release resources.
boolean	containsResource(String clusterName, String resourceName)	Check if a resource exists in a cluster by checking its ideal state.
void	createVeniceControllerCluster()	Create and configure the Venice controller cluster.
void	createVeniceStorageCluster(String clusterName, org.apache.helix.model.ClusterConfig helixClusterConfig, org.apache.helix.model.RESTConfig restConfig)	Create and configure the Venice storage cluster.
void	createVeniceStorageClusterResources(String clusterName, String kafkaTopic, int numberOfPartition, int replicationFactor)	Create resources for a given storage node cluster.
void	dropResource(String clusterName, String resourceName)	Drop a resource from a cluster.
void	dropStorageInstance(String clusterName, String instanceName)	Drop a storage node instance from the given cluster.
void	enablePartition(boolean enabled, String clusterName, String instanceName, String resourceName, List<String> partitionNames)	Disable or enable a list of partitions on an instance.
Map<String,List<String>>	getDisabledPartitionsMap(String clusterName, String instanceName)	Returns a list of disabled partitions in an instance.
List<String>	getInstancesInCluster(String clusterName)	Get a list of instances under a cluster.
boolean	isClusterInGrandCluster(String clusterName)	Check if the grand cluster managed by HaaS controllers is aware of the given cluster.
boolean	isVeniceControllerClusterCreated()	Check if the Venice controller cluster is created and configured.
boolean	isVeniceStorageClusterCreated(String clusterName)	Check if the given Venice storage cluster is created and configured.
boolean	isVeniceStorageClusterInControllerCluster(String clusterName)	Check if the given Venice storage cluster's cluster resource is in the Venice controller cluster.
void	manuallyEnableMaintenanceMode(String clusterName, boolean enabled, String reason, Map<String,String> customFields)	Manually enable maintenance mode.
void	resetPartition(String clusterName, String instanceName, String resourceName, List<String> partitionNames)	Reset a list of partitions in error state for an instance.
void	setInstanceOperation(String clusterName, String instanceName, org.apache.helix.constants.InstanceConstants.InstanceOperation instanceOperation, String reason)	Set the instanceOperation of and instance with InstanceConstants.InstanceOperation.
void	updateClusterConfigs(String clusterName, org.apache.helix.model.ClusterConfig clusterConfig)	Update some Helix cluster properties for the given cluster.
void	updateRESTConfigs(String clusterName, org.apache.helix.model.RESTConfig restConfig)	Update some Helix cluster properties for the given cluster.

Methods inherited from class java.lang.Object

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

Constructor Details

ZkHelixAdminClient

public ZkHelixAdminClient(VeniceControllerMultiClusterConfig multiClusterConfigs,
 io.tehuti.metrics.MetricsRepository metricsRepository)

Method Details

isVeniceControllerClusterCreated

public boolean isVeniceControllerClusterCreated()

Description copied from interface: HelixAdminClient

Check if the Venice controller cluster is created and configured.

Specified by:

isVeniceControllerClusterCreated in interface HelixAdminClient

Returns:

true or false.

See Also:

• HelixAdminClient.isVeniceControllerClusterCreated()

isVeniceStorageClusterCreated

public boolean isVeniceStorageClusterCreated(String clusterName)

Description copied from interface: HelixAdminClient

Check if the given Venice storage cluster is created and configured.

Specified by:

isVeniceStorageClusterCreated in interface HelixAdminClient

Parameters:

clusterName - of the Venice cluster.

Returns:

true or false.

See Also:

• HelixAdminClient.isVeniceStorageClusterCreated(String)

createVeniceControllerCluster

public void createVeniceControllerCluster()

Description copied from interface: HelixAdminClient

Create and configure the Venice controller cluster.

Specified by:

createVeniceControllerCluster in interface HelixAdminClient

See Also:

• HelixAdminClient.createVeniceControllerCluster()

createVeniceStorageCluster

public void createVeniceStorageCluster(String clusterName,
 org.apache.helix.model.ClusterConfig helixClusterConfig,
 org.apache.helix.model.RESTConfig restConfig)

Description copied from interface: HelixAdminClient

Create and configure the Venice storage cluster.

Specified by:

createVeniceStorageCluster in interface HelixAdminClient

Parameters:

clusterName - of the Venice storage cluster.

helixClusterConfig - ClusterConfig for the new cluster.

restConfig - RESTConfig for the new cluster.

See Also:

• HelixAdminClient.createVeniceStorageCluster(String, ClusterConfig, RESTConfig)

isVeniceStorageClusterInControllerCluster

public boolean isVeniceStorageClusterInControllerCluster(String clusterName)

Description copied from interface: HelixAdminClient

Check if the given Venice storage cluster's cluster resource is in the Venice controller cluster.

Specified by:

isVeniceStorageClusterInControllerCluster in interface HelixAdminClient

Parameters:

clusterName - of the Venice storage cluster.

Returns:

true or false.

See Also:

• HelixAdminClient.isVeniceStorageClusterInControllerCluster(String)

addVeniceStorageClusterToControllerCluster

public void addVeniceStorageClusterToControllerCluster(String clusterName)

Description copied from interface: HelixAdminClient

Add the given Venice storage cluster's cluster resource to the controller cluster.

Specified by:

addVeniceStorageClusterToControllerCluster in interface HelixAdminClient

Parameters:

clusterName - of the Venice storage cluster.

See Also:

• HelixAdminClient.addVeniceStorageClusterToControllerCluster(String)

isClusterInGrandCluster

public boolean isClusterInGrandCluster(String clusterName)

Description copied from interface: HelixAdminClient

Check if the grand cluster managed by HaaS controllers is aware of the given cluster.

Specified by:

isClusterInGrandCluster in interface HelixAdminClient

Parameters:

clusterName - of the cluster.

Returns:

true or false.

See Also:

• HelixAdminClient.isClusterInGrandCluster(String)

addClusterToGrandCluster

public void addClusterToGrandCluster(String clusterName)

Description copied from interface: HelixAdminClient

Add the specified cluster as a resource to the grand cluster to be managed by HaaS controllers.

Specified by:

addClusterToGrandCluster in interface HelixAdminClient

Parameters:

clusterName - of the cluster to be added as a resource to the grand cluster.

See Also:

• HelixAdminClient.addClusterToGrandCluster(String)

updateClusterConfigs

public void updateClusterConfigs(String clusterName,
 org.apache.helix.model.ClusterConfig clusterConfig)

Description copied from interface: HelixAdminClient

Update some Helix cluster properties for the given cluster.

Specified by:

updateClusterConfigs in interface HelixAdminClient

Parameters:

clusterName - of the cluster to be updated.

clusterConfig - ClusterConfig for the new cluster.

See Also:

• HelixAdminClient.updateClusterConfigs(String, ClusterConfig)

updateRESTConfigs

public void updateRESTConfigs(String clusterName,
 org.apache.helix.model.RESTConfig restConfig)

Description copied from interface: HelixAdminClient

Update some Helix cluster properties for the given cluster.

Specified by:

updateRESTConfigs in interface HelixAdminClient

Parameters:

clusterName - of the cluster to be updated.

restConfig - RESTConfig for the new cluster.

See Also:

• HelixAdminClient.updateRESTConfigs(String, RESTConfig)

enablePartition

public void enablePartition(boolean enabled,
 String clusterName,
 String instanceName,
 String resourceName,
 List<String> partitionNames)

Description copied from interface: HelixAdminClient

Disable or enable a list of partitions on an instance.

Specified by:

enablePartition in interface HelixAdminClient

See Also:

• HelixAdminClient.enablePartition(boolean, String, String, String, List)

getInstancesInCluster

public List<String> getInstancesInCluster(String clusterName)

Description copied from interface: HelixAdminClient

Get a list of instances under a cluster.

Specified by:

getInstancesInCluster in interface HelixAdminClient

Returns:

a list of instance names.

See Also:

• HelixAdminClient.getInstancesInCluster(String)

createVeniceStorageClusterResources

public void createVeniceStorageClusterResources(String clusterName,
 String kafkaTopic,
 int numberOfPartition,
 int replicationFactor)

Description copied from interface: HelixAdminClient

Create resources for a given storage node cluster.

Specified by:

createVeniceStorageClusterResources in interface HelixAdminClient

See Also:

• HelixAdminClient.createVeniceStorageClusterResources(String, String, int, int)

containsResource

public boolean containsResource(String clusterName,
 String resourceName)

Description copied from interface: HelixAdminClient

Check if a resource exists in a cluster by checking its ideal state.

Specified by:

containsResource in interface HelixAdminClient

dropResource

public void dropResource(String clusterName,
 String resourceName)

Description copied from interface: HelixAdminClient

Drop a resource from a cluster.

Specified by:

dropResource in interface HelixAdminClient

See Also:

• HelixAdminClient.dropResource(String, String)

dropStorageInstance

public void dropStorageInstance(String clusterName,
 String instanceName)

Description copied from interface: HelixAdminClient

Drop a storage node instance from the given cluster.

Specified by:

dropStorageInstance in interface HelixAdminClient

See Also:

• HelixAdminClient.dropStorageInstance(String, String)

getDisabledPartitionsMap

public Map<String,List<String>> getDisabledPartitionsMap(String clusterName,
 String instanceName)

Description copied from interface: HelixAdminClient

Returns a list of disabled partitions in an instance.

Specified by:

getDisabledPartitionsMap in interface HelixAdminClient

resetPartition

public void resetPartition(String clusterName,
 String instanceName,
 String resourceName,
 List<String> partitionNames)

Description copied from interface: HelixAdminClient

Reset a list of partitions in error state for an instance.

The partitions are assumed to be in error state and reset will bring them from error to initial state. An error to initial state transition is required for reset.

Specified by:

resetPartition in interface HelixAdminClient

See Also:

• HelixAdminClient.resetPartition(String, String, String, List)

close

public void close()

Description copied from interface: HelixAdminClient

Release resources.

Specified by:

close in interface HelixAdminClient

See Also:

• HelixAdminClient.close()

manuallyEnableMaintenanceMode

public void manuallyEnableMaintenanceMode(String clusterName,
 boolean enabled,
 String reason,
 Map<String,String> customFields)

Description copied from interface: HelixAdminClient

Manually enable maintenance mode. To be called by the REST client that accepts KV mappings as the payload.

Specified by:

manuallyEnableMaintenanceMode in interface HelixAdminClient

See Also:

• HelixAdminClient.manuallyEnableMaintenanceMode(String, boolean, String, Map<String, String>)

setInstanceOperation

public void setInstanceOperation(String clusterName,
 String instanceName,
 org.apache.helix.constants.InstanceConstants.InstanceOperation instanceOperation,
 String reason)

Description copied from interface: HelixAdminClient

Set the instanceOperation of and instance with InstanceConstants.InstanceOperation.

Specified by:

setInstanceOperation in interface HelixAdminClient

Parameters:

clusterName - The cluster name

instanceName - The instance name

instanceOperation - The instance operation type

reason - The reason for the operation

See Also:

• HelixAdminClient.setInstanceOperation(String, String, InstanceConstants.InstanceOperation, String)