Skip to content

Commit 033c5f4

Browse files
authored
Merge pull request #12377 from fabriziopandini/improve-AfterControlPlaneInitialized-doc
📖 Improve AfterControlPlaneInitialized documentation
2 parents 7a22509 + 1950e0e commit 033c5f4

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/book/src/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,10 @@ MachineDeployments and the templates derived from the ClusterClass.
7676
7777
### AfterControlPlaneInitialized
7878
79-
This hook is called after the Control Plane for the Cluster is marked as available for the first time. Runtime Extension
80-
implementers can use this hook to execute tasks, for example component installation on workload clusters, that are only
79+
This hook is called after the Control Plane reports that the control plane is initialized, which means the API server can accept requests.
80+
This usually happens sometime during the first CP machine provisioning or immediately thereafter.
81+
82+
Runtime Extension implementers can use this hook to execute tasks, for example component installation on workload clusters, that are only
8183
possible once the Control Plane is available. This hook does not block any further changes to the Cluster.
8284
8385
#### Example Request:
@@ -159,7 +161,7 @@ For additional details, you can see the full schema in <button onclick="openSwag
159161

160162
### AfterControlPlaneUpgrade
161163

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

0 commit comments

Comments
 (0)