# crust-gather | crust-gather | Knowledge Base | Instagit

kubectl debugging plugin to collect full or partial cluster state and serve via an api server. Kubernetes time machine

GitHub Stars: 41

Repository: https://github.com/crust-gather/crust-gather

---

## Articles

### [How Resource Discovery Works in Crust‑Gather for Kubernetes State Collection](/crust-gather/crust-gather/how-does-resource-discovery-work-in-crust-gather-for-collecting-cluster-state)

Discover how Crust-Gather collects Kubernetes cluster state with its three phase discovery mechanism. Learn about probing API endpoints and offline replay.

- Tags: internals
- Published: 2026-02-28

### [How Artifact Serving Works in crust-gather CI/CD Workflows](/crust-gather/crust-gather/how-does-artifact-serving-work-in-crust-gather-ci-cd-workflows)

Learn how crust gather artifact serving works in CI/CD. Capture Kubernetes snapshots as artifacts and serve read-only APIs with Actix-Web for kubectl access to historic cluster states.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Install and Use crust-gather as a kubectl Plugin](/crust-gather/crust-gather/how-to-install-and-use-crust-gather-as-a-kubectl-plugin)

Easily install and use crust-gather as a kubectl plugin to capture Kubernetes cluster snapshots. Follow simple installation steps for effective cluster troubleshooting and debugging.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Optimize crust-gather Collection for Large Kubernetes Clusters: A Complete Guide](/crust-gather/crust-gather/how-to-optimize-crust-gather-collection-for-large-kubernetes-clusters)

Optimize crust-gather collection for large Kubernetes clusters. Learn to use WATCH mode, filters, duration limits, and streaming to prevent memory pressure and API throttling.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Troubleshoot Collection Timeouts in crust-gather](/crust-gather/crust-gather/how-to-troubleshoot-collection-timeouts-in-crust-gather)

Troubleshoot collection timeouts in crust-gather by extending the duration flag or adjusting log timeouts. Resolve Kubernetes API call and log streaming issues effectively with this guide.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Serve Multiple Cluster Snapshots Simultaneously with crust-gather](/crust-gather/crust-gather/how-to-serve-multiple-cluster-snapshots-simultaneously-with-crust-gather)

Learn to serve multiple cluster snapshots simultaneously with crust-gather. Its HTTP API automatically discovers archives and routes requests via URL path segments for concurrent access.

- Tags: how-to-guide
- Published: 2026-02-28

### [Include and Exclude Filters in crust-gather: How Resource Filtering Works](/crust-gather/crust-gather/difference-between-include-and-exclude-filters-in-crust-gather)

Master resource filtering in crust-gather by understanding include and exclude filters. Learn how exclude filters override include filters for precise data collection.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Configure Collection Timeout or Duration in crust-gather](/crust-gather/crust-gather/how-to-configure-collection-timeout-or-duration-in-crust-gather)

Learn to configure the collection timeout or duration in crust-gather. Adjust the default 60-second limit using the --duration flag or programmatically. Optimize your cluster data collection.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Collect Additional Custom Logs Using the --additional-logs Flag in crust-gather](/crust-gather/crust-gather/how-to-collect-additional-custom-logs-using-the-additional-logs-flag-in-crust-gather)

Learn to collect custom logs in crust-gather using the --additional-logs flag. Easily gather arbitrary log files from your Kubernetes cluster nodes with simple FILE:COMMAND syntax.

- Tags: how-to-guide
- Published: 2026-02-28

### [How the Crust-Gather API Server Emulates the Kubernetes API](/crust-gather/crust-gather/how-does-the-crust-gather-api-server-emulate-the-kubernetes-api)

Learn how Crust-gather emulates the Kubernetes API using a lightweight Actix-Web server to serve archived cluster snapshots via REST endpoints and a synthetic kubeconfig for local kubectl access.

- Tags: deep-dive
- Published: 2026-02-28

### [ZIP vs tar.gz in crust-gather: Archive Format Comparison](/crust-gather/crust-gather/comparison-of-archive-formats-zip-vs-tar-gz-for-crust-gather)

Explore ZIP vs tar.gz for crust-gather. Discover which archive format offers random access portability or streaming compression efficiency for your project.

- Tags: comparison
- Published: 2026-02-28

### [How to Use Regex Patterns for Filtering Kubernetes Resources in crust-gather](/crust-gather/crust-gather/how-to-use-regex-patterns-for-filtering-kubernetes-resources-in-crust-gather)

