kubernetes-sigs/cluster-api

Improve troubleshooting guide for Cluster API

Offen

#7.382 geöffnet am 10.10.2022

Auf GitHub ansehenContributor Guide
 (12 Kommentare) (2 Reaktionen) (1 zugewiesene Person)Go (1.532 Forks)auto 404
help wantedkind/cleanupkind/documentationpriority/backlogtriage/accepted

Repository-Metriken

Stars
 (4.267 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Identifizieren Sie häufige Fehlerbehebungsszenarien in Cluster API, indem Sie bestehende Issues und Dokumentation überprüfen. Organisieren Sie dann die Schritte in einem logischen Leitfaden.
Tech Stack
go
Domain
infrastructure
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
KubernetesCluster API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65