Skip to content

Commit f7fd68e

Browse files
committed
docs: add some more handler update dev docs
1 parent db45d25 commit f7fd68e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ When adding a new handler, or modifying an existing one, pay close attention to
1818
when a new version of this extension is deployed in the management cluster,
1919
and avoid rollouts of Machines in those existing clusters.
2020

21+
If a change to a handler is unavoidable, you must:
22+
1. Update the version of the handlers, e.g. from `v4` to `v5`.
23+
This is done by updating the `..ClusterV4ConfigPatch` in the handler files in `pkg/handlers/../mutation/`.
24+
And `..clusterv4configpatch` in `hack/examples/overlays/clusterclasses/../kustomization.yaml.tmpl`
25+
2. Update the version of the handler in the `pkg/handlers/v3` package, e.g. from `v3` to `v4`.
26+
3. Copy the existing implementation of the handler to `pkg/handlers/../v4/`.
27+
2128
During CAPI provider upgrades, and periodically, all managed clusters are reconciled and mutation handler patches
2229
are applied.
2330
Any new handlers that return a new set of patches, or updated handlers that return a different set of patches,

0 commit comments

Comments
 (0)