kubectl-view-allocations

kubectl plugin lists allocations for resources (cpu, memory, gpu,...) as defined into the manifest of nodes and running pods. It doesn't list usage like kubectl top. It can provide result grouped by namespaces, nodes, pods and filtered by resources'name.

Columns displayed :

• Requested : Quantity of resources requested by the container in the pod's manifest. It's the sum group by pod, namespace, node where container is running. With percentage of resources requested over what is allocatable in the group.
• Limit : Quantity of resources max (limit) requestable by the container in the pod's manifest. It's the sum group by pod, namespace, node where container is running. With percentage of resources max / limit over what is allocatable in the group.
• Allocatable : Allocatable resources defined (or detected) on nodes.
• Free : Allocatable - max (Limit, Requested)
• Utilization : Quantity of resources (cpu & memory only) used as reported by Metrics API. It's disable by default, metrics-server is optional and should be setup into the cluster.

Install

Via download binary

Download from github's release or use script

sh curl https://raw.githubusercontent.com/davidB/kubectl-view-allocations/master/scripts/getLatest.sh | bash

Via krew (kubectl plugin manager)

Krew – kubectl plugin manager

sh kubectl krew install view-allocations

Via cargo

sh cargo install kubectl-view-allocations

As lib in Cargo.toml

If you want to embed some function or struct of the plugin into an other rust code:

```toml [dependencies] kubectl-view-allocations = { version = "0.14", default-features = false }

[features] default = ["k8s-openapi/v1_20"] ```

Usage

Show help

```txt kubectl-view-allocations -h

kubectl-view-allocations 0.14.7 https://github.com/davidB/kubectl-view-allocations kubectl plugin to list allocations (cpu, memory, gpu,... X utilization, requested, limit, allocatable,...)

USAGE: kubectl-view-allocations [OPTIONS]

OPTIONS: --context The name of the kubeconfig context to use

-g, --group-by <GROUP_BY>
        Group information hierarchically (default: -g resource -g node -g pod) [possible values:
        resource, node, pod, namespace]

-h, --help
        Print help information

-n, --namespace <NAMESPACE>
        Show only pods from this namespace

-o, --output <OUTPUT>
        Output format [default: table] [possible values: table, csv]

-r, --resource-name <RESOURCE_NAME>
        Filter resources shown by name(s), by default all resources are listed

-u, --utilization
        Force to retrieve utilization (for cpu and memory), require to have metrics-server
        https://github.com/kubernetes-sigs/metrics-server

-V, --version
        Print version information

-z, --show-zero
        Show lines with zero requested and zero limit and zero allocatable

```

Show gpu allocation

```txt

kubectl-view-allocations -r gpu

Resource Requested Limit Allocatable Free nvidia.com/gpu (71%) 10.0 (71%) 10.0 14.0 4.0 ├─ node-gpu1 (0%) _ (0%) _ 2.0 2.0 ├─ node-gpu2 (0%) _ (0%) _ 2.0 2.0 ├─ node-gpu3 (100%) 2.0 (100%) 2.0 2.0 _ │ └─ fah-gpu-cpu-d29sc 2.0 2.0 _ _ ├─ node-gpu4 (100%) 2.0 (100%) 2.0 2.0 _ │ └─ fah-gpu-cpu-hkg59 2.0 2.0 _ _ ├─ node-gpu5 (100%) 2.0 (100%) 2.0 2.0 _ │ └─ fah-gpu-cpu-nw9fc 2.0 2.0 _ _ ├─ node-gpu6 (100%) 2.0 (100%) 2.0 2.0 _ │ └─ fah-gpu-cpu-gtwsf 2.0 2.0 _ _ └─ node-gpu7 (100%) 2.0 (100%) 2.0 2.0 _ └─ fah-gpu-cpu-x7zfb 2.0 2.0 _ __ ```

Overview only

```sh

kubectl-view-allocations -g resource

Resource Requested Limit Allocatable Free cpu (21%) 56.7 (65%) 176.1 272.0 95.9 ephemeral-storage (0%) _ (0%) _ 38.4T 38.4T memory (8%) 52.7Gi (15%) 101.3Gi 675.6Gi 574.3Gi nvidia.com/gpu (71%) 10.0 (71%) 10.0 14.0 4.0 pods (9%) 147.0 (9%) 147.0 1.6k 1.5k ```

Show utilization

• Utilization information are retrieve from metrics-server (should be setup on your cluster).
• Only report cpu and memory utilization

