Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yashbhutwala/kubectl-df-pv
kubectl plugin - giving admins df (disk free) like utility for persistent volumes
https://github.com/yashbhutwala/kubectl-df-pv
df krew-plugin kubectl kubectl-plugin kubernetes persistent-volume-claims persistent-volumes
Last synced: 2 days ago
JSON representation
kubectl plugin - giving admins df (disk free) like utility for persistent volumes
- Host: GitHub
- URL: https://github.com/yashbhutwala/kubectl-df-pv
- Owner: yashbhutwala
- License: apache-2.0
- Created: 2019-11-28T13:00:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-19T06:46:00.000Z (about 1 year ago)
- Last Synced: 2024-12-14T03:07:33.613Z (9 days ago)
- Topics: df, krew-plugin, kubectl, kubectl-plugin, kubernetes, persistent-volume-claims, persistent-volumes
- Language: Go
- Homepage:
- Size: 7.91 MB
- Stars: 419
- Watchers: 8
- Forks: 32
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-kubectl-plugins - kubectl-df-pv
README
# `kubectl df-pv`
A `kubectl` plugin to see `df` for persistent volumes.
## Requirements
☑ `kube-apiserver` has `api/v1/nodes/` endpoint enabled
☑ Appropriate RBAC. This utility is meant for `cluster-admin` like user; specifically, you need a service account with enough RBAC privileges to access `api/v1/nodes/` from the `kube-apiserver`.
☑ Using a storage provisioner that populates pv metrics in a compatible manner (see what's been [tested](#tested) below)
## Quick Start
## Installation
### Via Krew
```shell script
curl https://krew.sh/df-pv | bash
# . ~/.bashrc # run if you use bash shell
# . ~/.zshrc # run if you use zsh shell
```
## From source
```shell script
cd $GOPATH/src/github.com/
mkdir -p yashbhutwala
cd yashbhutwala/
git clone [email protected]:yashbhutwala/kubectl-df-pv.git
cd kubectl-df-pv/
make install
df-pv --help
```
## Via Release Binary
### macOS
```shell script
download_path="./df-pv"
version="v0.2.2"
curl --fail -Lo $download_path "https://github.com/yashbhutwala/kubectl-df-pv/releases/download/${version}/kubectl-df-pv_${version}_darwin_amd64.tar.gz"
chmod +x $download_path
mv $(download_path) /some-dir-in-your-PATH/df-pv
```
## Usage
```shell script
kubectl df-pv
```
### Flags
```shell script
> kubectl df-pv --help
df-pv emulates Unix style df for persistent volumes w/ ability to filter by namespace
It autoconverts all "sizes" to IEC values (see: https://en.wikipedia.org/wiki/Binary_prefix and https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory)
It colors the values based on "severity" [red: > 75% (too high); yellow: < 25% (too low); green: >= 25 and <= 75 (OK)]
Usage:
df-pv [flags]
Flags:
-h, --help help for df-pv
-n, --namespace string if present, the namespace scope for this CLI request (default is all namespaces)
-v, --verbosity string log level; one of [info, debug, trace, warn, error, fatal, panic] (default "info")
```
### Other useful commands
#### enable trace logging, but output to a file
```shell script
df-pv -v trace 2> trace.log
```
## Tested
### Works on
☑ **`GKE`** (**`kubernetes.io/gce-pd`** dynamic provisioner; both with `ssd` and `standard`)
☑ **`kubeadm`** configured bare-metal cluster ([**rook ceph block**](https://rook.io/docs/rook/v1.2/ceph-block.html) dynamic provisioner using [script](https://github.com/blackducksoftware/let-me-cluster-that-for-you/blob/master/k8s-addons/storage/external-storage/ceph/install-ceph-provisioner.sh))
### Does not work due to storage provisioner
☒ **`kind`** ([**`rancher/local-path-provisioner`** dynamic provisioner](https://github.com/rancher/local-path-provisioner))
☒ **`minikube`** ([**`gcr.io/k8s-minikube/storage-provisioner`** minikube-hostpath dynamic provisioner](https://minikube.sigs.k8s.io/docs/handbook/persistent_volumes/))
### TODO
[ ] EKS
[ ] AKS
## TODO Features
### Yet to be completed
☒ sort-by flag
☒ exclude namespaces
☒ only show a specific colored result ("red", "yellow", "green")
### Completed
☑ `df` for all Persistent Volumes in the cluster
☑ human readable output as default (using IEC format)
☑ color based on usage [red: > 75% (too high); yellow: < 25% (too low); green: >= 25 and <= 75 (OK)]
☑ print PV name
☑ print volume mount name
## Motivation
Have you ever wondered, "How much free disk space do all my PVs have?" Me too! That's why I built this plugin! I have always just wanted to quick way to see the disk usage of my Persistent Volumes (similar to [`df`](https://en.wikipedia.org/wiki/Df_(Unix)) or `du` in Unix). It turns out I'm not the only one, there has been many upstream Kubernetes issues open again and again about this, even some KEPs and PRs. I have compiled some of the issues and KEPs that I've seen in the wild here:
### Issues
["this feature is needed .. !!!!" - @halradaideh](https://github.com/kubernetes/kubernetes/issues/42465)
["There was a plan to implement this for 1.7 but we ran out of time."](https://github.com/kubernetes/kubernetes/issues/47649)
["I need to know to which Pod(s) a PVC is being mounted to, without having to go through each Pod one by one checking the Volume mounts and the PersistentVolumeClaim."](https://github.com/kubernetes/kubernetes/issues/65233)
### KEPs
["PVC should show how much of the available capacity is used vs available"](https://github.com/kubernetes/enhancements/issues/293)
["Expose storage metrics to end users"](https://github.com/kubernetes/enhancements/issues/363)
["Display PVC capacity usage using kubectl"... "Has this been continued somewhere? It would be super useful"](https://github.com/kubernetes/enhancements/issues/497)
["exposing storage metrics to users"... "Status? Was it done?"](https://github.com/kubernetes/community/pull/855)
### Other relevant/rabbit-hole links
["Volume metrics exposed in /stats/summary not available in /metrics"](https://github.com/kubernetes/kubernetes/issues/34137)
[interesting metric PR](https://github.com/kubernetes/kubernetes/pull/19741/files)
[something similar to du in metrics](https://github.com/kubernetes/kubernetes/blob/v1.16.3/pkg/volume/metrics_du.go)
[client-go issue about kubelet api by @DirectXMan12](https://github.com/kubernetes/client-go/issues/74)
[kubelet stats api](https://github.com/kubernetes/kubernetes/blob/v1.16.3/pkg/kubelet/apis/stats/v1alpha1/types.go)
[kubelet client](https://github.com/kubernetes/kubernetes/tree/v1.16.3/pkg/kubelet/client)
[metrics-server client](https://github.com/kubernetes-sigs/metrics-server/blob/v0.3.6/pkg/sources/summary/client.go)
[blog about kubectl printers and columns](https://blog.mafr.de/2019/04/22/using-kubectl-printers-and-plugins/)
[cli-runtime tableprinter usage](https://github.com/kubernetes/cli-runtime/blob/kubernetes-1.17.0-rc.1/pkg/printers/tableprinter_test.go)
[kubectl using cli-runtime; sorting is still not implemented](https://github.com/kubernetes/kubectl/blob/kubernetes-1.17.0-rc.1/pkg/cmd/get/humanreadable_flags.go#L98)