</>

Kubernetes Cheat Sheet

Practical Kubernetes cheat sheet with setup steps, core workflows, debugging, and copy-paste examples.

kubernetes automation infrastructure operations

Kubernetes cheat sheet with real commands and snippets for setup, core workflows, debugging, and production-safe automation patterns. If you are working across tools, pair this with the AWS CLI Cheat Sheet and Azure CLI Cheat Sheet.

Setup and Installation

Goal: Verify installation and CLI metadata

# Resolve command path from current shell
command -v kubectl

# Print installed version to confirm runtime
kubectl --version

# Read top-level help before using subcommands
kubectl --help

Goal: Install or upgrade the tool on a workstation

# Install package with Homebrew on macOS
brew install kubectl

# Upgrade to the latest available package
brew upgrade kubectl

# Re-check version after upgrade
kubectl --version

Goal: Run day-to-day commands

# List namespaces and running pods
kubectl get ns && kubectl get pods -A

# Apply or update resources from manifest
kubectl apply -f k8s/deployment.yaml

# Inspect pod details and events
kubectl describe pod my-app-abc123 -n default

# Stream logs for a failing container
kubectl logs -f deploy/my-app -n default

Core Workflows

Goal: Capture command help for quick offline lookup

# Create docs folder for generated command references
mkdir -p docs/cli

# Write help output to a timestamped file
kubectl --help > docs/cli/kubernetes-help.txt

# Search help output for a keyword
rg "config|auth|deploy" docs/cli/kubernetes-help.txt

Goal: Wrap repetitive commands in a script

# Create scripts directory for local automation
mkdir -p scripts

# Write repeatable health-check script
cat > scripts/check-kubernetes.sh <<'SH'
#!/usr/bin/env bash
set -euo pipefail
kubectl --version
kubectl --help >/dev/null
SH

# Make script executable and run it
chmod +x scripts/check-kubernetes.sh && ./scripts/check-kubernetes.sh

Configuration and Environment

Goal: Pin environment variables for predictable runs

# Define environment profile for local commands
export KUBERNETES_PROFILE=dev

# Persist profile in local shell configuration
echo 'export KUBERNETES_PROFILE=dev' >> ~/.zshrc

# Reload shell profile changes
source ~/.zshrc

Automation and CI

Goal: Add tool checks to CI pipeline

# Run lint/test/build in strict mode
set -euo pipefail

# Verify CLI exists before invoking workflow
command -v kubectl

# Exit quickly if command is unavailable
kubectl --version

Debugging and Troubleshooting

Goal: Collect diagnostics when commands fail

# Capture command output and exit code
kubectl --help > /tmp/kubernetes-debug.log 2>&1; echo $?

# Inspect captured diagnostics
tail -n 80 /tmp/kubernetes-debug.log

# Check current shell PATH entries
echo $PATH | tr ':' '\n'

Common Gotchas

  • Pin Kubernetes versions in CI so local and pipeline behavior match.
  • Check tool authentication context before running write or deploy commands.
  • Prefer non-interactive flags in scripts to avoid stalled jobs.
  • Capture stderr logs in CI artifacts for faster incident triage.
  • Keep secrets in environment variables, not committed scripts.

Related Cheat Sheets