kubectl-notes

This is an extremely simple and useless extension for kubectl that lets you add notes to Kubernetes Pods. It's intended to illustrate how you might build your own kubectl extension.

Usage

Here's an example:

# Add a note to a Pod
kubectl notes add --namespace my-ns --pod my-pod "This Pod has been acting shady"

# Fetch a note from a Pod
kubectl notes get --namespace my-ns --pod my-pod
This Pod has been acting shady

# Delete a note
kubectl notes delete --namespace my-ns --pod my-pod

You can substitute -n for --namespace and -p for --pod.

The default namespace will be used if none is provided.

Installation

You can install kubectl-notes using either go install or Homebrew:

go install github.com/lucperkins/kubectl-notes

# Homebrew
brew tap lucperkins/tap
brew install kubectl-notes

If $GOPATH/bin is on your PATH, you can invoke it directly from kubectl as in the example above.

How it works

kubectl-notes simply adds an annotation to the Pod with the key note.

Auto-completion

kubectl-notes also offers CLI auto-completion:

# Bash
source <(kubectl-notes completion bash)

# Zsh
source <(kubectl-notes completion zsh)

# Oh My Zsh
kubectl-notes completion zsh > "${fpath[1]}/_kubectl-notes"