Skip to content

📖 Improve AfterControlPlaneInitialized documentation #12377

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −3
Open

📖 Improve AfterControlPlaneInitialized documentation #12377

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
8 changes: 5 additions & 3 deletions docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,10 @@ MachineDeployments and the templates derived from the ClusterClass.

### AfterControlPlaneInitialized

This hook is called after the Control Plane for the Cluster is marked as available for the first time. Runtime Extension
implementers can use this hook to execute tasks, for example component installation on workload clusters, that are only
This hook is called after the Control Plane reports control plane initialized, which means the API server can accept requests.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This hook is called after the Control Plane reports control plane initialized, which means the API server can accept requests.
This hook is called after the Control Plane reports that the control plane is initialized, which means the API server can accept requests.

This usually happens sometime during first CP machine provisioning or immediately after.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This usually happens sometime during first CP machine provisioning or immediately after.
This usually happens sometime during the first CP machine provisioning or immediately thereafter.


Runtime Extension implementers can use this hook to execute tasks, for example component installation on workload clusters, that are only
possible once the Control Plane is available. This hook does not block any further changes to the Cluster.

#### Example Request:
Expand Down Expand Up @@ -159,7 +161,7 @@ For additional details, you can see the full schema in <button onclick="openSwag

### AfterControlPlaneUpgrade

This hook is called after the control plane has been upgraded to the version specified in `spec.topology.version`,
This hook is called after the entire control plane has been upgraded to the version specified in `spec.topology.version`,
and immediately before the new version is going to be propagated to the MachineDeployments of the Cluster.
Runtime Extension implementers can use this hook to execute post-upgrade add-on tasks and block upgrades to workers
until everything is ready.
Expand Down