https://github.com/crust-gather/crust-gather
kubectl debugging plugin to collect full or partial cluster state and serve via an api server. Kubernetes time machine
https://github.com/crust-gather/crust-gather
api-server asciinema inspect kubectl kubectl-plugin kubernetes oc time-machine
Last synced: 8 months ago
JSON representation
kubectl debugging plugin to collect full or partial cluster state and serve via an api server. Kubernetes time machine
- Host: GitHub
- URL: https://github.com/crust-gather/crust-gather
- Owner: crust-gather
- License: apache-2.0
- Created: 2024-01-03T10:56:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T17:08:12.000Z (8 months ago)
- Last Synced: 2025-02-01T06:31:43.559Z (8 months ago)
- Topics: api-server, asciinema, inspect, kubectl, kubectl-plugin, kubernetes, oc, time-machine
- Language: Rust
- Homepage:
- Size: 588 KB
- Stars: 14
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# crust-gather
## Description
`crust-gather` is a `kubectl` plugin that provides functionality, which allows to collect full or partial cluster state and serve it via an api server.
## Some key features:
- Collect all available resources across the cluster.
- Collect container logs.
- Collect node kubelet logs.
- Resource collection is parallel, with exponential backoff retry and configurable timeout.
- Filter collected resources based on regexes, include/excludes, namespaces, groups or kinds.
- Advanced filters can be specified by CLI flags, configuration files or fetched from `ConfigMap` via `--config-map`.
- Collect snapshot from kubeconfig stored in the cluster via `--kubeconfig-secret-name` or `--kubeconfig-secret-label`.
- Display events in an HTML table with filtering capabilities.
- Store data in a zip/tar.gz archive.
- Hide out secret data, by providing environment keys with values to exclude during processing, or a `secrets` file.
- Browse cluster snapshot with kubectl/k9s, via a local web server.
- Collect cluster snapshot or multiple cluster snapshots in github actions workflow artifact and serve it via `crust-gather serve` ([Demo](#demo-artifact-serving)).
## Demo
[](https://asciinema.org/a/632848)
## Helm charts demo
[](https://asciinema.org/a/AfbGJSUUtAItmQVp2EEC6j2vo)
### Artifact serving
One of the QoL features `crust-gather` provides is an ability to collect cluster snapshots during CI workflow run and serve the content like a k8s cluster after the originating cluster is removed. It can serve any number of clusters simulaniously, each cluster stored under separate context.
Easy to use version of this provided via `nix` shell script, which includes artifact download and crust-gather installation:
```bash
# Requires GITHUB_TOKEN to be set
./serve-artifact.sh --owner rancher-sandbox --repo cluster-api-provider-rke2 --artifact_id 1461387168 &
# alternatively, if you have an artifact link
./serve-artifact.sh -u https://github.com/rancher-sandbox/cluster-api-provider-rke2/actions/runs/8923331571/artifacts/1467008322 &
kubectl get ns
NAME
capd-system
capi-system
...
```
## Prerequisites
Depending on the installation type, there might be needed:
- kubectl + [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/)
- [nix](https://nixos.org/download/)
## Usage
The plugin can be installed with `krew` and used as follows:
```bash
kubectl krew install crust-gather
kubectl crust-gather --help
```
Alternatively, it can be installed standalone via `install.sh` script:
```bash
curl -sSfL https://github.com/crust-gather/crust-gather/raw/main/install.sh | sh
crust-gather --help
```
Or used with `nix`:
```bash
nix-shell -p 'callPackage (fetchGit https://github.com/crust-gather/crust-gather) {}'
kubectl-crust-gather --help
```
## Testing
To run tests locally you need to have `golang` and `kwok` pre-installed. On linux and mac this will be done automatically with the test command:
```bash
make test
```
Alternatively you can pass `GOOS` or `GOARCH` directly to the make task:
```bash
GOOS=linux GOARCH=amd64 make test
```