Skip to content

Commit 59087fa

Browse files
Add superseded notice to the old condition proposal
1 parent ff79510 commit 59087fa

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

docs/proposals/20200506-conditions.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,33 @@ reviewers:
77
- "@ncdc"
88
creation-date: 2020-05-06
99
last-updated: 2024-05-03
10-
status: implementable
11-
see-also:
12-
replaces:
13-
superseded-by:
10+
status: replaced
11+
superseded-by: 20240916-improve-status-in-CAPI-resources.md
1412
---
1513

14+
# IMPORTANT! Superseded by [ImproveStatus in CAPI resources](20240916-improve-status-in-CAPI-resources.md)
15+
16+
This proposal is now superseded by [ImproveStatus in CAPI resources](20240916-improve-status-in-CAPI-resources.md),
17+
which describes how Cluster API is going to transition to Kubernetes aligned conditions (among other improvements).
18+
19+
The [ImproveStatus in CAPI resources](20240916-improve-status-in-CAPI-resources.md) proposal is part of the work for
20+
implementing Cluster API v1beta2 APIs, while "legacy" conditions described in this document are used in v1beta1 API version.
21+
22+
The v1beta1 API types, including the "legacy" condition types described in this document are going to be deprecated
23+
when v1beta2 will be released (tentative Apr 2025).
24+
25+
Providers implementing conditions won't be required to do the transition from "legacy" Cluster API Condition type
26+
to Kubernetes `metav1.Conditions` type, but this transition is recommended because it improves the consistency of each provider
27+
with Kubernetes, Cluster API and the ecosystem.
28+
29+
However, providers choosing to keep using Cluster API "legacy" conditions should be aware that starting from the
30+
CAPI release when v1beta1 removal will happen (tentative Apr 2026), the Cluster API project will remove the
31+
Cluster API "legacy" condition types, the "legacy" `util/conditions` package, the code handling "legacy" conditions in
32+
`util/patch.Helper` and everything related to the "legacy" Cluster API `v1beta.Condition` type.
33+
34+
In other words, providers choosing to keep using Cluster API "legacy" conditions should be aware that down the line
35+
they will be required to start managing their own conditions fork/custom implementation.
36+
1637
# Conditions - Cluster status at glance
1738

1839
## Table of Contents
@@ -557,3 +578,4 @@ NA
557578
- [x] 2020-04-27: Compile a Google Doc following the CAEP template
558579
- [x] 2020-05-06: Create CAEP PR
559580
- [x] 2024-05-03: Edited allowing conditions with negative polarity
581+
- [x] 2024-09-17: Superseded by [ImproveStatus in CAPI resources](20240916-improve-status-in-CAPI-resources.md)

docs/proposals/improve-status-in-CAPI-resources.md renamed to docs/proposals/20240916-improve-status-in-CAPI-resources.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ reviewers:
1212
- "@peterochodo"
1313
- "@zjs"
1414
creation-date: 2024-07-17
15-
last-updated: 2024-07-29
15+
last-updated: 2024-09-16
1616
status: implementable
1717
see-also:
1818
- [Proposal about custom Cluster API conditions (superseded by this document)](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20200506-conditions.md)
@@ -1456,7 +1456,7 @@ Transition from v1beta1 API/contract to v1beta2 contract is detailed in previous
14561456

14571457
## Implementation History
14581458

1459-
- [x] 07/17/2024: Open proposal PR, still WIP
1460-
- [x] 07/17/2024: Present proposal at a [community meeting](https://www.youtube.com/watch?v=frCg522ZfRQ)
1459+
- [x] 2024-07-17: Open proposal PR, still WIP
1460+
- [x] 2024-07-17: Present proposal at a [community meeting](https://www.youtube.com/watch?v=frCg522ZfRQ)
14611461
- [10000 feet overview](https://docs.google.com/presentation/d/1hhgCufOIuqHz6YR_RUPGo0uTjfm5YafjCb6JHY1_clY/edit?usp=sharing)
1462-
- [x] MM/DD/YYYY: Remove WIP from the proposal PR
1462+
- [x] 2024-09-16: Proposal approved

0 commit comments

Comments
 (0)