kubernetes-sigs/cluster-api

Improve troubleshooting guide for Cluster API

Ouverte

#7 382 ouverte le 10 oct. 2022

Voir sur GitHubGuide contributeur
 (12 commentaires) (2 réactions) (1 personne assignée)Go (1 532 forks)auto 404
help wantedkind/cleanupkind/documentationpriority/backlogtriage/accepted

Métriques du dépôt

Stars
 (4 267 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Identifiez les scénarios de dépannage courants dans Cluster API en examinant les problèmes et la documentation existants. Organisez ensuite les étapes dans un guide logique.
Stack technique
go
Domaine
infrastructure
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
KubernetesCluster API
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65