```sh

kubectl-view-allocations -u

Resource Utilization Requested Limit Allocatable Free cpu (0%) 9.0m (10%) 200.0m _ 2.0 1.8 └─ lima-rancher-desktop (0%) 9.0m (10%) 200.0m _ 2.0 1.8 ├─ coredns-96cc4f57d-57cj9 1.0m 100.0m _ _ _ ├─ local-path-provisioner-84bb864455-czzcg 1.0m _ _ _ _ ├─ metrics-server-ff9dbcb6c-kb7x9 4.0m 100.0m _ _ _ ├─ svclb-traefik-ggd2q 2.0m _ _ _ _ └─ traefik-55fdc6d984-sqp57 1.0m _ _ _ _ ephemeral-storage _ _ _ 99.8G _ └─ lima-rancher-desktop _ _ _ 99.8G _ memory (1%) 51.0Mi (2%) 140.0Mi (3%) 170.0Mi 5.8Gi 5.6Gi └─ lima-rancher-desktop (1%) 51.0Mi (2%) 140.0Mi (3%) 170.0Mi 5.8Gi 5.6Gi ├─ coredns-96cc4f57d-57cj9 11.5Mi 70.0Mi 170.0Mi _ _ ├─ local-path-provisioner-84bb864455-czzcg 6.2Mi _ _ _ _ ├─ metrics-server-ff9dbcb6c-kb7x9 14.9Mi 70.0Mi _ _ _ ├─ svclb-traefik-ggd2q 548.0Ki _ _ _ _ └─ traefik-55fdc6d984-sqp57 17.9Mi _ _ _ _ pods _ (5%) 5.0 (5%) 5.0 110.0 105.0 └─ lima-rancher-desktop __ (5%) 5.0 (5%) 5.0 110.0 105.0 ```

Group by namespaces

```sh

kubectl-view-allocations -g namespace

Resource Requested Limit Allocatable Free cpu (10%) 200.0m _ 2.0 1.8 └─ kube-system 200.0m _ _ _ ephemeral-storage _ _ 99.8G _ memory (2%) 140.0Mi (3%) 170.0Mi 5.8Gi 5.6Gi └─ kube-system 140.0Mi 170.0Mi _ _ pods (5%) 5.0 (5%) 5.0 110.0 105.0 └─ kube-system 5.0 5.0 _ __ ```

Show as csv

In this case value as expanded as float (with 2 decimal)

sh kubectl-view-allocations -o csv Date,Kind,resource,node,pod,Requested,%Requested,Limit,%Limit,Allocatable,Free 2020-08-19T19:12:48.326605746+00:00,resource,cpu,,,59.94,22%,106.10,39%,272.00,165.90 2020-08-19T19:12:48.326605746+00:00,node,cpu,node-gpu1,,2.31,19%,4.47,37%,12.00,7.53 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu1,yyy-b8bd56fbd-5x8vq,1.00,,2.00,,, 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu1,kube-flannel-ds-amd64-7dz9z,0.10,,0.10,,, 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu1,node-exporter-gpu-b4w7s,0.11,,0.22,,, 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu1,xxx-backend-7d84544458-46qnh,1.00,,2.00,,, 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu1,weave-scope-agent-bbdnz,0.10,,0.15,,, 2020-08-19T19:12:48.326605746+00:00,node,cpu,node-gpu2,,0.31,1%,0.47,2%,24.00,23.53 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu2,kube-flannel-ds-amd64-b5b4v,0.10,,0.10,,, 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu2,node-exporter-gpu-796jz,0.11,,0.22,,, 2020-08-19T19:12:48.326605746+00:00,pod,cpu,node-gpu2,weave-scope-agent-8rhnd,0.10,,0.15,,, 2020-08-19T19:12:48.326605746+00:00,node,cpu,node-gpu3,,3.41,11%,6.67,21%,32.00,25.33 ...

It can be combined with "group-by" options.

sh kubectl-view-allocations -g resource -o csv Date,Kind,resource,Requested,%Requested,Limit,%Limit,Allocatable,Free 2020-08-19T19:11:49.630864028+00:00,resource,cpu,59.94,22%,106.10,39%,272.00,165.90 2020-08-19T19:11:49.630864028+00:00,resource,ephemeral-storage,0.00,0%,0.00,0%,34462898618662.00,34462898618662.00 2020-08-19T19:11:49.630864028+00:00,resource,hugepages-1Gi,0.00,,0.00,,, 2020-08-19T19:11:49.630864028+00:00,resource,hugepages-2Mi,0.00,,0.00,,, 2020-08-19T19:11:49.630864028+00:00,resource,memory,69063409664.00,10%,224684670976.00,31%,722318667776.00,497633996800.00 2020-08-19T19:11:49.630864028+00:00,resource,nvidia.com/gpu,3.00,27%,3.00,27%,11.00,8.00 2020-08-19T19:11:49.630864028+00:00,resource,pods,0.00,0%,0.00,0%,1540.00,1540.00

Alternatives & Similars

• see the discussion Need simple kubectl command to see cluster resource usage · Issue #17512 · kubernetes/kubernetes
• For CPU & Memory only
  • robscott/kube-capacity: A simple CLI that provides an overview of the resource requests, limits, and utilization in a Kubernetes cluster,
  • hjacobs/kube-resource-report: Report Kubernetes cluster and pod resource requests vs usage and generate static HTML
  • etopeter/kubectl-view-utilization: kubectl plugin to show cluster CPU and Memory requests utilization
• For CPU & Memory utilization only
  • kubectl top pods
  • LeastAuthority/kubetop: A top(1)-like tool for Kubernetes.