github.com/pingcap/tiup@v1.15.1/components/cluster/command/exec.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/pingcap/tiup/pkg/cluster/manager"
    18  	"github.com/spf13/cobra"
    19  )
    20  
    21  func newExecCmd() *cobra.Command {
    22  	opt := manager.ExecOptions{}
    23  	cmd := &cobra.Command{
    24  		Use:    "exec <cluster-name>",
    25  		Short:  "Run shell command on host in the tidb cluster",
    26  		Hidden: true,
    27  		RunE: func(cmd *cobra.Command, args []string) error {
    28  			if len(args) != 1 {
    29  				return cmd.Help()
    30  			}
    31  
    32  			clusterName := args[0]
    33  			clusterReport.ID = scrubClusterName(clusterName)
    34  			teleCommand = append(teleCommand, scrubClusterName(clusterName))
    35  
    36  			return cm.Exec(clusterName, opt, gOpt)
    37  		},
    38  		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
    39  			switch len(args) {
    40  			case 0:
    41  				return shellCompGetClusterName(cm, toComplete)
    42  			default:
    43  				return nil, cobra.ShellCompDirectiveNoFileComp
    44  			}
    45  		},
    46  	}
    47  
    48  	cmd.Flags().StringVar(&opt.Command, "command", "ls", "the command run on cluster host")
    49  	cmd.Flags().BoolVar(&opt.Sudo, "sudo", false, "use root permissions (default false)")
    50  	cmd.Flags().StringSliceVarP(&gOpt.Roles, "role", "R", nil, "Only exec on host with specified roles")
    51  	cmd.Flags().StringSliceVarP(&gOpt.Nodes, "node", "N", nil, "Only exec on host with specified nodes")
    52  
    53  	return cmd
    54  }