ibice / kubectl-execws

A replacement for "kubectl exec" that works over WebSocket connections.

kubectl-execws

A replacement for "kubectl exec" that works over WebSocket connections.

The Kubernetes API server has support for exec over WebSockets, but it has yet to land in kubectl. Although some proposals exist to add the functionality, they seem quite far away from landing. This plugin is designed to be a stopgap until they do.

Usage:

Usage:
  kubectl-execws <pod name> [options] -- <cmd>

Flags:
  -c, --container string             Container name
  -h, --help                         help for execws
      --kubeconfig string            kubeconfig file (default is $HOME/.kube/config)
  -v, --loglevel int                 Set loglevel (default 2)
  -n, --namespace string             Set namespace
      --no-sanity-check              Don't make preflight request to ensure pod exists
      --node-direct-exec             Partially bypass the API server, by using the kubelet API
      --node-direct-exec-ip string   Node IP to use with direct-exec feature
  -k, --skip-tls-verify              Don't perform TLS certificate verifiation
  -i, --stdin                        Pass stdin to container
  -t, --tty                          Stdin is a TTY

Features

• Aware of HTTP_PROXY/HTTPS_PROXY env variables
• Uses standard Kubeconfig processing including ~/.kube/config & $KUBECONFIG support
• Doesn't use SPDY so might be more loadbalancer/reverse proxy friendly
• Supports a full TTY (terminal raw mode)
• Can bypass the API server with direct connection to the nodes kubelet API

Tab Completion

Tab completion is available for various shells [bash|zsh|fish|powershell].

This can be used with the standalone binary through use of the completion subcommand, eg. source <(kubectl-execws completion zsh)

Completion is also available when using as a kubectl plugin. To set this up it is necessary to symlink to the multi-call binary with a special name: ln -s kubectl-execws kubectl_complete-execws.

Acknowledgements

Work inspired by rmohr/kubernetes-custom-exec and kairen/websocket-exec.