k8s-operator/reconciler/tailscaled: add helper to delete devices by machine key

tailscaled only learns its device ID, and so only writes it to its state
Secret, once it gets its first netmap. If it is shut down after it
registered with control but before that, there is no ID to delete its
device by. tailscaled does write its machine key to the state Secret
before it registers.

This adds EnsureUnreportedDeviceDeleted, which looks up the device by
that machine key and deletes it, for reconcilers to use when a state
Secret has no device ID.

Updates #18922

Signed-off-by: chaosinthecrd <tom@tmlabs.co.uk>
This commit is contained in:
chaosinthecrd authored and Tom Meadows committed 2026-11-02 11:36:55 +00:00
1 parent 49aa9c859c
commit b992793d14
1 file changed
+39
@@ -18,6 +18,7 @@ import (
"tailscale.com/ipn"
"tailscale.com/k8s-operator/tsclient"
"tailscale.com/tailcfg"
"tailscale.com/types/key"
)
// ClientProvider returns a Tailscale API client for the given tailnet name. A blank name should return the
@@ -57,6 +58,44 @@ func EnsureDeviceDeleted(ctx context.Context, client tsclient.Client, logger *za
return nil
}
// EnsureUnreportedDeviceDeleted deletes the device registered with the machine key in state Secret secret, for a
// tailscaled that registered with control but was shut down before it received a netmap, so it never learned its
// device ID to write to the state Secret.
func EnsureUnreportedDeviceDeleted(ctx context.Context, client tsclient.Client, logger *zap.SugaredLogger, secret *corev1.Secret) error {
mkText := secret.Data[string(ipn.MachineKeyStateKey)]
// tailscaled writes its machine key before registering, so no key means no device.
if len(mkText) == 0 {
return nil
}
var mk key.MachinePrivate
if err := mk.UnmarshalText(mkText); err != nil {
// tailscaled refuses to start with an invalid machine key, so it cannot have registered a device with it.
logger.Warnf("failed to parse machine key in state Secret %q, skipping: %v", secret.Name, err)
return nil
}
mkPub := mk.Public().String()
devices, err := client.Devices().List(ctx, tailscaleclient.WithFilter("machineKey", []string{mkPub}))
if err != nil {
return fmt.Errorf("failed to list devices: %w", err)
}
for _, dev := range devices {
// Control ignores filters it does not support, so check the key rather than trusting the filter.
if dev.MachineKey != mkPub {
continue
}
logger.Infof("deleting device %q that registered but never reported its device ID", dev.NodeID)
if err := client.Devices().Delete(ctx, dev.NodeID); err != nil && !tailscaleclient.IsNotFound(err) {
return fmt.Errorf("failed to delete device %q: %w", dev.NodeID, err)
}
}
return nil
}
// AuthKeyFromConfigSecret returns the auth key embedded in the tailscaled config file stored in secret, or nil if
// none is set. secret is expected to be a Secret produced by NewConfigSecret. The Data map may contain multiple
// versioned config files (cap-<n>.hujson); the first one to parse successfully and yield a non-empty AuthKey wins.