Skip to content

chalkctl rotate

chalkctl rotate <kind> [flags]

Rotates a CA or key of the cluster from the secrets file, in phases every node confirms in its status before the next one starts: accept, switch, refresh and, with --finish, finish. A rotation that stopped, at an unreachable node for example, or paused for the operator continues with --resume. See A rotation replaces a CA in four phases.

Use a dedicated cluster secrets file. It records the phase reached and is updated in place, keeping the version from before the rotation as <file>.prev. SOPS files use their existing keys and support in-place updates only. For native JSON and age bundles, --out can name a new file and --recipient can change the age recipients. One chalkctl command at a time changes the secrets file, holding <file>.lock.

Nodes revoked with chalkctl node revoke are skipped and named; rotate stops while a layer cannot say which nodes are revoked, as when no Kubernetes control plane answers, unless none was bootstrapped yet. --ignore-revoked rotates without the lists, and every node of the inventory takes part, so remove revoked nodes from the inventory first. The command needs the secrets file.

Flags

Flag Type Default Description
--address list of [NODE=]ADDR each node's address in the inventory Address of a node's chalkd, NODE=ADDR, host or host:port; may be repeated.
--finish boolean false Remove the old value from every node and the secrets file.
--force boolean false With --finish, finish although the kind asks to wait, as the service-account key does within the hour after its switch.
--identity list of string ~/.config/chalkos/age.key, ~/.ssh/id_ed25519, ~/.ssh/id_rsa File holding an age identity to decrypt the secrets with; may be repeated.
--ignore-revoked boolean false Rotate every node of the inventory, revoked ones included, without reading the revoked nodes, as while no layer can say which are.
--inventory string $CHALKOSINVENTORY, else chalkos.yaml in the current directory, when it exists Inventory naming the cluster's nodes, their addresses and their config files.
--out string — New file to write the changed secrets file to, instead of updating the secrets file in place.
--public-out string — New file to write the public half to, instead of updating secrets.pub.json beside the secrets file in place.
--recipient list of string — Age recipient to encrypt the changed secrets file to instead of those it records; may be repeated. A plaintext secrets file is encrypted only to a new .age file given with --out.
--resume boolean false Continue the rotation the secrets file records.
--secrets string — Cluster secrets path (.age, .enc.*, or plaintext), provider URI, or - for standard input.
--timeout duration 10m0s How long to wait for each node to apply a phase.

Examples

# Rotate the Kubernetes CA. It pauses after the accept phase, so kubeconfigs and workloads can
# trust the new CA before it issues certificates. It pauses again after the refresh.
chalkctl rotate kubernetes-ca --secrets secrets.age
chalkctl rotate kubernetes-ca --secrets secrets.age --resume
chalkctl rotate kubernetes-ca --secrets secrets.age --finish

# Rotate the node CA. It runs in one go: every node gets a certificate of the new one.
chalkctl rotate node-ca --secrets secrets.age

See also

  • chalkctl: Install and operate chalkos clusters