# Troubleshoot Documentation

> Troubleshoot is an open-source Kubernetes diagnostics tool. It provides preflight checks for cluster validation before application deployment, and support bundle generation for post-installation diagnostics and troubleshooting. Troubleshoot uses collectors to gather cluster data, analyzers to evaluate conditions, and redactors to remove sensitive information.

## Docs

For a complete archive of all documentation pages, see [llms-full.txt](https://troubleshoot.sh/llms-full.txt)

- [using krew](https://troubleshoot.sh/docs/index): Welcome!
- [v1beta3-overview](https://troubleshoot.sh/docs/preflight/v1beta3-overview): Preflight v1beta3 introduces a templated, values-driven approach to authoring Preflight checks.
- [Base requirements](https://troubleshoot.sh/docs/preflight/v1beta3-guide): This guide shows how to author preflight YAML specs in a modular, values-driven style.
- [v1beta2](https://troubleshoot.sh/docs/preflight/v1beta3-migration): This guide walks through converting v1beta2 Preflight specs to v1beta3.
- [introduction](https://troubleshoot.sh/docs/preflight/introduction): This tutorial will walk you through defining a set of Preflight Checks that your customer can execute before installing your application into their Kubernetes cluster.
- [cli-usage](https://troubleshoot.sh/docs/preflight/cli-usage): If you don't have preflight installed, you can check out the [installation guide](https://troubleshoot.sh/docs/#installation).
- [cluster-checks](https://troubleshoot.sh/docs/preflight/cluster-checks): In this step, we'll add a few basic preflight checks to:
- [node-checks](https://troubleshoot.sh/docs/preflight/node-checks): In this step, we'll expand the Preflight Checks we've already added to:
- [exit-codes](https://troubleshoot.sh/docs/preflight/exit-codes): > Introduced in Troubleshoot v0.63.0
- [next-steps](https://troubleshoot.sh/docs/preflight/next-steps): Congratulations.
- [introduction](https://troubleshoot.sh/docs/support-bundle/introduction): This tutorial will walk you through defining a Support Bundle that your customer can execute when something isn't working quite right.
- [collecting](https://troubleshoot.sh/docs/support-bundle/collecting): Now that we have the `kubectl` plugin installed, let's collect a support bundle.
- [discover-cluster-specs](https://troubleshoot.sh/docs/support-bundle/discover-cluster-specs): > Introduced in Troubleshoot v0.47.0.
- [supportbundle](https://troubleshoot.sh/docs/support-bundle/supportbundle): An OpenAPI Schema for this type is published at: [https://github.com/replicatedhq/kots-lint/blob/main/kubernetes_json_schema/schema/troubleshoot/supportbundle-troubleshoot-v1beta2.json](https://github.com/replicatedhq/kots-lint/blob/main/kubernetes_json_schema/schema/troubleshoot/supportbundle-troubleshoot-v1beta2.json).
- [index](https://troubleshoot.sh/docs/collect/index): Every support bundle or preflight check starts with a collect phase.
- [collectors](https://troubleshoot.sh/docs/collect/collectors): Each collector in the `collectors` array is one of the collectors defined in this section.
- [all](https://troubleshoot.sh/docs/collect/all): - [clusterInfo](./cluster-info): collects basic information about the cluster
- [index](https://troubleshoot.sh/docs/analyze/index): Analyzers are YAML specifications that define a set of criteria and operations to run against data collected in a preflight check or support bundle.
- [analyzers](https://troubleshoot.sh/docs/analyze/analyzers): Each analyzer in the `analyzers` array is one of the analyzers defined in this section.
- [outcomes](https://troubleshoot.sh/docs/analyze/outcomes): Analyzer Outcomes are the output of an analyzer and contain up to 4 attributes:
- [index](https://troubleshoot.sh/docs/redact/index): When collecting data from an application and the evironment, it's common that sensitive information will be retrieved.
- [redactors](https://troubleshoot.sh/docs/redact/redactors): Redactors are YAML specifications that define which data to remove when generating a support bundle.
- [built-in](https://troubleshoot.sh/docs/redact/built-in): Automatically enabled is a set of built in redactors...
- [overview](https://troubleshoot.sh/docs/host-collect-analyze/overview): > New in v0.40.0 of Troubleshoot!
- [all](https://troubleshoot.sh/docs/host-collect-analyze/all): - [cpu](./cpu): Collects and analyzes information about the number of CPU cores.