kubernetes-sigs/cluster-api

Support showing MachineHealthChecks in `clusterctl describe cluster` output

Open

#7,222 opened on Sep 15, 2022

View on GitHub
 (19 comments) (1 reaction) (1 assignee)Go (1,532 forks)auto 404
area/clusterctlhelp wantedkind/featurepriority/backlogtriage/accepted

Repository metrics

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

Description

User Story

As a user I would like to be able see MachineHealthChecks acting on a cluster in the at-a-glance view generated by clusterctl describe cluster.

Detailed Description

Currently MHCs are not part of the clusterctl describe cluster output. Since MHCs can be uniquely linked to a specific cluster using MachineHealthCheck.Spec.ClusterName it would be nice to also see them in the output.

Anything else you would like to add:

They can be disabled by default and can sit behind a flag like --show-machinehealthchecks, similar to the other flags we currently have: --show-templates, --show-resourcesets, etc.

/kind feature /area clusterctl

Contributor guide

Research direction
Implement the feature by adding MachineHealthCheck objects to the describe cluster output, following the pattern of existing flags like show templates. Parse the flag and include MHCs in the object tree.
Tech stack
go
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70