Skip to content
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.

Sign up for GitHub

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

🐛 Fix the description of ControlPlaneInitializedCondition is misleading #6999

Closed
wants to merge 1 commit into from
+2 −2
Closed

🐛 Fix the description of ControlPlaneInitializedCondition is misleading #6999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion api/v1alpha4/condition_consts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const (

const (
// ControlPlaneInitializedCondition reports if the cluster's control plane has been initialized such that the
// cluster's apiserver is reachable and at least one control plane Machine has a node reference. Once this
// cluster's apiserver is reachable or at least one control plane Machine has a node reference. Once this
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't change v1alpha4

// condition is marked true, its value is never changed. See the ControlPlaneReady condition for an indication of
// the current readiness of the cluster's control plane.
ControlPlaneInitializedCondition ConditionType = "ControlPlaneInitialized"
Expand Down
2 changes: 1 addition & 1 deletion api/v1beta1/condition_consts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const (

const (
// ControlPlaneInitializedCondition reports if the cluster's control plane has been initialized such that the
// cluster's apiserver is reachable and at least one control plane Machine has a node reference. Once this
// cluster's apiserver is reachable or at least one control plane Machine has a node reference. Once this
// condition is marked true, its value is never changed. See the ControlPlaneReady condition for an indication of
// the current readiness of the cluster's control plane.
Comment on lines +62 to 64
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed we should be able to leave the condition as is and update the comment instead. @13164815445 WDYT about:

Suggested change
// cluster's apiserver is reachable or at least one control plane Machine has a node reference. Once this
// condition is marked true, its value is never changed. See the ControlPlaneReady condition for an indication of
// the current readiness of the cluster's control plane.
// cluster's apiserver is reachable. If no Control Plane provider is in use this condition reports that at least one control plane Machine has a node reference. Once this
// condition is marked true, its value is never changed. See the ControlPlaneReady condition for an indication of
// the current readiness of the cluster's control plane.

ControlPlaneInitializedCondition ConditionType = "ControlPlaneInitialized"
Expand Down