Skip to content

⚠️ Add superseded notice to the old condition proposal #11189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions docs/proposals/20200506-conditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,33 @@ reviewers:
- "@ncdc"
creation-date: 2020-05-06
last-updated: 2024-05-03
status: implementable
see-also:
replaces:
superseded-by:
status: replaced
superseded-by: 20240916-improve-status-in-CAPI-resources.md
---

# IMPORTANT! Superseded by [Improve Status in CAPI resources](20240916-improve-status-in-CAPI-resources.md)

This proposal is now superseded by [Improve Status in CAPI resources](20240916-improve-status-in-CAPI-resources.md),
which describes how Cluster API is going to transition to Kubernetes aligned conditions (among other improvements).

The [Improve Status in CAPI resources](20240916-improve-status-in-CAPI-resources.md) proposal is part of the work for
implementing Cluster API v1beta2 APIs, while "legacy" conditions described in this document are used in v1beta1 API version.

The v1beta1 API types, including the "legacy" condition types described in this document are going to be deprecated
when v1beta2 will be released (tentative Apr 2025).

Providers implementing conditions won't be required to do the transition from "legacy" Cluster API Condition type
to Kubernetes `metav1.Conditions` type, but this transition is recommended because it improves the consistency of each provider
with Kubernetes, Cluster API and the ecosystem.

However, providers choosing to keep using Cluster API "legacy" conditions should be aware that starting from the
CAPI release when v1beta1 removal will happen (tentative Apr 2026), the Cluster API project will remove the
Cluster API "legacy" condition types, the "legacy" `util/conditions` package, the code handling "legacy" conditions in
`util/patch.Helper` and everything related to the "legacy" Cluster API `v1beta.Condition` type.

In other words, providers choosing to keep using Cluster API "legacy" conditions should be aware that down the line
they will be required to start managing their own conditions fork/custom implementation.

# Conditions - Cluster status at glance

## Table of Contents
Expand Down Expand Up @@ -557,3 +578,4 @@ NA
- [x] 2020-04-27: Compile a Google Doc following the CAEP template
- [x] 2020-05-06: Create CAEP PR
- [x] 2024-05-03: Edited allowing conditions with negative polarity
- [x] 2024-09-17: Superseded by [Improve Status in CAPI resources](20240916-improve-status-in-CAPI-resources.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ reviewers:
- "@peterochodo"
- "@zjs"
creation-date: 2024-07-17
last-updated: 2024-07-29
last-updated: 2024-09-16
status: implementable
see-also:
- [Proposal about custom Cluster API conditions (superseded by this document)](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20200506-conditions.md)
Expand Down Expand Up @@ -1456,7 +1456,7 @@ Transition from v1beta1 API/contract to v1beta2 contract is detailed in previous

## Implementation History

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