kubernetes-sigs / kubernetes-sigs/cluster-api
Improve troubleshooting guide for Cluster API
Open
help wanted
kind/cleanup
kind/documentation
priority/backlog
triage/accepted
- Dominant language
- Go
- Stars
- 4.3k
- Forks
- 1.6k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 113
Description
The CAPI book currently has a troubleshooting page with a guide focused on the Quick Start.
https://cluster-api.sigs.k8s.io/user/troubleshooting.html
It would be great to have a more fully featured troubleshooting guide that takes users through the process of troubleshooting issues in Cluster API. Steps could, for example, include - looking at clusterctl describe, looking at conditions, reviewing the logs etc.
The idea is that this would form a set of steps which would be a go-to for users trying to deal with a non-working cluster.
/area book
/kind cleanup
Contributor guide
Assessment
This issue has not been assessed yet.