Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sysdiglabs/kubectl-dig
Deep kubernetes visibility from the kubectl
https://github.com/sysdiglabs/kubectl-dig
containers kubectl-plugins kubernetes monitoring o11y observability syscalls
Last synced: 4 days ago
JSON representation
Deep kubernetes visibility from the kubectl
- Host: GitHub
- URL: https://github.com/sysdiglabs/kubectl-dig
- Owner: sysdiglabs
- Created: 2019-05-19T22:43:35.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-12-18T21:53:45.000Z (11 months ago)
- Last Synced: 2024-08-02T02:13:30.146Z (3 months ago)
- Topics: containers, kubectl-plugins, kubernetes, monitoring, o11y, observability, syscalls
- Language: Go
- Homepage:
- Size: 13.6 MB
- Stars: 385
- Watchers: 11
- Forks: 15
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-kubectl-plugins - kubectl-dig
- awesome-kubernetes-security - kubectl-dig - Deep Kubernetes visibility from the kubectl (Open Source Projects)
README
# kubectl dig
> Deep kubernetes visibility from the kubectl.
kubectl dig
A simple, intuitive, and fully customizable UI to dig into your kubernetes clusters
```
kubectl dig
```
[](https://asciinema.org/a/czA06tSyEjKpusDooKZe3KQry)
## Install
```bash
go get -u github.com/sysdiglabs/kubectl-dig/cmd/kubectl-dig
```
## Usage
### Just dig
There's only one thing to do, provide the node name!
```
kubectl dig
```
You just identify the node you want to dig in with `kubectl get nodes` and then
provide it to the dig command!
```
kubectl dig ip-180-12-0-152.ec2.internal
```
### dig + cluster metadata
By default, `kubectl dig` shows only information about the local node, if you want to dig from that node to the whole cluster you have to provide a **service account** that can read resources.
You can create a `dig-viewer` service account with:
```bash
kubectl apply -f https://github.com/sysdiglabs/kubectl-dig/raw/develop/docs/setup/read-serviceaccount.yml
```
Then you just use it with `kubectl dig`.
```bash
kubectl dig --serviceaccount dig-viewer 127.0.0.1
```
At this point you have access to the fancy cluster metadata, press `F2` and look for the `K8s` views!
# Project status
## High-level todo
- [x] Basic functionalities;
- [ ] Finish all the planned commands;
- [ ] Merge here the functionalities of [kubectl-capture](https://github.com/sysdiglabs/kubectl-capture);
- [ ] Integration tests;
- [ ] Errors detection on the kernel module;
## Planned commands
- [x] `run` command, to execute digs;
- [ ] `list` command, to list all the executed digs;
- [ ] `attach` command, to attach to an existing dig that was previously detached;
- [ ] `delete` command, to delete an existing dig;
- [ ] `where` command, to execute digs where the chosen workloads are, instead of having to specify the node directly;
---
[](https://github.com/igrigorik/ga-beacon)