kubernetes-sigs/cluster-api

Paused behaviour is inconsistent

Open

#6,966 opened on Jul 21, 2022

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

Repository metrics

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

Description

What steps did you take and what happened:

In a MachineDeployment: In the predicates we check cluster.Spec.Paused or the MachineDeployment has the annotation. We ignore MachineDeployment.Spec.Paused https://github.com/kubernetes-sigs/cluster-api/blob/main/internal/controllers/machinedeployment/machinedeployment_controller.go#L75-L97.

Then in the reconciling logic we first check the cluster.Spec.Paused or the MachineDeployment has the annotation. We ignore We ignore MachineDeployment.Spec.Paused https://github.com/kubernetes-sigs/cluster-api/blob/main/internal/controllers/machinedeployment/machinedeployment_controller.go#L126-L130

Then lines below we check only the MachineDeployment.Spec.Paused. We ignore cluster.Spec.Paused or the MachineDeployment has the annotation. https://github.com/kubernetes-sigs/cluster-api/blob/main/internal/controllers/machinedeployment/machinedeployment_controller.go#L225-L227

What did you expect to happen: Always honour .spec.paused and fallback to the annotation for backward compatibility. Introduce .spec.paused in MachineSets. Review all CRDs to make the above consistent.

Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]

Environment:

  • Cluster-api version:
  • minikube/kind version:
  • Kubernetes version: (use kubectl version):
  • OS (e.g. from /etc/os-release):

/kind bug [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
Trace the paused logic in machinedeployment controller.go, specifically the predicates and reconciling logic. Identify where MachineDeployment.Spec.Paused is ignored and ensure it is consistently checked alongside Cluster.Spec.Paused and annotations. Also review MachineSet for similar inconsistencies.
Tech stack
go
Domain
backendinfrastructure
Issue type
Bug
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
GoKubernetes controllers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35