Annotations

You can set Kubernetes Annotations to instruct the Syself CAPH Controller to modify its behavior.

Overview of Annotations

capi.syself.com/wipe-disk

ResourceHetznerBareMetalHost
DescriptionThis annotation instructs the Syself CAPH Controller to wipe the disk before provisioning the machine.
ValueYou can use the string "all" or a space-separated list of WWNs. For example, "10:00:00:05:1e:7a:7a:00 eui.00253885910c8cec 0x500a07511bb48b25" . If the value is empty, no disks will be wiped. The value "all" will wipe all disks on the bare-metal machine (not just the one given in the rootDeviceHints).
Auto-RemoveEnabled: The annotation is removed after the disks are wiped.

capi.syself.com/ignore-check-disk

ResourceHetznerBareMetalHost
DescriptionThis annotation instructs the Syself CAPH Controller to ignore the results of the check-disk step during machine provisioning. The check will be performed, and a Kubernetes Event will be created. However, if this annotation is set, provisioning will continue even if a faulty disk is detected.
ValueThe value is ignored. If the annotation exists, this feature is enabled.
Auto-RemoveDisabled: The annotation remains on the resource. It is up to the user to remove it.

capi.syself.com/allow-empty-control-plane-address

ResourceHetznerCluster
DescriptionThis annotation allows the Syself CAPH Controller to create HetznerCluster resources with an empty controlPlaneEndpoint . This is useful to support externally managed control planes (PR 1106)
Value "true" enables this feature. All other strings are considered "false" .
Auto-RemoveDisabled: The annotation remains on the resource.

capi.syself.com/constant-bare-metal-hostname

ResourceCluster (CRD of Cluster-API), HetznerBareMetalMachine
DescriptionSee Using constant hostnames for more details.
Auto-RemoveDisabled: The annotation remains on the resource.

capi.syself.com/reboot

ResourceHetznerBareMetalHost
DescriptionIf this annotation is present, the bare-metal machine will be rebooted. This annotation is used by HetznerBareMetalRemediation (see Machine Health Checks with Custom Remediation Template).
ValueThe value is ignored. If the annotation exists, this feature is enabled.
Auto-RemoveEnabled: The annotation is removed after the reboot.

capi.syself.com/permanent-error

ResourceHetznerBareMetalHost
DescriptionThis annotation is set by the Syself CAPH Controller when a bare-metal machine enters the "permanent error" state. This indicates that human intervention is required (e.g., to fix a broken disk). After the root cause is resolved, the user must remove this annotation to allow the Controller to manage the HetznerBareMetalHost again.
Auto-RemoveDisabled: The annotation must be removed by the user.
Previous
HetznerBareMetalRemediationTemplate
Next
Developing Cluster API Provider Hetzner