tools

type ForwardedPort struct {
	// LocalPort specifies the local port to use. 0 means selecting
	// a random local port.
	LocalPort uint16
	// RemotePort specifies the remote (pod-side) port to use.
	RemotePort uint16
}

type KubeClient interface {
	// GetVirtletPodAndNodeNames returns a list of names of the
	// virtlet pods present in the cluster and a list of
	// corresponding node names that contain these pods.
	GetVirtletPodAndNodeNames() (podNames []string, nodeNames []string, err error)
	// GetVirtletPodNameForNode returns a name of the virtlet pod on
	// the specified k8s node.
	GetVirtletPodNameForNode(nodeName string) (string, error)
	// GetVMPodInfo returns then name of the virtlet pod and the vm container name for
	// the specified VM pod.
	GetVMPodInfo(podName string) (*VMPodInfo, error)
	// ExecInContainer given a pod, a container, a namespace and a command
	// executes that command inside the pod's container returning stdout and stderr output
	// as strings and an error if it has occurred.
	// The specified stdin, stdout and stderr are used as the
	// standard input / output / error streams of the remote command.
	// No TTY is allocated by this function stdin.
	ExecInContainer(podName, containerName, namespace string, stdin io.Reader, stdout, stderr io.Writer, command []string) (int, error)
	// ForwardPorts starts forwarding the specified ports to the specified pod in background.
	// If a port entry has LocalPort = 0, it's updated with the real port number that was
	// selected by the forwarder.
	// The function returns when the ports are ready for use or if/when an error occurs.
	// Close stopCh to stop the port forwarder.
	ForwardPorts(podName, namespace string, ports []*ForwardedPort) (stopCh chan struct{}, err error)
}

type Plugin struct {
	// Name is the name of the plugin.
	Name string `json:"name"`
	// ShortDesc is the short description of the plugin.
	ShortDesc string `json:"shortDesc"`
	// LongDesc is the detailed description of the plugin.
	LongDesc string `json:"longDesc,omitempty"`
	// Example is an example of plugin usage.
	Example string `json:"example,omitempty"`
	// Command is the command that needs to be run by kubectl
	// to execute the plugin.
	Command string `json:"command,omitempty"`
	// Flags describes the flags for this plugin.
	Flags []PluginFlag `json:"flags,omitempty"`
	// Tree lists the subcommands of this plugin.
	Tree []*Plugin `json:"tree,omitempty"`
}

type PluginFlag struct {
	// Name is the name of the flag
	Name string `json:"name"`
	// Shorthand is the shorthand for the flag, e.g. -o
	Shorthand string `json:"shorthand,omitempty"`
	// Desc is the description of the flag
	Desc string `json:"desc"`
	// DefValue is the default value of the flag.
	DefValue string `json:"defValue,omitempty"`
}

type RealKubeClient struct {
	// contains filtered or unexported fields
}

type VMPodInfo struct {
	// NodeName is the name of the node where the VM pod runs
	NodeName string
	// VirtletPodName is the name of the virtlet pod that manages this VM pod
	VirtletPodName string
	// ContainerID is the id of the container in the VM pod
	ContainerID string
	// ContainerName is the name of the container in the VM pod
	ContainerName string
}