kubernetes-sigs/cluster-api

Improve troubleshooting guide for Cluster API

Open

#7,382 opened on Oct 10, 2022

View on GitHub
 (12 comments) (2 reactions) (1 assignee)Go (1,532 forks)auto 404
help wantedkind/cleanupkind/documentationpriority/backlogtriage/accepted

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Identify common troubleshooting scenarios in Cluster API by reviewing existing issues and documentation. Then organize steps into a logical guide.
Tech stack
go
Domain
infrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KubernetesCluster API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65