github.com/pingcap/tiup@v1.15.1/components/cluster/command/stop.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  	"github.com/spf13/cobra"
    18  )
    19  
    20  func newStopCmd() *cobra.Command {
    21  	var evictLeader bool
    22  
    23  	cmd := &cobra.Command{
    24  		Use:   "stop <cluster-name>",
    25  		Short: "Stop a TiDB cluster",
    26  		RunE: func(cmd *cobra.Command, args []string) error {
    27  			if len(args) != 1 {
    28  				return cmd.Help()
    29  			}
    30  
    31  			if err := validRoles(gOpt.Roles); err != nil {
    32  				return err
    33  			}
    34  
    35  			clusterName := args[0]
    36  			clusterReport.ID = scrubClusterName(clusterName)
    37  			teleCommand = append(teleCommand, scrubClusterName(clusterName))
    38  
    39  			return cm.StopCluster(clusterName, gOpt, skipConfirm, evictLeader)
    40  		},
    41  		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
    42  			switch len(args) {
    43  			case 0:
    44  				return shellCompGetClusterName(cm, toComplete)
    45  			default:
    46  				return nil, cobra.ShellCompDirectiveNoFileComp
    47  			}
    48  		},
    49  	}
    50  
    51  	cmd.Flags().StringSliceVarP(&gOpt.Roles, "role", "R", nil, "Only stop specified roles")
    52  	cmd.Flags().StringSliceVarP(&gOpt.Nodes, "node", "N", nil, "Only stop specified nodes")
    53  	cmd.Flags().BoolVar(&evictLeader, "evict-leaders", false, "Evict leaders on stores before stop")
    54  
    55  	_ = cmd.Flags().MarkHidden("evict-leaders")
    56  
    57  	return cmd
    58  }