kubernetes-sigs/cluster-api

Improve UX of MachineHealthCheckStatus fields

Open

#5,291 opened on Sep 22, 2021

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Go (1,532 forks)auto 404
help wantedkind/api-changekind/featurepriority/important-longtermtriage/accepted

Repository metrics

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

Description

Description

MHC currently has the following columns: MaxUnhealthy, ExpectedMachines, CurrentHealthy. Based on this columns it's a bit hard to grasp what's going on.

The fields have the following semantic (or at least godoc):

  • .spec.maxUnhealthy: Any further remediation is only allowed if at most "MaxUnhealthy" machines selected by "selector" are not healthy.
  • .status.expectedMachines: total number of machines counted by this machine health check
  • .status.currentHealthy: total number of healthy machines counted by this machine health check

A few examples:

  • field name: unhealthy vs healthy (would be easier to have either healthy or unhealthy twice, if possible)
  • expectedMachines: what does expected mean? according to the godoc it's (probably) the number of machines which match the selector
  • currentHealthy: not sure if we need current if it's part of the status (as far as I can see in our other types we're not using the current prefix)

/kind feature

Contributor guide

Research direction
Identify the MachineHealthCheckStatus struct in the codebase, propose new field names, update the struct, JSON tags, and all references. Consult maintainers for final naming decisions.
Tech stack
go
Domain
backenddevops
Issue type
Feature
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.
1-3 hours
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
GoKubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80