kubectl-node_resource - GitLite

KO | EN

gitlite — search

#react #llm #golang #go #android #machine-learning #rust #deep-learning #nodejs #java #windows #vue #awesome-list #mcp

kubectl-node_resource

(★ 171)

Query node allocations/utilizations in kubectl

File Explorer

Download Latest Version (.zip)

- - ci.yml
  - dependabot.yml
  - release.yml
- dependabot.yml
- allocation.go
- display_options.go
- root.go
- utilization.go
- alloc-list.png
- alloc-summary.png
- util-json.png
- util-list.png
- - display_options.go
- - json.go
  - json_types.go
- - definitions.go
- - summary.go
- - color.go
  - progress.go
  - spinner.go
- - types.go
  - utils.go
.gitignore
.goreleaser.yaml
.krew.yaml
go.mod
go.sum
LICENSE
main.go
README.md

# Installation Guide

1. Get the code

git clone https://github.com/ahmetb/kubectl-node_resource

Downloads the entire project code from GitHub to your computer.

cd kubectl-node_resource

Moves into the project folder you just downloaded.

2. Go

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kubectl node-resource

`kubectl node-resource` is a kubectl plugin that provides insights into
Kubernetes node resource allocation (based on pod requests) and actual
utilization (based on metrics-server data).

It helps administrators and developers understand how resources are being
consumed across their cluster's nodes and node pools.

<table>
  <thead>
    <tr>
      <th>Node Allocations View</th>
      <th>Node Utilization View</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>
        List only view:
        <img src="img/alloc-list.png" alt="Node Allocations View" width="600">
        <br/>
        Summary-only view:
        <img src="img/alloc-summary.png" alt="Node Allocations Summary" width="600">
      </td>
      <td>
        List with summary view:
        <img src="img/util-list.png" alt="Node Utilization View" width="600">
        <br/>
        Structured output:
        <img src="img/util-json.png" alt="Node Utilization JSON output" width="600">
      </td>
    </tr>
  </tbody>
</table>

## Installation

If you have [Krew](https://krew.sigs.k8s.io/) installed, you can install
`node-resource` with the following command:

```bash
kubectl krew install node-resource
```

## Features

- **Summary View**: Provides a summary view with histograms and distribution
buckets for resource allocation and utilization.
- **Structured JSON Output**: Supports JSON output (with `--json`) for easy
integration with other tools and scripts.
- **Fast Pod Querying**:
Utilizes optimized and parallel pod querying from the API server's watch cache
for the `allocation` command. Works well with large clusters.
- **Color Output**: Uses color-coded output in the terminal to visually indicate
resource pressure on each node.
- **Flexible Sorting and Filtering**: Sort nodes by CPU/memory usage percentage.
- **Free Resource Display**: In addition to showing used resources, it can also display
  the free resources (`--show-free`) on each node.
- **Selective Resource Display**: Allows users to choose which resources (CPU,
  Memory, Ephemeral Storage, Host Ports) are displayed in the output using flags
  like `--show-cpu`, `--show-memory`, `--show-gpu`, `--show-ephemeral-storage`,
  `--show-pod-count`, and `--show-host-ports`.

## Usage

This plugin offers two main subcommands:

- [**`utilization`**](#utilization-subcommand): Show actual resource utilization
  on nodes.
- [**`allocation`**](#allocation-subcommand): Show pod resource allocations on
  nodes.

### `allocation` subcommand

Displays the resource allocation on nodes based on the sum of pod resource
requests. It shows each node's allocatable CPU and memory, the sum of CPU and
memory requests from pods running on them, and the percentage of allocatable
resources requested.

**Examples:**

<table>
  <thead>
    <tr>
      <th>Usage</th>
      <th>Command</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Show allocation for all nodes, sorted by CPU percentage (default sort).</td>
      <td><pre>kubectl node-resource allocation</pre></td>
    </tr>
    <tr>
      <td>Show allocation for nodes with the label <code>role=worker</code>, and also display host ports used by containers on these nodes.</td>
      <td><pre>kubectl node-resource allocation "role=worker" \
	--show-host-ports</pre></td>
    </tr>
    <tr>
      <td>Show only the summary of allocation for nodes matching the label <code>pool=high-memory</code>, hiding the detailed table.</td>
      <td><pre>kubectl node-resource allocation "pool=high-memory" \
	--summary=only</pre></td>
    </tr>
    <tr>
      <td>Show allocation for a specific node named <code>node1</code>, sorted by memory percentage, and include free (allocatable - requested) resources.</td>
      <td><pre>kubectl node-resource allocation \
      "kubernetes.io/hostname=node1" \
	--sort-by=mem-percent \
	--show-free</pre></td>
    </tr>
  </tbody>
</table>

#### Resource Display Flags

Both `allocation` and `utilization` commands support flags to control which resource details are displayed:

- `--show-cpu`: (Default: `true`) Show CPU related information (allocatable, requested/used, percentage).
- `--show-memory`: (Default: `true`) Show Memory related information (allocatable, requested/used, percentage).

The `allocation` command additionally supports:

- `--show-pod-count`: (Default: `false`) Show number of Pods on each node and Pod count limits.
- `--show-host-ports`: (Default: `false`) Show host ports used by containers on each node.
- `--show-ephemeral-storage`: (Default: `false`) Show ephemeral storage allocation details.
- `--show-gpu`: (Default: `false`) Show GPU allocation details.
- `--gpu-resource-key`: (Default: `"nvidia.com/gpu"`) Specify the resource key for GPU counting (e.g., `amd.com/gpu`).

These flags allow you to tailor the output to focus on the specific resources you are interested in. For example, to see only memory, ephemeral storage, and GPU (using the default key) for allocations:
```bash
kubectl node-resource allocation --show-cpu=false --show-memory --show-ephemeral-storage --show-gpu
```

For example, to show AMD GPUs, run:
```bash
kubectl node-resource allocation --show-gpu --gpu-resource-key=amd.com/gpu
```

### `utilization` subcommand

Displays the actual resource utilization of nodes, similar to `kubectl top
node`. It shows each node's allocatable CPU and memory, the actual CPU and
memory currently used, and the percentage of allocatable resources utilized.
This command requires the Kubernetes [metrics-server] to be installed and running
in the cluster.

[metrics-server]: https://github.com/kubernetes-sigs/metrics-server

**Examples:**

<table>
  <thead>
    <tr>
      <th>Usage</th>
      <th>Command</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Show utilization for all nodes, sorted by CPU percentage (default sort).</td>
      <td><pre>kubectl node-resource utilization</pre></td>
    </tr>
    <tr>
      <td>Show utilization for nodes with the label <code>role=worker</code>.</td>
      <td><pre>kubectl node-resource utilization "role=worker"</pre></td>
    </tr>
    <tr>
      <td>Show utilization and include a column for free (allocatable - used) resources.</td>
      <td><pre>kubectl node-resource utilization \
	--show-free</pre></td>
    </tr>
    <tr>
      <td>Show utilization for all nodes, sorted by memory percentage, and output in JSON format.</td>
      <td><pre>kubectl node-resource utilization \
	--sort-by=mem-percent \
	--json</pre></td>
    </tr>
  </tbody>
</table>

## License

This project is licensed under the Apache 2.0 License. See the
[LICENSE](LICENSE).