kubernetes-sigs/cluster-api

Improve validation in Cluster.spec.topology

Open

#8,721 opened on May 23, 2023

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Go (1,532 forks)auto 404
area/clusterclasshelp wantedkind/featurepriority/important-longtermtriage/accepted

Repository metrics

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

Description

What would you like to be added (User Story)?

I think it would be good if we can go over Cluster.spec.topology and check if we have validation for all fields where it is appropriate.

Some examples:

  • MachineHealthCheckTopology: we should have validation that if enable is set to false no MachineHealthCheckClass fields should be set
  • MachineDeploymentStrategy: fields from MachineRollingUpdateDeployment should only be allowed to be set if Type is RollingUpdate
    • The same check is missing in the MD webhook

We should in general check if there is any validation that we either have only in Cluster.spec.topology or the corresponding webhook of the core type (MD/MHC) and make sure they are sync.

This way we can avoid that the Cluster topology controller is creating MD/MHC objects which are already invalid based on their webhook

Detailed Description

Anything else you would like to add?

No response

Label(s) to be applied

/kind feature One or more /area label. See https://github.com/kubernetes-sigs/cluster-api/labels?q=area for the list of labels.

Contributor guide

Research direction
Review existing validation in Cluster.spec.topology and corresponding webhooks for MachineDeployment and MachineHealthCheck, identify missing validations, and add them to ensure consistency.
Tech stack
go
Domain
backendinfrastructure
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
GoKubernetesCluster API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60