github.com/pingcap/tiup@v1.15.1/components/cluster/command/reload.go (about)

     1  // Copyright 2020 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package command
    15  
    16  import (
    17  	perrs "github.com/pingcap/errors"
    18  	"github.com/pingcap/tiup/pkg/cluster/spec"
    19  	"github.com/spf13/cobra"
    20  )
    21  
    22  func newReloadCmd() *cobra.Command {
    23  	var skipRestart bool
    24  	cmd := &cobra.Command{
    25  		Use:   "reload <cluster-name>",
    26  		Short: "Reload a TiDB cluster's config and restart if needed",
    27  		RunE: func(cmd *cobra.Command, args []string) error {
    28  			if len(args) != 1 {
    29  				return cmd.Help()
    30  			}
    31  
    32  			if err := validRoles(gOpt.Roles); err != nil {
    33  				return err
    34  			}
    35  
    36  			clusterName := args[0]
    37  			clusterReport.ID = scrubClusterName(clusterName)
    38  			teleCommand = append(teleCommand, scrubClusterName(clusterName))
    39  
    40  			return cm.Reload(clusterName, gOpt, skipRestart, skipConfirm)
    41  		},
    42  		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
    43  			switch len(args) {
    44  			case 0:
    45  				return shellCompGetClusterName(cm, toComplete)
    46  			default:
    47  				return nil, cobra.ShellCompDirectiveNoFileComp
    48  			}
    49  		},
    50  	}
    51  
    52  	cmd.Flags().BoolVar(&gOpt.Force, "force", false, "Force reload without transferring PD leader and ignore remote error")
    53  	cmd.Flags().StringSliceVarP(&gOpt.Roles, "role", "R", nil, "Only reload specified roles")
    54  	cmd.Flags().StringSliceVarP(&gOpt.Nodes, "node", "N", nil, "Only reload specified nodes")
    55  	cmd.Flags().Uint64Var(&gOpt.APITimeout, "transfer-timeout", 600, "Timeout in seconds when transferring PD and TiKV store leaders, also for TiCDC drain one capture")
    56  	cmd.Flags().BoolVarP(&gOpt.IgnoreConfigCheck, "ignore-config-check", "", false, "Ignore the config check result")
    57  	cmd.Flags().BoolVar(&skipRestart, "skip-restart", false, "Only refresh configuration to remote and do not restart services")
    58  	cmd.Flags().StringVar(&gOpt.SSHCustomScripts.BeforeRestartInstance.Raw, "pre-restart-script", "", "(EXPERIMENTAL) Custom script to be executed on each server before the service is restarted, does not take effect when --skip-restart is set to true")
    59  	cmd.Flags().StringVar(&gOpt.SSHCustomScripts.AfterRestartInstance.Raw, "post-restart-script", "", "(EXPERIMENTAL) Custom script to be executed on each server after the service is restarted, does not take effect when --skip-restart is set to true")
    60  
    61  	return cmd
    62  }
    63  
    64  func validRoles(roles []string) error {
    65  	for _, r := range roles {
    66  		match := false
    67  		for _, has := range spec.AllComponentNames() {
    68  			if r == has {
    69  				match = true
    70  				break
    71  			}
    72  		}
    73  
    74  		if !match {
    75  			return perrs.Errorf("not valid role: %s, should be one of: %v", r, spec.AllComponentNames())
    76  		}
    77  	}
    78  
    79  	return nil
    80  }