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 and run:
kubectl preflight https://preflight.replicated.com
For a full description of the supported preflight checks, visit the docs.
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 and run:
kubectl support-bundle https://troubleshoot.replicated.com
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
analyze
command
|
|
|
collector
command
|
|
|
manager
command
|
|
|
preflight
command
|
|
|
troubleshoot
command
|
|
|
config
|
|
|
pkg
|
|
|
apis
Package apis contains Kubernetes API groups.
|
Package apis contains Kubernetes API groups. |
|
apis/troubleshoot
Package troubleshoot contains troubleshoot API versions
|
Package troubleshoot contains troubleshoot API versions |
|
apis/troubleshoot/v1beta1
Package v1beta1 contains API Schema definitions for the troubleshoot v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot +k8s:defaulter-gen=TypeMeta +groupName=troubleshoot.replicated.com Package v1beta1 contains API Schema definitions for the troubleshoot v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot +k8s:defaulter-gen=TypeMeta +groupName=troubleshoot.replicated.com
|
Package v1beta1 contains API Schema definitions for the troubleshoot v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot +k8s:defaulter-gen=TypeMeta +groupName=troubleshoot.replicated.com Package v1beta1 contains API Schema definitions for the troubleshoot v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot +k8s:defaulter-gen=TypeMeta +groupName=troubleshoot.replicated.com |
|
client/troubleshootclientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/troubleshootclientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/troubleshootclientset/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/troubleshootclientset/typed/troubleshoot/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/troubleshootclientset/typed/troubleshoot/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |