# KubeStacks

> KubeStacks is a fast, calm Kubernetes app. Run it on your desktop against every cluster in your kubeconfig, or in your cluster as a dashboard your whole team signs in to.

- [Your clusters, at a glance](https://docs.kubestacks.com/index.md): KubeStacks is a calm, fast Kubernetes app. It shows what's healthy, what's struggling and where your capacity goes, and lets you fix things safely when they need it.
- [Install the desktop app](https://docs.kubestacks.com/get-started/desktop.md): Download KubeStacks for macOS, Windows or Linux, and open your first cluster in under a minute.
- [Run KubeStacks in your cluster](https://docs.kubestacks.com/get-started/in-your-cluster.md): Install KubeStacks with one Helm chart, and give your team a dashboard they open in a browser and sign in to with their own permissions.
- [A quick tour](https://docs.kubestacks.com/get-started/tour.md): Five minutes through the ideas KubeStacks is built on: problems first, details next to the list, and every change shown before it's made.
- [Signing in to your team's KubeStacks](https://docs.kubestacks.com/get-started/sign-in.md): Your team runs KubeStacks in its cluster? Open the link, sign in, and you see and change what your own account may. There's nothing to install.
- [Connect your clusters](https://docs.kubestacks.com/clusters/connect.md): KubeStacks reads clusters from your kubeconfig, the way kubectl does, and tells you whether each one is reachable and why not.
- [Namespaces](https://docs.kubestacks.com/clusters/namespaces.md): One namespace menu scopes every list, and each cluster remembers your choice.
- [Permissions](https://docs.kubestacks.com/clusters/permissions.md): KubeStacks does what your own RBAC allows, and nothing more. Here's what each feature needs.
- [Overview](https://docs.kubestacks.com/explore/overview.md): A cluster's health and capacity on one page: what's running, what needs attention, and where CPU and memory go.
- [Workloads](https://docs.kubestacks.com/explore/workloads.md): Every Deployment, StatefulSet, DaemonSet, Job and CronJob in one list, with the ones in trouble first.
- [Pods](https://docs.kubestacks.com/explore/pods.md): Every pod, its status and restarts, with the failing ones first, and everything about each one a click away.
- [Nodes](https://docs.kubestacks.com/explore/nodes.md): Every node's health and load, what runs on it, and safe ways to take it out of service.
- [Networking](https://docs.kubestacks.com/explore/networking.md): Services, ingresses and network policies: how traffic reaches your pods, and what's allowed to talk to what.
- [Config and storage](https://docs.kubestacks.com/explore/config-and-storage.md): ConfigMaps and Secrets, and the volumes, claims and storage classes your workloads keep their data on.
- [Events](https://docs.kubestacks.com/explore/events.md): What happened in the cluster, newest first, with a link from each event to the object it's about.
- [Object details](https://docs.kubestacks.com/explore/details.md): The detail panel opens next to the list with the facts that matter for each kind, its pods, logs, events and YAML.
- [Health and status](https://docs.kubestacks.com/explore/health.md): How KubeStacks decides whether something is healthy, and what every status means.
- [Finding things](https://docs.kubestacks.com/explore/finding-things.md): Jump anywhere with the command palette, and narrow any list by health, text or labels.
- [Changing things safely](https://docs.kubestacks.com/changes/safely.md): The guard rails around every change KubeStacks makes: permissions up front, the kubectl command shown, dry runs, typed confirmations and undo.
- [Actions by kind](https://docs.kubestacks.com/changes/actions.md): Everything KubeStacks can do to each kind of object, where to find it, and the options each action has.
- [Edit YAML](https://docs.kubestacks.com/changes/yaml.md): Change any object as YAML, like kubectl edit, with the cluster checking your change and showing it as a diff before anything is saved.
- [Create from YAML](https://docs.kubestacks.com/changes/create.md): Create one object or several from YAML, starting from a template or pasted, with the cluster checking all of them before any is created.
- [Several at once](https://docs.kubestacks.com/changes/bulk.md): Pick rows in any list, then restart, cordon, suspend or delete them together, with progress for each object and a retry for any that fail.
- [Read-only mode](https://docs.kubestacks.com/changes/read-only.md): Turn changes off for one cluster, or for all of them, so you can look around without any chance of changing something.
- [Undo and activity](https://docs.kubestacks.com/changes/undo-and-activity.md): Take a change back from its notification, and see every change you made this session, with its kubectl command.
- [Logs](https://docs.kubestacks.com/debug/logs.md): Stream a pod's logs as they're written, or every pod of a workload or service merged in order, then search, filter and download what you see.
- [Shells and debug containers](https://docs.kubestacks.com/debug/shell.md): Open a terminal in any running container, or add a debug container with tools to a pod that has none, distroless included.
- [Port forwarding](https://docs.kubestacks.com/debug/port-forwarding.md): Reach a pod or a service from your own computer on localhost, like kubectl port-forward, and keep track of every forward from the header.
- [Live usage](https://docs.kubestacks.com/metrics/live-usage.md): CPU and memory as they are right now, from metrics-server, set against requests, limits and what your nodes can give.
- [Usage history](https://docs.kubestacks.com/metrics/usage-history.md): Chart what the cluster used over the last 15 minutes to the last week, from the Prometheus or VictoriaMetrics you already run.
- [Helm releases](https://docs.kubestacks.com/helm/releases.md): Every release in the cluster, its values, what it made and every revision, read straight from the cluster without helm.
- [Upgrade, roll back and uninstall](https://docs.kubestacks.com/helm/upgrade-and-rollback.md): Change a release's values or chart, reviewed as a server-side dry run first, roll back to any revision, or uninstall it.
- [Install a chart](https://docs.kubestacks.com/helm/install.md): Find a chart on Artifact Hub, or name one in a repository or registry, and install it after a dry run shows what it makes.
- [Charts on your computer](https://docs.kubestacks.com/helm/local-charts.md): Upgrade or install from the chart you're working on: a folder or a packaged .tgz, checked with helm lint before every review.
- [Custom resources](https://docs.kubestacks.com/custom-resources/overview.md): Every kind the cluster serves, custom resources included, found through discovery and shown with the columns, status and actions that matter.
- [Built-in views](https://docs.kubestacks.com/custom-resources/built-in-views.md): The views KubeStacks ships for popular projects: the columns, status, links and actions each adds to their custom resources.
- [Write a view](https://docs.kubestacks.com/custom-resources/write-a-view.md): Give your own custom resources useful columns, a real status, related objects and one-click actions, in a short YAML file.
- [KubeStacks in your cluster](https://docs.kubestacks.com/server/overview.md): Serve KubeStacks from your cluster as a web dashboard: your team opens a link, signs in, and sees and changes what their own RBAC allows.
- [Install KubeStacks in your cluster](https://docs.kubestacks.com/server/install.md): Install KubeStacks with its Helm chart, open it, and sign in with a token, in a few minutes.
- [Give KubeStacks an address](https://docs.kubestacks.com/server/expose.md): Put KubeStacks behind an ingress with TLS, at a host of its own or below a path, and keep its WebSocket open.
- [Upgrade KubeStacks in your cluster](https://docs.kubestacks.com/server/upgrade.md): Move to a new version of KubeStacks by upgrading its Helm chart, and roll back if you need to.
- [Sign in with a token](https://docs.kubestacks.com/server/auth/tokens.md): The default way to sign in: people paste a bearer token the cluster accepts, and every request they make carries it.
- [Sign in with single sign-on](https://docs.kubestacks.com/server/auth/single-sign-on.md): Let people sign in with your OpenID Connect provider, such as Dex, Keycloak, Okta, Entra ID, Google or GitLab, so their own RBAC applies.
- [Sign in through an authenticating proxy](https://docs.kubestacks.com/server/auth/proxy.md): Put KubeStacks behind a proxy like oauth2-proxy or Pomerium, which signs people in and names them in request headers.
- [Security in your cluster](https://docs.kubestacks.com/server/security.md): What KubeStacks can do when it runs in your cluster, what it never does, and how to keep it contained.
- [Views for everyone](https://docs.kubestacks.com/server/views.md): Give the custom resources your team uses better columns, statuses, links and actions, for everyone who signs in.
- [Run it without Kubernetes](https://docs.kubestacks.com/server/docker.md): Run the KubeStacks image anywhere containers run, showing one cluster from a kubeconfig.
- [Helm values](https://docs.kubestacks.com/server/helm-values.md): Every setting of the KubeStacks Helm chart, its default, and what it does.
- [Server configuration](https://docs.kubestacks.com/server/configuration.md): The environment variables KubeStacks reads when it runs as a server, and the addresses it answers.
- [Keyboard shortcuts](https://docs.kubestacks.com/reference/keyboard-shortcuts.md): Every view is a keystroke away. Here is every shortcut KubeStacks knows, grouped by where you use it.
- [View format](https://docs.kubestacks.com/reference/view-format.md): Every field a KubeStacks view can have: kinds, columns, status rules, details, links and actions, with the paths, conditions and templates they use.
- [Environment variables](https://docs.kubestacks.com/reference/environment-variables.md): Settings the desktop app reads from its environment when it starts, and how to set them on each system.
- [Resource kinds](https://docs.kubestacks.com/reference/resource-kinds.md): The 19 kinds KubeStacks has pages of its own for, what their lists show and what you can do with them, and how it handles every other kind.
- [Privacy and security](https://docs.kubestacks.com/reference/privacy-and-security.md): What KubeStacks connects to, where your credentials stay, and how the desktop app is built to keep them contained.
- [Troubleshooting](https://docs.kubestacks.com/reference/troubleshooting.md): What each error in KubeStacks means, and what to try. Most problems come from the connection to a cluster, and say so.
- [Frequently asked questions](https://docs.kubestacks.com/reference/faq.md): Short answers to what people ask most about KubeStacks.
- [Changelog](https://docs.kubestacks.com/changelog.md): What's new in each version of KubeStacks. The desktop app updates itself; the Helm chart's version is the app's.
- [Build from source and contribute](https://docs.kubestacks.com/reference/build-from-source.md): Build KubeStacks yourself, run it against demo clusters with no Kubernetes needed, and find your way around the code.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.