124 lines
4.6 KiB
Go
124 lines
4.6 KiB
Go
package exec
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
"k8s.io/cli-runtime/pkg/genericclioptions"
|
|
kubectlexec "k8s.io/kubectl/pkg/cmd/exec"
|
|
cmdutil "k8s.io/kubectl/pkg/cmd/util"
|
|
"k8s.io/kubectl/pkg/util/templates"
|
|
|
|
"github.com/karmada-io/karmada/pkg/karmadactl/options"
|
|
"github.com/karmada-io/karmada/pkg/karmadactl/util"
|
|
)
|
|
|
|
const (
|
|
defaultPodExecTimeout = 60 * time.Second
|
|
)
|
|
|
|
var (
|
|
execLong = templates.LongDesc(`
|
|
Execute a command in a container in a cluster.`)
|
|
|
|
execExample = templates.Examples(`
|
|
# Get output from running the 'date' command from pod mypod, using the first container by default in cluster(member1)
|
|
%[1]s exec mypod -C=member1 -- date
|
|
|
|
# Get output from running the 'date' command in ruby-container from pod mypod in cluster(member1)
|
|
%[1]s exec mypod -c ruby-container -C=member1 -- date
|
|
|
|
# Get output from running the 'date' command in ruby-container from pod mypod in cluster(member1)
|
|
%[1]sexec mypod -c ruby-container -C=member1 -- date
|
|
|
|
# Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod in cluster(member1)
|
|
# and sends stdout/stderr from 'bash' back to the client
|
|
%[1]s exec mypod -c ruby-container -C=member1 -i -t -- bash -il
|
|
|
|
# Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default in cluster(member1)
|
|
%[1]s exec deploy/mydeployment -C=member1 -- date
|
|
|
|
# Get output from running 'date' command from the first pod of the service myservice, using the first container by default in cluster(member1)
|
|
%[1]s exec svc/myservice -C=member1 -- date`)
|
|
)
|
|
|
|
// NewCmdExec new exec command.
|
|
func NewCmdExec(f util.Factory, parentCommand string, streams genericclioptions.IOStreams) *cobra.Command {
|
|
o := &CommandExecOptions{
|
|
KubectlExecOptions: &kubectlexec.ExecOptions{
|
|
StreamOptions: kubectlexec.StreamOptions{
|
|
IOStreams: streams,
|
|
},
|
|
Executor: &kubectlexec.DefaultRemoteExecutor{},
|
|
},
|
|
}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "exec (POD | TYPE/NAME) [-c CONTAINER] (-C CLUSTER) -- COMMAND [args...]",
|
|
Short: "Execute a command in a container in a cluster",
|
|
Long: execLong,
|
|
SilenceUsage: true,
|
|
DisableFlagsInUseLine: true,
|
|
Example: fmt.Sprintf(execExample, parentCommand),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
argsLenAtDash := cmd.ArgsLenAtDash()
|
|
if err := o.Complete(f, cmd, args, argsLenAtDash); err != nil {
|
|
return err
|
|
}
|
|
if err := o.Validate(); err != nil {
|
|
return err
|
|
}
|
|
if err := o.Run(); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
},
|
|
Annotations: map[string]string{
|
|
util.TagCommandGroup: util.GroupClusterTroubleshootingAndDebugging,
|
|
},
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
options.AddKubeConfigFlags(flags)
|
|
flags.StringVarP(options.DefaultConfigFlags.Namespace, "namespace", "n", *options.DefaultConfigFlags.Namespace, "If present, the namespace scope for this CLI request")
|
|
cmdutil.AddPodRunningTimeoutFlag(cmd, defaultPodExecTimeout)
|
|
cmdutil.AddJsonFilenameFlag(flags, &o.KubectlExecOptions.FilenameOptions.Filenames, "to use to exec into the resource")
|
|
cmdutil.AddContainerVarFlags(cmd, &o.KubectlExecOptions.ContainerName, o.KubectlExecOptions.ContainerName)
|
|
|
|
flags.BoolVarP(&o.KubectlExecOptions.Stdin, "stdin", "i", o.KubectlExecOptions.Stdin, "Pass stdin to the container")
|
|
flags.BoolVarP(&o.KubectlExecOptions.TTY, "tty", "t", o.KubectlExecOptions.TTY, "Stdin is a TTY")
|
|
flags.BoolVarP(&o.KubectlExecOptions.Quiet, "quiet", "q", o.KubectlExecOptions.Quiet, "Only print output from the remote session")
|
|
flags.StringVarP(&o.Cluster, "cluster", "C", "", "Specify a member cluster")
|
|
return cmd
|
|
}
|
|
|
|
// CommandExecOptions declare the arguments accepted by the Exec command
|
|
type CommandExecOptions struct {
|
|
// flags specific to exec
|
|
KubectlExecOptions *kubectlexec.ExecOptions
|
|
Cluster string
|
|
}
|
|
|
|
// Complete verifies command line arguments and loads data from the command environment
|
|
func (o *CommandExecOptions) Complete(f util.Factory, cmd *cobra.Command, argsIn []string, argsLenAtDash int) error {
|
|
if len(o.Cluster) == 0 {
|
|
return fmt.Errorf("must specify a cluster")
|
|
}
|
|
memberFactory, err := f.FactoryForMemberCluster(o.Cluster)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return o.KubectlExecOptions.Complete(memberFactory, cmd, argsIn, argsLenAtDash)
|
|
}
|
|
|
|
// Validate checks that the provided exec options are specified.
|
|
func (o *CommandExecOptions) Validate() error {
|
|
return o.KubectlExecOptions.Validate()
|
|
}
|
|
|
|
// Run executes a validated remote execution against a pod.
|
|
func (o *CommandExecOptions) Run() error {
|
|
return o.KubectlExecOptions.Run()
|
|
}
|