kubeadm Cheat Sheet

Bootstrap, join, cert, kubeconfig, reset, phase, image, and upgrade commands for kubeadm-managed clusters.

View
StandardDetailedCompact
Export
Copy the compact sheet, download it, or print it.
Download
`D` dense toggle · `C` copy all

Cluster Bootstrap

Initialize and inspect kubeadm-based clusters.

Show kubeadm version

Print kubeadm version information.

bashANYkubeadmversion
bash
kubeadm version

Print kubeadm version information.

Initialize control plane

Bootstrap a new control plane.

bashANYkubeadminit
bash
kubeadm init --pod-network-cidr=10.244.0.0/16

Bootstrap a new control plane.

Initialize with cert upload

Initialize HA control plane and upload certs for additional control-plane joins.

bashANYkubeadminitha
bash
kubeadm init --control-plane-endpoint=k8s.example.com --upload-certs

Initialize HA control plane and upload certs for additional control-plane joins.

Create join token

Create a bootstrap token for joining nodes.

bashANYkubeadmtoken
bash
kubeadm token create

Create a bootstrap token for joining nodes.

Create token and print join command

Generate a ready-to-run join command.

bashANYkubeadmjointoken
bash
kubeadm token create --print-join-command

Generate a ready-to-run join command.

List bootstrap tokens

Show active kubeadm bootstrap tokens.

bashANYkubeadmtoken
bash
kubeadm token list

Show active kubeadm bootstrap tokens.

Delete bootstrap token

Invalidate a bootstrap token.

bashANYkubeadmtokendelete
bash
kubeadm token delete abcdef.0123456789abcdef

Invalidate a bootstrap token.

Join worker node

Join a worker node to the cluster.

bashANYkubeadmjoinworker
bash
kubeadm join k8s.example.com:6443 --token abcdef.0123456789abcdef --discovery-token-ca-cert-hash sha256:<hash>

Join a worker node to the cluster.

Join control-plane node

Join an additional control-plane node.

bashANYkubeadmjoincontrol-plane
bash
kubeadm join k8s.example.com:6443 --token abcdef.0123456789abcdef --discovery-token-ca-cert-hash sha256:<hash> --control-plane --certificate-key <key>

Join an additional control-plane node.

Certificates and kubeconfig

Operate kubeadm-managed PKI and kubeconfig files.

Check certificate expiration

See kubeadm-managed certificate expiry dates.

bashANYkubeadmcerts
bash
kubeadm certs check-expiration

See kubeadm-managed certificate expiry dates.

Renew all certificates

Renew all kubeadm-managed control-plane certificates.

bashANYkubeadmcertsrenew
bash
kubeadm certs renew all

Renew all kubeadm-managed control-plane certificates.

Renew apiserver cert

Renew the API server certificate only.

bashANYkubeadmcertsrenew
bash
kubeadm certs renew apiserver

Renew the API server certificate only.

Generate certificate key

Generate a certificate key for control-plane join.

bashANYkubeadmcertsha
bash
kubeadm certs certificate-key

Generate a certificate key for control-plane join.

Generate kubeconfig for user

Generate a kubeconfig file for a user credential.

bashANYkubeadmkubeconfig
bash
kubeadm kubeconfig user --client-name=platform-admin

Generate a kubeconfig file for a user credential.

Upload certs phase

Run only the cert upload phase.

bashANYkubeadmphasecerts
bash
kubeadm init phase upload-certs --upload-certs

Run only the cert upload phase.

Phases, Reset, and Upgrade

Break apart the lifecycle for advanced administration.

Run init preflight phase

Run kubeadm preflight checks.

bashANYkubeadmphasepreflight
bash
kubeadm init phase preflight

Run kubeadm preflight checks.

Run control-plane phase

Run control-plane static pod generation phases.

bashANYkubeadmphasecontrol-plane
bash
kubeadm init phase control-plane all

Run control-plane static pod generation phases.

Reset node

Remove kubeadm state from a node.

bashANYkubeadmreset
bash
kubeadm reset

Remove kubeadm state from a node.

Force reset node

Reset a node non-interactively.

bashANYkubeadmresetforce
bash
kubeadm reset -f

Reset a node non-interactively.

Show upgrade plan

Check available and recommended upgrade targets.

bashANYkubeadmupgrade
bash
kubeadm upgrade plan

Check available and recommended upgrade targets.

Apply control-plane upgrade

Upgrade the control plane to a target version.

bashANYkubeadmupgradecontrol-plane
bash
kubeadm upgrade apply v1.35.2

Upgrade the control plane to a target version.

Upgrade node components

Run node-side upgrade steps after packages are updated.

bashANYkubeadmupgradenode
bash
kubeadm upgrade node

Run node-side upgrade steps after packages are updated.

Print default init config

Generate a baseline kubeadm init configuration.

bashANYkubeadmconfig
bash
kubeadm config print init-defaults

Generate a baseline kubeadm init configuration.

List required images

Show control-plane images for the chosen version.

bashANYkubeadmimages
bash
kubeadm config images list

Show control-plane images for the chosen version.

Pre-pull required images

Pre-pull images before cluster bootstrap or upgrade.

bashANYkubeadmimagespull
bash
kubeadm config images pull

Pre-pull images before cluster bootstrap or upgrade.