Filter Kubernetes resources using regex patterns in crust gather. Use flags like --include-namespace or --exclude-kind to precisely gather objects and exclude noise.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Collect Kubernetes Node Kubelet Logs with crust-gather](/crust-gather/crust-gather/how-to-collect-kubernetes-node-kubelet-logs-with-crust-gather)

Easily collect Kubernetes node Kubelet logs using crust-gather. Use the additional-logs flag to gather essential log files for faster troubleshooting.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Collect Logs from Kubernetes Pods Using crust-gather: Complete Guide](/crust-gather/crust-gather/how-to-collect-logs-from-kubernetes-pods-using-crust-gather)

Learn to collect logs from Kubernetes pods with crust-gather. This guide details using the crust-gather collect command to snapshot pod logs efficiently via the Kubernetes API.

- Tags: how-to-guide
- Published: 2026-02-28

### [Understanding crust-gather Record Mode: Watching Kubernetes Resource Changes](/crust-gather/crust-gather/understanding-crust-gather-s-record-mode-for-watching-resource-changes)

Learn how crust-gather's Record mode streams Kubernetes resource changes via the watch API, delivering incremental JSON patches for efficient monitoring.

- Tags: deep-dive
- Published: 2026-02-28

### [How to Configure crust-gather Using a ConfigMap](/crust-gather/crust-gather/how-to-configure-crust-gather-using-a-configmap)

Learn to configure crust-gather using a Kubernetes ConfigMap. Easily manage your settings by passing the --config-map flag and override with CLI options.

- Tags: how-to-guide
- Published: 2026-02-28

### [How Crust-Gather Retrieves a Kubeconfig from Kubernetes Secrets: A Deep Dive into the Source Code](/crust-gather/crust-gather/how-does-crust-gather-handle-kubeconfig-retrieval-from-kubernetes-secrets)

Learn how Crust-Gather retrieves kubeconfig from Kubernetes Secrets by examining its source code. Explore secret API querying, base64 decoding, and YAML deserialization.

- Tags: deep-dive
- Published: 2026-02-28

### [How to Run crust-gather in CI/CD Pipelines for Kubernetes Cluster Snapshots](/crust-gather/crust-gather/how-to-run-crust-gather-in-ci-cd-pipelines-for-cluster-state-snapshots)

Integrate crust-gather into your CI CD pipeline to automate Kubernetes cluster snapshots. Archive cluster state in CI and serve read-only debugging APIs with crust-gather serve.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Exclude Kubernetes Secrets from Collected Data with crust-gather](/crust-gather/crust-gather/how-to-exclude-kubernetes-secrets-from-collected-data-with-crust-gather)

Learn how to exclude Kubernetes secrets from collected data with crust-gather. Automatically redact sensitive values and Base64-encoded secrets from cluster dumps before archiving.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Use an OCI Registry as a Storage Backend for Crust-Gather](/crust-gather/crust-gather/how-to-use-oci-registry-as-a-storage-backend-for-crust-gather)

Learn how to use an OCI registry as a storage backend for crust-gather. Easily store and retrieve Kubernetes cluster state by pushing files as layers to your OCI registry.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Serve a Collected Kubernetes Cluster Snapshot with crust-gather serve](/crust-gather/crust-gather/how-to-serve-a-collected-kubernetes-cluster-snapshot-with-crust-gather-serve)

Learn to serve a collected Kubernetes cluster snapshot with crust-gather serve. Expose archived snapshots via REST endpoints for easy kubectl querying without disk extraction.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Filter Collected Kubernetes Resources by Kind in crust-gather](/crust-gather/crust-gather/how-to-filter-collected-kubernetes-resources-by-kind-in-crust-gather)

Filter Kubernetes resources by kind in crust-gather using --include-kind and --exclude-kind flags. Capture or omit resources by exact strings or regex for efficient data collection.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Filter Collected Kubernetes Resources by Namespace in crust-gather](/crust-gather/crust-gather/how-to-filter-collected-kubernetes-resources-by-namespace-in-crust-gather)

Learn to filter Kubernetes resources by namespace in crust-gather using CLI flags or YAML config. Apply regex filters efficiently to your collected data.

- Tags: how-to-guide
- Published: 2026-02-28

### [How to Collect All Kubernetes Cluster Resources Using crust-gather](/crust-gather/crust-gather/how-to-collect-all-kubernetes-cluster-resources-using-crust-gather)

Easily collect all Kubernetes cluster resources with crust-gather. Snapshot every listable resource into a portable archive with optional filtering and secret masking.

- Tags: how-to-guide
- Published: 2026-02-28