docs

Documentation

These guides cover how to use Klustr day to day. They are rendered from the markdown in the site repository, so the GitHub copy and this site never drift apart.

getting around

Getting started

Connect to a context, choose namespaces and browse production safely in read-only mode.

Multi-context & aggregated mode

View two or more clusters as one, save named groups and tag contexts with a color stripe.

connecting

Credential helpers (aws-vault & friends)

Make aws-vault and other exec plugins work when Klustr is launched from the Dock or Finder.

working with resources

Cluster & workloads overviews

Capacity donuts, workload health bars and the recent-events feed.

Workloads & debugging

Logs, exec, debug containers, port-forward, node shell, drain, events and pod diagnosis.

Terminal

The built-in shell drawer, copy and paste rules, and launching an external terminal.

Helm

Browse releases and run install, upgrade, rollback and uninstall with a dry-run first.

GitOps: Argo CD & Flux

Argo CD and Flux: sync, refresh, reconcile and suspend through the Kubernetes API.

Tekton Pipelines

PipelineRuns with their task table, TaskRun step logs, and cancel and rerun without tkn.

Gateway API

Gateways, routes, ListenerSets and how to read route status when something is rejected.

Kyverno & policy reports

Kyverno policies and exceptions, policy reports, and which resources each policy flags.

Cilium

Cilium network policies, endpoints, nodes, IP pools and BGP configuration as Cilium reports them.

Platform integrations: cert-manager, Istio, Karpenter & KEDA

cert-manager, Istio, Karpenter and KEDA views that appear when their CRDs are present.

Custom Resources (CRDs)

How CRDs are auto-discovered, the generic browser and the promoted typed integrations.

Found a mistake? The guides live under docs/guide in the site repository; a pull request fixes both copies at once.