Replicated Troubleshoot is a CLI tool that provides pre-installation cluster conformance testing and validation (preflight checks) and post-installation troubleshooting and diagnostics (support bundles).
Preflight checks are an easy-to-run set of conformance tests that can be written to verify that specific requirements in a cluster are met.
To run a sample preflight check from a sample application, install the preflight kubectl plugin and run:
kubectl preflight https://preflight.replicated.comFor a full description of the supported preflight checks, visit the docs.
A support bundle is an archive that's created in-cluster, by collecting logs, cluster information and executing various commands. After creating a support bundle, the cluster operator will normally deliver it to the application vendor for analysis and remote debugging.
To collect a sample support bundle, install the troubleshoot kubectl plugin and run:
kubectl support-bundle https://support-bundle.replicated.comTo build the CLI locally, run:
nvm use v20.11.0
make localYou will have a folder call public with the rendered HTML and CSS files for Gatsby.
To preview the documentation locally, run:
make local
make previewYou can open the preview at http://localhost:9000. if you have a following error:
⠙ compile gatsby files
error Command failed with signal "SIGSEGV".try to run make clean first.