https://github.com/replicatedhq/troubleshoot.sh
https://github.com/replicatedhq/troubleshoot.sh
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/replicatedhq/troubleshoot.sh
- Owner: replicatedhq
- Created: 2019-10-25T18:58:28.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T23:21:36.000Z (7 months ago)
- Last Synced: 2024-12-02T00:25:27.546Z (7 months ago)
- Language: JavaScript
- Size: 11.4 MB
- Stars: 29
- Watchers: 24
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Replicated Troubleshoot
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
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](https://help.replicated.com/docs/troubleshoot/kubernetes/preflight/executing/) and run:
```shell
kubectl preflight https://preflight.replicated.com
```
For a full description of the supported preflight checks, visit the [docs](https://help.replicated.com/docs/troubleshoot/kubernetes/analysis/).
## Support Bundle
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](https://help.replicated.com/docs/troubleshoot/kubernetes/support-bundle/collecting/) and run:
```shell
kubectl support-bundle https://support-bundle.replicated.com
```
## Local Development
To build the CLI locally, run:
```shell
nvm use v20.11.0
make local
```
You will have a folder call `public` with the rendered HTML and CSS files for Gatsby.
## Previewing Documentation
To preview the documentation locally, run:
```shell
make local
make preview
```
You can open the preview at http://localhost:9000.
if you have a following error:
```shell
⠙ compile gatsby files
error Command failed with signal "SIGSEGV".
```
try to run `make clean` first.