https://github.com/jaymzh/kubectl-daemons
A kubectl plugin to make working with daemonsets easier
https://github.com/jaymzh/kubectl-daemons
kubernetes kubernetes-daemonset
Last synced: 20 days ago
JSON representation
A kubectl plugin to make working with daemonsets easier
- Host: GitHub
- URL: https://github.com/jaymzh/kubectl-daemons
- Owner: jaymzh
- License: apache-2.0
- Created: 2024-03-02T08:30:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-14T07:12:01.000Z (about 1 year ago)
- Last Synced: 2025-04-30T03:49:24.475Z (20 days ago)
- Topics: kubernetes, kubernetes-daemonset
- Language: Go
- Homepage:
- Size: 49.8 KB
- Stars: 4
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kubectl-daemons
[](https://github.com/jaymzh/kubectl-daemons/actions/workflows/lint.yml)
[](https://github.com/jaymzh/kubectl-daemons/actions/workflows/build.yml)
## Intro
kubectl-daemons is a kubectl plugin to help with daemonset work. When running a
kubernetes infrastructure, it is common to do lots of work with deamonsets, but
the tools are optimized for other workflows where node names aren't
particularly important.. With daemonsets, you often know a node and a DS you
care about, and this plugin lets you focus on that.
Previously you'd do things like:
```shell
kubectl get pods -o wide | grep | grep
kubectl describe pod
kubectl delete pod
kubectl get pods -o wide | grep | grep
...
```
Or maybe:
```shell
kubectl get pods --field-selector spec.nodeName=
kubectl describe pod
kubectl delete pod
kubectl get pods ---field-selector spec.nodeName=
...
```
No more using a long `get` command to find the pod name,
and having to keep track of it! Just specify the DS and
the node:
```shell
kubectl d describe -N
kubectl d delete -N
kubectl d logs -N
```
## General Usage
Get pods from a daemonset:
```bash
kubectl d get
```
Or get the pod from a daemonset on a specific node
```bash
kubectl d get -N
```
Or get all daemonset-related pods on a node. I think of this as the equivalent
of asking systemd to list all services on a node. :)
```bash
kubectl d get -N
```
Or you can delete the pod from a daemonset on a specific node
```bash
kubectl d delete -N
```
You can do logs as well:
```bash
kubectl d logs -N
```
NOTE: -N is required here.
You can describe pods:
```bash
kubectl d describe [-N ] # node optional
```
You can even exec:
```bash
kubectl d exec -N -- echo "Hello world"
```
Or interactively:
```bash
kubectl d exec -N -it -- /bin/bash
```
And you can list all daemonsets on a node:
```bash
kubectl d list
```
## Installing
The easiest way to install, right now, is to grab the right build from our
[releases](https://github.com/jaymzh/kubectl-daemons/releases) page, and drop
the binary (`kubectl-d`) in your PATH.
If you get an error like "macOS cannot verify this app..." see [this page](
https://zaiste.net/os/macos/howtos/resolve-macos-cannot-be-opened-because-the-developer-cannot-be-verified-error/).
If you are a [Krew](https://krew.sigs.k8s.io/) user, we maintain our own index,
which you can use to install `kubectl-daemons`:
```shell
kubectl krew index add jaymzh https://github.com/jaymzh/jaymzh-krew.git
kubectl krew install kubectl-d
```
## Building from source
The quick-n-easy way to build is:
```shell
go build -o kubectl-d
```
Then stick `kubectl-d` somewhere in your path.
## Thanks
A huge thanks to Benjamin Muschko's [Writing your first kubectl
plugin](https://bmuschko.com/blog/writing-your-first-kubectl-plugin/) blog post
and associated [GH repo](https://github.com/bmuschko/kubectl-server-version).
This was invaluable in getting me up and running.
## FAQ
**Why not just write a simple shell wrapper?**
For many reasons. First, I had that, and it's quite slow. You end up doing more
queries than you need, and if your API servers are on the other side of
privatelinks, it can get quite slow.
Second, I wanted a good excuse to learn some golang and get better at Kube
internals.
**Aren't there already other plugins that do this?**
Not that I could find!
**Can I contribute?**
Sure, send a pull request!
**Why did you end up re-implementing so much kubectl formatting code?**
Trust me, I didn't want to. Unfortunately kubectl plugins aren't really
"plugins". They're standalone binaries that `kubectl` executes for you. So you
can use whatever is in the k8s libraries, but various things kubectl does like
formatting `describe` output, or various calculated fields, are note exposed as
functions other code can call.
Ideally, plugins would be a library that could hook into various stages within
kubectl and allow you to not have to implement so much yourself, but it turns
out that's not how kubectl plugins work.
**Why do you maintain your own Krew index?**
Krew
[felt](https://github.com/kubernetes-sigs/krew-index/pull/3679#issuecomment-1987113765)
this plugin wasn't sufficiently different from what you could do with `kubectl`
options and as such did not accept it.
However, a custom krew index is a simple [git
repository](https://github.com/jaymzh/jaymzh-krew), so maintaining our own
isn't an issue.