kubernetes-sigs/cluster-api

How to surfacing runtime hook blocking cluster deletion in condition

Open

#6,807 opened on Jul 2, 2022

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

Repository metrics

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

Description

Details:

This issue is to discuss how to surface that a cluster deletion is blocked when the BeforeClusterDelete hook blocks the deletion of a process with a blocking response.

We have 2 options:

  1. Use TopologyReconciled condition - Since only managed clusters are affected by BeforeClusterDelete hook we can use the TopologyReconciled condition to surface if a cluster deletion is blocked. Reason will be LifecycleHookBlocking. This will be consistent with how the other lifecycle hook blocking cases are surfaced.

  2. Use a separate condition - Since TopologyReconciled condition reflects if the underlying objects reflect the topology spec of the cluster using it for delete might be deviating from it purpose.

Some additional concerns:

  • How should the condition be updated after deletion is unblocked and the cluster is in the process of deleting the objects?
  • Which controller owns this condition?

/area runtime-sdk

Contributor guide

Research direction
Examine the existing TopologyReconciled condition and the BeforeClusterDelete hook to decide on the best approach for surfacing blocking cluster deletion. Consider the two options: using TopologyReconciled condition with LifecycleHookBlocking reason, or a separate condition. Also address concerns about updating the condition after deletion is unblocked and which controller owns it.
Tech stack
go
Domain
apibackenddevops
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
KubernetesCluster API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30