kubectl-explore's Introduction

kubectl-explore

This is a plugin for kubectl to fuzzy-find and explain the field supported API resource.

What

kubectl-explore finds and explains the field associated with each supported API resource.

Motivation

kubectl explain is already helpful, but typing the accurate path to the filed is a tedious and typo-prone.

Install

Download the binary from GitHub Releases and drop it in your $PATH.

Linux

curl -L -o kubectl-explore.tar.gz https://github.com/kei6u/kubectl-explore/releases/download/0.1.0/kubectl-explore_linux_x86_64.tar.gz
tar -xvf kubectl-explore.tar.gz
sudo mv kubectl-explore /usr/local/bin

OSX

curl -L -o kubectl-explore.tar.gz https://github.com/kei6u/kubectl-explore/releases/download/0.1.0/kubectl-explore_darwin_x86_64.tar.gz
tar -xvf kubectl-explore.tar.gz
sudo mv kubectl-explore /usr/local/bin

Source

go install github.com/kei6u/kubectl-explore
sudo mv $GOPATH/bin/kubectl-explore /usr/local/bin

Validation

Validate if kubectl explore can be executed. The Kubernetes documentation explains how to use a plugin.

$ kubectl explore --help
This command finds fields associated with each supported API resource to explain.

Fields are identified via a simple JSONPath identifier:
        <type>.<fieldName>[.<fieldName>]

Usage:
  kubectl-explore RESOURCE [options] [flags]

Examples:

# Explore pod fields.
kubectl-explore pod

# Explore "pod.spec.containers" fields.
kubectl-explore pod.spec.containers

# Explore the resource selected by interactive fuzzy-finder.
kubectl-explore


Flags:
      --api-version string   Get different explanations for particular API version (API group/version)
  -h, --help                 help for kubectl-explore

Recommend Projects