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

Jump to bottom

📖 Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady #10355

Merged
merged 4 commits into from
Apr 10, 2024
Merged

📖 Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady #10355

merged 4 commits into from
Apr 10, 2024

Conversation

pravarag
Copy link
Contributor

@pravarag pravarag commented Apr 2, 2024 •
edited
Loading

What this PR does / why we need it:
Improves documentation for the values of KCP.status.Ready & cluster.status.ControlPlaneReady fields
Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #8923

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 2, 2024
@pravarag pravarag mentioned this pull request Apr 2, 2024
Closed
jessehu
jessehu reviewed Apr 2, 2024
View reviewed changes
controlplane/kubeadm/internal/controllers/status.go Outdated
@@ -99,6 +99,9 @@ func (r *KubeadmControlPlaneReconciler) updateStatus(ctx context.Context, contro
}

if controlPlane.KCP.Status.ReadyReplicas > 0 {
// NOTE: this field is part of the Cluster API contract and it is used to orchestrate provisioning.
// The value of this field is never updated after provisioning is completed. Please use conditions
// to check the operational state of the control plane.
controlPlane.KCP.Status.Ready = true
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this doc should be added in the definition of field controlPlane.KCP.Status.Ready:

cluster-api/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go

Lines 273 to 276 in 785ffa4

// Ready denotes that the KubeadmControlPlane API Server is ready to
// receive requests.
// +optional
Ready bool `json:"ready"`

Copy link
Contributor Author

@pravarag pravarag Apr 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for pointing this out, I've updated in the above mentioned file. Just thinking if there's any other location where the change would be required?

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks. This also applies to the comment for field Cluster.status.ControlPlaneReady

Copy link
Member

Choose a reason for hiding this comment

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

@pravarag Let's add a simila comment to ControlPlaneReady in cluster_types.go

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated the godocs for cluster_types with the latest commit.

@pravarag pravarag force-pushed the update-kcp-status-docs branch from f523781 to 9f0f4a2 Compare April 2, 2024 07:24
neolit123
neolit123 reviewed Apr 4, 2024
View reviewed changes
Copy link
Member

@neolit123 neolit123 left a comment

Choose a reason for hiding this comment

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

/area documentation

@k8s-ci-robot k8s-ci-robot added area/documentation Issues or PRs related to documentation and removed do-not-merge/needs-area PR is missing an area label labels Apr 4, 2024
@neolit123
Copy link
Member

/retitle 📖Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady

@k8s-ci-robot k8s-ci-robot changed the title Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady 📖Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady Apr 4, 2024
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 8, 2024
@pravarag pravarag force-pushed the update-kcp-status-docs branch from 981f411 to 4b033ca Compare April 8, 2024 13:37
@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 8, 2024
@sbueringer
Copy link
Member

You'll have to run make generate-manifests after the godoc changes are done

@pravarag pravarag force-pushed the update-kcp-status-docs branch from 4b033ca to 3ac167b Compare April 9, 2024 14:28
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 9, 2024
@pravarag pravarag force-pushed the update-kcp-status-docs branch from 3ac167b to b2855c2 Compare April 9, 2024 14:36
@sbueringer
Copy link
Member

@pravarag One make generate-go-openapi then we should be good

@pravarag pravarag force-pushed the update-kcp-status-docs branch from e1d6346 to 6a93dc1 Compare April 10, 2024 05:24
@pravarag
Copy link
Contributor Author

@pravarag One make generate-go-openapi then we should be good

Done, updated with latest push.

@sbueringer sbueringer changed the title 📖Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady 📖 Improve docs for KCP.status.ready & cluster.status.ControlPlaneReady Apr 10, 2024
@sbueringer
Copy link
Member

Thank you!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 10, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 2f238b370d98e66038f48bf6ef61587c69bdc9d9

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 10, 2024
@k8s-ci-robot k8s-ci-robot merged commit c2f66a9 into kubernetes-sigs:main Apr 10, 2024
25 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.8 milestone Apr 10, 2024
@jessehu jessehu mentioned this pull request Apr 16, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jessehu jessehu jessehu left review comments

@neolit123 neolit123 neolit123 left review comments

@sbueringer sbueringer sbueringer left review comments

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

@richardcase richardcase Awaiting requested review from richardcase

Assignees

@sbueringer sbueringer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v1.8
Development

Successfully merging this pull request may close these issues.

Improve documentation for KCP.status.ready and the cluster.Status.ControlPlaneReady
5 participants
@pravarag @neolit123 @sbueringer @k8s-ci-robot @jessehu