qqu0127 commented on a change in pull request #1935: URL: https://github.com/apache/helix/pull/1935#discussion_r802076381
########## File path: helix-rest/src/main/java/org/apache/helix/rest/server/service/VirtualTopologyGroupService.java ########## @@ -0,0 +1,194 @@ +package org.apache.helix.rest.server.service; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import org.apache.commons.lang3.StringUtils; +import org.apache.helix.AccessOption; +import org.apache.helix.ConfigAccessor; +import org.apache.helix.HelixAdmin; +import org.apache.helix.HelixDataAccessor; +import org.apache.helix.HelixException; +import org.apache.helix.PropertyPathBuilder; +import org.apache.helix.cloud.constants.VirtualTopologyGroupConstants; +import org.apache.helix.cloud.topology.FifoVirtualGroupAssignmentAlgorithm; +import org.apache.helix.cloud.topology.VirtualGroupAssignmentAlgorithm; +import org.apache.helix.model.CloudConfig; +import org.apache.helix.model.ClusterConfig; +import org.apache.helix.model.ClusterTopologyConfig; +import org.apache.helix.model.InstanceConfig; +import org.apache.helix.rest.server.json.cluster.ClusterTopology; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.helix.zookeeper.zkclient.DataUpdater; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * Service for virtual topology group. + */ +public class VirtualTopologyGroupService { + private static final Logger LOG = LoggerFactory.getLogger(VirtualTopologyGroupService.class); + + private final HelixAdmin _helixAdmin; + private final ClusterService _clusterService; + private final ConfigAccessor _configAccessor; + private final HelixDataAccessor _dataAccessor; + private final VirtualGroupAssignmentAlgorithm _assignmentAlgorithm; + + public VirtualTopologyGroupService(HelixAdmin helixAdmin, ClusterService clusterService, + ConfigAccessor configAccessor, HelixDataAccessor dataAccessor) { + _helixAdmin = helixAdmin; + _clusterService = clusterService; + _configAccessor = configAccessor; + _dataAccessor = dataAccessor; + _assignmentAlgorithm = FifoVirtualGroupAssignmentAlgorithm.getInstance(); + } + + /** + * Add virtual topology group for a cluster. + * This includes calculating the virtual group assignment for all instances in the cluster then update instance config + * and cluster config. We override {@link ClusterConfig.ClusterConfigProperty#TOPOLOGY} and + * {@link ClusterConfig.ClusterConfigProperty#FAULT_ZONE_TYPE} for cluster config, and add new field to + * {@link InstanceConfig.InstanceConfigProperty#DOMAIN} that contains virtual topology group information. + * This is only supported for cloud environments. Cluster is expected to be in maintenance mode during config change. + * @param clusterName the cluster name. + * @param customFields custom fields, {@link VirtualTopologyGroupConstants#GROUP_NAME} + * and {@link VirtualTopologyGroupConstants#GROUP_NUMBER} are required, + * {@link VirtualTopologyGroupConstants#AUTO_MAINTENANCE_MODE_DISABLED} is optional. + * -- if set ture, the cluster will NOT automatically enter/exit maintenance mode during this API call; + * -- if set false or not set, the cluster will automatically enter maintenance mode and exit after + * the call succeeds. It won't proceed if the cluster is already in maintenance mode. + * Either case, the cluster must be in maintenance mode before config change. + */ + public void addVirtualTopologyGroup(String clusterName, Map<String, String> customFields) { + // validation + CloudConfig cloudConfig = _configAccessor.getCloudConfig(clusterName); + if (cloudConfig == null || !cloudConfig.isCloudEnabled()) { + throw new HelixException( + "Cloud is not enabled, addVirtualTopologyGroup is not allowed to run in non-cloud environment."); + } + ClusterConfig clusterConfig = _configAccessor.getClusterConfig(clusterName); + Preconditions.checkState(clusterConfig.isTopologyAwareEnabled(), + "Topology-aware rebalance is not enabled in cluster " + clusterName); + String groupName = customFields.get(VirtualTopologyGroupConstants.GROUP_NAME); + String groupNumberStr = customFields.get(VirtualTopologyGroupConstants.GROUP_NUMBER); + Preconditions.checkArgument(!StringUtils.isEmpty(groupName), "virtualTopologyGroupName cannot be empty!"); + Preconditions.checkArgument(!StringUtils.isEmpty(groupNumberStr), "virtualTopologyGroupNumber cannot be empty!"); + int numGroups = 0; + try { + numGroups = Integer.parseInt(groupNumberStr); + Preconditions.checkArgument(numGroups > 0, "Number of virtual groups should be positive."); + } catch (NumberFormatException ex) { + throw new IllegalArgumentException("virtualTopologyGroupNumber " + groupNumberStr + " is not an integer.", ex); + } + LOG.info("Computing virtual topology group for cluster {} with param {}", clusterName, customFields); + + // compute group assignment + ClusterTopology clusterTopology = _clusterService.getClusterTopology(clusterName); + Preconditions.checkArgument(numGroups <= clusterTopology.getAllInstances().size(), + "Number of virtual groups cannot be greater than the number of instances."); + Map<String, Set<String>> assignment = + _assignmentAlgorithm.computeAssignment(numGroups, groupName, clusterTopology.toZoneMapping()); + + boolean autoMaintenanceModeDisabled = Boolean.parseBoolean( + customFields.getOrDefault(VirtualTopologyGroupConstants.AUTO_MAINTENANCE_MODE_DISABLED, "false")); + // if auto mode is NOT disabled, let service enter maintenance mode and exit after the API succeeds. + if (!autoMaintenanceModeDisabled) { + Preconditions.checkState(!_helixAdmin.isInMaintenanceMode(clusterName), + "This operation is not allowed if cluster is already in maintenance mode before the API call. " + + "Please set autoMaintenanceModeDisabled=true if this is intended."); + _helixAdmin.manuallyEnableMaintenanceMode(clusterName, true, + "Enable maintenanceMode for virtual topology group change.", customFields); + } + Preconditions.checkState(_helixAdmin.isInMaintenanceMode(clusterName), + "Cluster is not in maintenance mode. This is required for virtual topology group setting. " + + "Please set autoMaintenanceModeDisabled=false (default) to let the cluster enter maintenance mode automatically, " + + "or use autoMaintenanceModeDisabled=true and control cluster maintenance mode in client side."); + + updateConfigs(clusterName, clusterConfig, assignment); + if (!autoMaintenanceModeDisabled) { + _helixAdmin.manuallyEnableMaintenanceMode(clusterName, false, + "Disable maintenanceMode after virtual topology group change.", customFields); + } + } + + private void updateConfigs(String clusterName, ClusterConfig clusterConfig, Map<String, Set<String>> assignment) { + List<String> zkPaths = new ArrayList<>(); + List<DataUpdater<ZNRecord>> updaters = new ArrayList<>(); + createInstanceConfigUpdater(clusterName, assignment).forEach((zkPath, updater) -> { + zkPaths.add(zkPath); + updaters.add(updater); + }); + // update instance config + boolean[] results = _dataAccessor.updateChildren(zkPaths, updaters, AccessOption.EPHEMERAL); + for (int i = 0; i < results.length; i++) { + if (!results[i]) { + throw new HelixException("Failed to update instance config for path " + zkPaths.get(i)); + } + } + // update cluster config + String virtualTopologyString = computeVirtualTopologyString(clusterConfig); + clusterConfig.setTopology(virtualTopologyString); + clusterConfig.setFaultZoneType(VirtualTopologyGroupConstants.VIRTUAL_FAULT_ZONE_TYPE); + _configAccessor.updateClusterConfig(clusterName, clusterConfig); + LOG.info("Successfully update instance and cluster config for {}", clusterName); + } + + @VisibleForTesting + static String computeVirtualTopologyString(ClusterConfig clusterConfig) { + ClusterTopologyConfig clusterTopologyConfig = ClusterTopologyConfig.createFromClusterConfig(clusterConfig); + String endNodeType = clusterTopologyConfig.getEndNodeType(); + String[] splits = new String[] {"", VirtualTopologyGroupConstants.VIRTUAL_FAULT_ZONE_TYPE, endNodeType}; + return String.join(VirtualTopologyGroupConstants.PATH_NAME_SPLITTER, splits); + } + + /** + * Create updater for instance config for async update. + * @param clusterName cluster name of the instances. + * @param assignment virtual group assignment. + * @return a map from instance zkPath to its {@link DataUpdater} to update. + */ + @VisibleForTesting Review comment: Yes, it's relaxed from private in order for testing, see `TestVirtualTopologyGroupService` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
