Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/awslabs/eks-node-viewer
EKS Node Viewer
https://github.com/awslabs/eks-node-viewer
Last synced: about 2 months ago
JSON representation
EKS Node Viewer
- Host: GitHub
- URL: https://github.com/awslabs/eks-node-viewer
- Owner: awslabs
- License: apache-2.0
- Created: 2022-12-07T19:23:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T19:11:15.000Z (4 months ago)
- Last Synced: 2024-05-21T12:41:15.429Z (4 months ago)
- Language: Go
- Homepage:
- Size: 22.4 MB
- Stars: 1,023
- Watchers: 17
- Forks: 82
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-tuis - eks-node-viewer
- awesome-repositories - awslabs/eks-node-viewer - EKS Node Viewer (Go)
- charm-in-the-wild - eks-node-viewer - A tool for visualizing dynamic node usage within an EKS cluster. (_built with Bubble Tea_) (Applications / Cloud and DevOps)
README
[](https://github.com/awslabs/eks-node-viewer/blob/main/LICENSE)
[](https://github.com/awslabs/eks-node-viewer/issues)
[](https://github.com/awslabs/eks-node-viewer/actions/workflows/test.yaml)
## Usage
`eks-node-viewer` is a tool for visualizing dynamic node usage within a cluster. It was originally developed as an internal tool at AWS for demonstrating consolidation with [Karpenter](https://karpenter.sh/). It displays the scheduled pod resource requests vs the allocatable capacity on the node. It *does not* look at the actual pod resource usage.
### Talks Using eks-node-viewer
- [Containers from the Couch: Workload Consolidation with Karpenter](https://www.youtube.com/watch?v=BnksdJ3oOEs)
- [AWS re:Invent 2022 - Kubernetes virtually anywhere, for everyone](https://www.youtube.com/watch?v=OB7IZolZk78)
### Installation
#### Homebrew
```bash
brew tap aws/tap
brew install eks-node-viewer
```
#### Manual
Please either fetch the latest [release](https://github.com/awslabs/eks-node-viewer/releases) or install manually using:
```shell
go install github.com/awslabs/eks-node-viewer/cmd/eks-node-viewer@latest
```
Note: This will install it to your `GOBIN` directory, typically `~/go/bin` if it is unconfigured.
## Usage
```shell
Usage of ./eks-node-viewer:
-attribution
Show the Open Source Attribution
-context string
Name of the kubernetes context to use
-disable-pricing
Disable pricing lookups
-extra-labels string
A comma separated set of extra node labels to display
-kubeconfig string
Absolute path to the kubeconfig file (default "~/.kube/config")
-node-selector string
Node label selector used to filter nodes, if empty all nodes are selected
-node-sort string
Sort order for the nodes, either 'creation' or a label name. The sort order can be controlled by appending =asc or =dsc to the value. (default "creation")
-resources string
List of comma separated resources to monitor (default "cpu")
-style string
Three color to use for styling 'good','ok' and 'bad' values. These are also used in the gradients displayed from bad -> good. (default "#04B575,#FFFF00,#FF0000")
-v Display eks-node-viewer version
-version
Display eks-node-viewer version
```
### Examples
```shell
# Standard usage
eks-node-viewer
# Karpenter nodes only
eks-node-viewer --node-selector karpenter.sh/nodepool
# Display both CPU and Memory Usage
eks-node-viewer --resources cpu,memory
# Display extra labels, i.e. AZ
eks-node-viewer --extra-labels topology.kubernetes.io/zone
# Sort by CPU usage in descending order
eks-node-viewer --node-sort=eks-node-viewer/node-cpu-usage=dsc
# Specify a particular AWS profile and region
AWS_PROFILE=myprofile AWS_REGION=us-west-2
```
### Computed Labels
`eks-node-viewer` supports some custom label names that can be passed to the `--extra-labels` to display additional node information.
- `eks-node-viewer/node-age` - Age of the node
- `eks-node-viewer/node-cpu-usage` - CPU usage (requests)
- `eks-node-viewer/node-memory-usage` - Memory usage (requests)
- `eks-node-viewer/node-pods-usage` - Pod usage (requests)
- `eks-node-viewer/node-ephemeral-storage-usage` - Ephemeral Storage usage (requests)
### Default Options
You can supply default options to `eks-node-viewer` by creating a file named `.eks-node-viewer` in your home directory and specifying
options there. The format is `option-name=value` where the option names are the command line flags:
```text
# select only Karpenter managed nodes
node-selector=karpenter.sh/nodepool
# display both CPU and memory
resources=cpu,memory
# show the zone and nodepool name by default
extra-labels=topology.kubernetes.io/zone,karpenter.sh/nodepool
# sort so that the newest nodes are first
node-sort=creation=asc
```
### Troubleshooting
#### NoCredentialProviders: no valid providers in chain. Deprecated.
This CLI relies on AWS credentials to access pricing data if you don't use the `--disable-pricing` option. You must have credentials configured via `~/aws/credentials`, `~/.aws/config`, environment variables, or some other credential provider chain.
See [credential provider documentation](https://docs.aws.amazon.com/sdk-for-go/api/aws/session/) for more.
#### I get an error of `creating client, exec plugin: invalid apiVersion "client.authentication.k8s.io/v1alpha1"`
Updating your AWS cli to the latest version and [updating your kubeconfig](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) should resolve this issue.
## Development
### Building
```shell
$ make build
```
Or local execution of GoReleaser build:
```shell
$ make goreleaser
```