kubectl-mexec

A fast way to run kubectl exec/cp on multiple pods in parallel.

Install

Krew install

Make sure you've already installed krew (a kubectl plugin manager).

# install kubectl-mexec plugin
kubectl krew update
kubectl krew install mexec

Start to use

kubectl mexec -h

Local install

First make sure you have already installed kubectl.

# clone this repo
git clone https://github.com/major1201/kubectl-mexec.git

# make a link from kubectl-mexec to one of your $PATH
ln -s ./kubectl-mexec /usr/local/bin/kubectl-mexec

Usage

Execute on your pods

Usage:
  kubectl mexec [-c container_name] [-h] [-p parallel] <kubectl get pod pattern> -- cmd

Parameters:
  -c,--container     specify container name
  -h,--help          show this help message
  -p,--parallel      set concurrent processes, default to 1

Examples

# Run 'ls' on every pod with selector 'app.kubernetes.io/name=myapp'
kubectl mexec -l app.kubernetes.io/name=myapp -- ls

# With parallel 100 pods
kubectl mexec -p 100 -- cmd

# Run bash script
kubectl mexec -- bash -c "tail -n 10 /etc/passwd | grep root"

upload: Upload local file to your pods

Usage:
  kubectl mexec upload [-c container_name] [-h] [-p parallel] --local-file <local-file> --remote-path <remote-file-path>

Parameters:
  -h,--help          show this help message
  -c,--container     specify container name
  --retries          set number of retries to complete a copy operation from a container
  -p,--parallel      set concurrent processes, default to 1
  -F,--local-file    local file to upload
  -r,--remote-path   remote path

Examples:

# Upload ./local-file to every pod with label app.kubernetes.io/name=myapp in /tmp/local-file
kubectl mexec upload -l app.kubernetes.io/name=myapp --local-file ./local-file --remote-path /tmp/local-file

# Upload file with concurrent 10 processes in parallel
kubectl mexec upload -p 10 -l app.kubernetes.io/name=myapp -F ./local-file -r /tmp/local-file

download: Download your files from container to your local directory

Usage:
  kubectl mexec download [-c container_name] [-h] [-p parallel] [--local-directory <local-file>] --remote-path <remote-file-path>

Parameters:
  -h,--help              show this help message
  -c,--container         specify container name
  --retries              set number of retries to complete a copy operation from a container
  -p,--parallel          set concurrent processes, default to 1
  -d,--local-directory   local file to upload
  -r,--remote-path       remote path

Examples:

# Download ./tmp/local-file from every pod with label app.kubernetes.io/name=myapp to pwd with pod name for each pod
kubectl mexec download -l app.kubernetes.io/name=myapp --remote-path /tmp/local-file

# Download file with concurrent 10 processes in parallel
kubectl mexec download -l app.kubernetes.io/name=myapp --remote-path /tmp/local-file -p 10

This'll download your file/directory from container to local directory with pod name for your source file/directory

$ kubectl mexec download -l app.kubernetes.io/name=dancedn --remote-path /tmp/myfile.sh -c my -p 3
mypod-1 tar: Removing leading `/' from member names
mypod-0 tar: Removing leading `/' from member names
mypod-2 tar: Removing leading `/' from member names
$ ls
mypod-0
mypod-1
mypod-2