https://github.com/doucol/clyde
Project Calico Observability Tools
https://github.com/doucol/clyde
calico k8s kubernetes networking observability projectcalico security tigera
Last synced: 5 months ago
JSON representation
Project Calico Observability Tools
- Host: GitHub
- URL: https://github.com/doucol/clyde
- Owner: doucol
- License: apache-2.0
- Created: 2025-02-08T16:42:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-06T16:00:30.000Z (11 months ago)
- Last Synced: 2025-08-06T17:46:28.324Z (11 months ago)
- Topics: calico, k8s, kubernetes, networking, observability, projectcalico, security, tigera
- Language: Go
- Homepage:
- Size: 368 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clyde
[Project Calico](https://projectcalico.org)
([GitHub](https://github.com/projectcalico/calico)) Observability Tools
> NOTE: this app requires a Calico OSS 3.30+ cluster with [Whisker
> enabled](https://docs.tigera.io/calico/latest/observability/enable-whisker).
> This terminal based UI is supplemental to the [Whisker
> UI](https://docs.tigera.io/calico/latest/observability/view-flow-logs#calico-whisker)
> as it aggregates and calculates rates for flows between source (SRC) and
> destination (DST).
This CLI/TUI application currently allows you to watch & inspect calico network
flows in near real-time.
The first page you will see is a simple summary totals grouped by SRC namespace
and name, DST namespace & name, and protocol:port.
When on the "home" page (Calico Flow Summary Totals), you can press `r` to
see the flow summary rates (packets/bytes per second). Press `t` to go back
to the home summary totals page.
You can move through the rows with standard vim oriented keystrokes
(up: `k`, down: `j`, top: `g`, bottom: `G`, and arrow / page keys)
Sorting: when in the summary totals page you can sort by SRC namespace & name by
pressing the `n` key. Press it again to reverse the sort. When in the summary
rates page you can do the same but you also have the ability to sort by rates.
`p` for source packets/sec and `P` for destination packets/sec. You can do the same
for the bytes/sec using `b` and `B` respectively. Again, pressing the same key
again will reverse the sort.
Dive into details by hitting \ on rows and the \ to back out.
To enable filtering, use the `/` key to show the filter attributes.
## Install
### Homebrew (Mac / Linux)
```bash
brew install doucol/tap/clyde
```
### Manual
Released binaries are available through [GitHub releases](https://github.com/doucol/clyde/releases).
You can choose the release and distribution you need, download the tar.gz/zip file
and extract the `clyde` binary.
> NOTE: while Windows binaries are available, they have not yet been tested!
### Build from source
You will need `make` and `go 1.23+`
```bash
# fork & clone this repository first and then ...
make build
# To see the help
bin/clyde --help
# To run the TUI
bin/clyde
```
### Additionally
You can also use the `bin/calico-on-kind` script to quickly create a
[Kind](https://kind.sigs.k8s.io/) based Kubernetes cluster with Calico OSS installed.
> NOTE: this script does require a newer version of `kubectl`. Tested with `v1.33`
```bash
# To see help
./bin/calico-on-kind
# Example:
# To create a new cluster, install the GCP demo app, and a set of
# zero trust policies.
VERSION=v3.30 DP=BPF DEMOAPP=true ./bin/calico-on-kind new
```
> **_NOTE:_** ARM based machines may have issues to work through with the DEMOAPP,
> since the GCP demo app does not have arm based images published at the time of
> this writing.