https://github.com/guessi/kubectl-grep

Filter Kubernetes resources by matching their names
https://github.com/guessi/kubectl-grep

github-actions golang kubectl kubectl-plugins kubernetes

Last synced: about 1 month ago
JSON representation

Filter Kubernetes resources by matching their names

• Host: GitHub
• URL: https://github.com/guessi/kubectl-grep
• Owner: guessi
• License: apache-2.0
• Created: 2019-02-12T17:25:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-13T17:39:32.000Z (3 months ago)
• Last Synced: 2024-09-14T08:38:56.362Z (3 months ago)
• Topics: github-actions, golang, kubectl, kubectl-plugins, kubernetes
• Language: Go
• Homepage:
• Size: 450 KB
• Stars: 114
• Watchers: 4
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kubectl-plugins - kubectl-grep
• awesome-repositories - guessi/kubectl-grep - Filter Kubernetes resources by matching their names (Go)

README

        
# Kubectl Grep

[![GitHub Actions](https://github.com/guessi/kubectl-grep/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/guessi/kubectl-grep/actions/workflows/go.yml)

[![GoDoc](https://godoc.org/github.com/guessi/kubectl-grep?status.svg)](https://godoc.org/github.com/guessi/kubectl-grep)

[![Go Report Card](https://goreportcard.com/badge/github.com/guessi/kubectl-grep)](https://goreportcard.com/report/github.com/guessi/kubectl-grep)

[![GitHub release](https://img.shields.io/github/release/guessi/kubectl-grep.svg)](https://github.com/guessi/kubectl-grep/releases/latest)

[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/guessi/kubectl-grep)](https://github.com/guessi/kubectl-grep/blob/master/go.mod)

Filter Kubernetes resources by matching their names

# Compatibility

please refer to [Kubernetes version policy](https://kubernetes.io/docs/setup/release/version-skew-policy/#kubectl) and [CHANGELOG](CHANGELOG.md) for supported version matrix.

# Why we need it?

playing with Kubernetes is my daily job, and I normally search pods by `pipe`,

`grep`, `--label`, `--field-selector`, etc. while hunting abnormal pods, but

typing such long commands is quite annoying.

Before change, we usually filter pods by the following commands,

    $ kubectl get pods -n star-lab | grep "flash"

With this plugin installed, you can filter pod with `kubectl grep` easily

    $ kubectl grep pods -n star-lab flash

# Installation

Installation via [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/)

    $ kubectl krew version # make sure you are running 0.4.4+

    $ kubectl krew install grep

    $ kubectl krew update

    $ kubectl krew upgrade grep

Manual Installation

    $ curl -fsSL -O https://github.com/guessi/kubectl-grep/releases/latest/download/kubectl-grep-$(uname -s)-$(uname -m).tar.gz

    $ tar zxvf kubectl-grep-$(uname -s)-$(uname -m).tar.gz

    $ mv kubectl-grep /usr/local/bin

# How to get developer build?

    $ go get -u github.com/guessi/kubectl-grep

    $ cd ${GOPATH}/src/github.com/guessi/kubectl-grep

    $ make all

# FAQ

How do I check the tool's version?

* `kubectl grep version`

Can I use version X `kubectl` with version Y `kubectl-grep`?

* Sure, no problem

What kind of resource(s) `kubectl-grep` support?

* Please refer to [Resource Types](RESOURCE_TYPES.md)

# Reference

- [Kubectl Plugins](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)

# License

[Apache-2.0](LICENSE)