Skip to content

Commit 83bf566

Browse files
authored
Merge pull request #6296 from sbueringer/pr-improve-write-clusterclass-doc
📖 book: clarify usage of builtin variables in enabledIf
2 parents 5fea047 + 608ebb9 commit 83bf566

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -651,6 +651,16 @@ With `semverCompare` and `coalesce` a feature can be enabled in newer versions o
651651
enabledIf: '{{ semverCompare "^1.22.0" (coalesce .builtin.controlPlane.version .builtin.machineDeployment.version )}}'
652652
```
653653

654+
<aside class="note">
655+
656+
<h1>Builtin Variables</h1>
657+
658+
Please be aware that while you can use builtin variables, if you use for example a MachineDeployment-specific variable this
659+
can mean that patches are only applied to some MachineDeployments. `enabledIf` is evaluated for each template that should be patched
660+
individually.
661+
662+
</aside>
663+
654664
<!-- links -->
655665
[Changing a ClusterClass]: ./change-clusterclass.md
656666
[clusterctl alpha topology plan]: ../../../clusterctl/commands/alpha-topology-plan.md

0 commit comments

Comments
 (0)