Files
honeyDueAPI/docs/deployment/appendices/b-commands.md
T
Trey t 6f303dbbaa
Backend CI / Test (push) Has been cancelled
Backend CI / Contract Tests (push) Has been cancelled
Backend CI / Build (push) Has been cancelled
Backend CI / Lint (push) Has been cancelled
Backend CI / Secret Scanning (push) Has been cancelled
Migrate prod deploy from Swarm to K3s; add full deployment book
Infrastructure:
- Stack now runs on K3s v1.34.6 HA (3 Hetzner CX33 nodes as managers)
- Traefik DaemonSet + hostNetwork replaces Caddy + ingress mesh
- All manifests in deploy-k3s/manifests/; Swarm config (deploy/) kept
  temporarily for reference

Bug fixes surfaced during migration:
- Dockerfile: golang:1.24-alpine -> 1.25-alpine (go.mod requires 1.25)
- cache_service.go: remove sync.Once reassignment from inside Do()
  callback (was causing 'unlock of unlocked mutex' fatal after
  Redis Ping failure)
- router.go: relax CSP from 'default-src none' to 'default-src self'
  + allowlist fonts.googleapis.com so the marketing landing page CSS
  actually loads in browsers
- deploy/scripts/deploy_prod.sh: use docker buildx with
  --platform linux/amd64 so arm64 (Apple Silicon) dev machines produce
  images runnable on x86_64 Hetzner nodes; fix array expansion under
  set -u
- deploy/swarm-stack.prod.yml: fix secret source references to use
  top-level aliases (the '\${X_SECRET}' form never actually resolved);
  dozzle ports: long-form host_ip is rejected by Swarm, switched to
  short-form (bound to 0.0.0.0 with UFW-based loopback restriction);
  worker replicas 2 -> 1 (Asynq scheduler singleton)
- deploy-k3s/manifests/admin/deployment.yaml: probe path '/admin/' -> '/'
  (Next.js serves at root; /admin/ returned 404 and killed pods);
  startupProbe failureThreshold 12 -> 24
- deploy-k3s/manifests/pod-disruption-budgets.yaml: worker minAvailable
  1 -> 0 (singleton)
- deploy-k3s/manifests/api/deployment.yaml: startupProbe failureThreshold
  12 -> 48 (MigrateWithLock serializes across 3 replicas on first-boot;
  real startup takes up to 240s)
- .gitignore: tighten 'api' -> '/api' (was matching deploy-k3s/manifests/api/
  and admin/src/app/api/*, hiding legitimate files)

New files:
- deploy-k3s/manifests/traefik-helmchartconfig.yaml: DaemonSet +
  hostNetwork override for k3s-bundled Traefik
- deploy-k3s/manifests/ingress/ingress-simple.yaml: plain Ingress
  without TLS (CF Flexible SSL) and without middleware
- deploy-k3s/MIGRATION_NOTES.md: operator-facing migration log

Documentation:
- docs/deployment/ — full deployment book, 26 files, ~42k words:
  - Part I Overview, infrastructure, orchestrator choice (Ch 0-2)
  - Part II Networking, firewall, Cloudflare (Ch 3-4, 13)
  - Part III Security, Traefik ingress (Ch 5-6)
  - Part IV Services, DB, storage, secrets, registry (Ch 7-11)
  - Part V Data flow, deploy process, observability, failures, runbook
    (Ch 12, 14-17)
  - Part VI Cost, Swarm postmortem, roadmap (Ch 18-20)
  - Appendices: glossary, kubectl cheat sheet, file locations,
    consolidated citations
- README.md: Production Deployment section replaced with pointer to
  the book; Go version bumped to 1.25

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-24 07:20:54 -05:00

7.1 KiB

Appendix B — kubectl Cheat Sheet

Specific to this deployment. Assumes:

export KUBECONFIG=~/.kube/honeydue-k3s.yaml

Viewing state

# All pods in our namespace
kubectl get pods -n honeydue

# With node placement + IPs
kubectl get pods -n honeydue -o wide

# All resources in our namespace
kubectl get all -n honeydue

# Cluster-wide pod overview
kubectl get pods -A

# Node health
kubectl get nodes
kubectl top nodes

# What's using RAM
kubectl top pods -n honeydue --sort-by=memory

# What's using CPU
kubectl top pods -n honeydue --sort-by=cpu

Logs

# Follow all api pod logs
kubectl logs -n honeydue -l app.kubernetes.io/name=api -f --prefix

# One specific pod
kubectl logs -n honeydue <pod-name>

# Previous pod's logs (after crash)
kubectl logs -n honeydue <pod-name> --previous

# Filtered
kubectl logs -n honeydue deploy/api | grep -i error
kubectl logs -n honeydue deploy/api --since=1h

# stern is nicer for multi-pod (if installed)
stern -n honeydue api

Deploying new code

SHA=$(git rev-parse --short HEAD)

# Build + push (requires docker login to Gitea first)
docker buildx build --platform linux/amd64 --target api \
  -t "gitea.treytartt.com/admin/honeydue-api:${SHA}" --push .

# Roll it in
kubectl set image deployment/api -n honeydue \
  api="gitea.treytartt.com/admin/honeydue-api:${SHA}"

# Watch
kubectl rollout status -n honeydue deployment/api

Rolling update controls

# Pause a rollout in progress (new pods stop being created)
kubectl rollout pause deployment/api -n honeydue

# Resume
kubectl rollout resume deployment/api -n honeydue

# Rollback to previous version
kubectl rollout undo deployment/api -n honeydue

# Rollback to specific revision
kubectl rollout history deployment/api -n honeydue
kubectl rollout undo deployment/api -n honeydue --to-revision=3

# Force restart (re-pulls image if digest changed; reloads ConfigMap)
kubectl rollout restart deployment/api -n honeydue

Scaling

# Scale up
kubectl scale deployment/api -n honeydue --replicas=5

# Scale down
kubectl scale deployment/api -n honeydue --replicas=3

# Kill everything (emergency)
kubectl scale deployment -n honeydue --all --replicas=0

# Bring back
kubectl scale deployment/api -n honeydue --replicas=3
kubectl scale deployment/admin deployment/worker deployment/redis -n honeydue --replicas=1

Debugging a pod

# Describe = events + state + restart history
kubectl describe pod -n honeydue <pod-name>

# Shell in
kubectl exec -it -n honeydue deploy/api -- /bin/sh

# Inside:
# Test HTTP locally (bypasses Traefik, Service, overlay)
wget -qO- http://127.0.0.1:8000/api/health/

# Test cross-Service DNS
getent hosts redis
getent hosts admin
getent hosts postgres

# Run arbitrary command (one-shot)
kubectl exec -n honeydue deploy/api -- env | grep POSTGRES

Networking checks

# Resolve a Service from a pod
kubectl exec -n honeydue deploy/api -- nslookup redis

# Check Service endpoints (the actual IPs behind a ClusterIP)
kubectl get endpoints -n honeydue api

# Traffic test via Service
kubectl run test --rm -it --image=alpine/curl -- sh
# curl http://api.honeydue.svc:8000/api/health/

# List all Ingresses
kubectl get ingress -A

Secret / Config

# List
kubectl get secrets -n honeydue
kubectl get configmap -n honeydue

# Describe (shows keys, not values)
kubectl describe secret honeydue-secrets -n honeydue

# Read a value (DANGER: plaintext to stdout)
kubectl get secret honeydue-secrets -n honeydue \
  -o jsonpath='{.data.POSTGRES_PASSWORD}' | base64 -d; echo

# Update a single secret key
kubectl patch secret honeydue-secrets -n honeydue \
  --type=merge -p "{\"data\":{\"SECRET_KEY\":\"$(echo -n 'new-val' | base64)\"}}"

# Regenerate ConfigMap from prod.env
kubectl create configmap honeydue-config -n honeydue \
  --from-env-file=deploy/prod.env \
  --dry-run=client -o yaml | kubectl apply -f -

# Edit a ConfigMap interactively (does NOT restart pods)
kubectl edit configmap honeydue-config -n honeydue

Node management

# Prevent scheduling on a node
kubectl cordon <node-hostname>

# Prevent scheduling + evict existing pods
kubectl drain <node-hostname> --ignore-daemonsets --delete-emptydir-data

# Allow scheduling again
kubectl uncordon <node-hostname>

# Label a node
kubectl label node <node-hostname> honeydue/redis=true --overwrite

# Remove a label
kubectl label node <node-hostname> honeydue/redis-

Events (the timeline)

# All events, newest last
kubectl get events -A --sort-by=.lastTimestamp

# Watch live
kubectl get events -A --sort-by=.lastTimestamp -w

# Only warnings
kubectl get events -A --field-selector type=Warning

# Events for a specific pod
kubectl describe pod -n honeydue <pod> | awk '/Events:/,0'

Traefik-specific

# All Traefik pods (DaemonSet, so one per node)
kubectl get pods -n kube-system -l app.kubernetes.io/name=traefik -o wide

# Restart Traefik across all nodes
kubectl rollout restart daemonset/traefik -n kube-system

# View Traefik config (via ConfigMap)
kubectl get cm -n kube-system traefik -o yaml | less

# See the HelmChartConfig we applied
kubectl get helmchartconfig -n kube-system traefik -o yaml

# Force Helm re-reconcile
kubectl delete job -n kube-system helm-install-traefik

Cluster-wide operations

# API server health
kubectl cluster-info

# All namespaces
kubectl get namespaces

# All k3s-system pods
kubectl get pods -n kube-system

# All ServiceAccounts in our namespace
kubectl get sa -n honeydue

# Check what an SA can do
kubectl auth can-i --list --as=system:serviceaccount:honeydue:api

Hetzner SSH (not kubectl but oft needed)

# SSH in
ssh -i ~/.ssh/hetzner deploy@hetzner1

# Check k3s service
ssh -i ~/.ssh/hetzner deploy@hetzner1 'sudo systemctl status k3s'

# Per-node commands in parallel (e.g., apt upgrade)
for h in hetzner1 hetzner2 hetzner3; do
  ssh -i ~/.ssh/hetzner "deploy@$h" 'sudo apt update && sudo apt upgrade -y'
done

Emergency: cluster is wedged

# Check all nodes Ready
kubectl get nodes

# If one is NotReady
ssh -i ~/.ssh/hetzner deploy@<node> 'sudo systemctl restart k3s'

# If still bad, kill k3s on that node and check
ssh -i ~/.ssh/hetzner deploy@<node> 'sudo /usr/local/bin/k3s-killall.sh'
ssh -i ~/.ssh/hetzner deploy@<node> 'sudo systemctl start k3s'

# Last resort: uninstall + rejoin
# ssh -i ~/.ssh/hetzner deploy@<node> 'sudo /usr/local/bin/k3s-uninstall.sh'
# then re-join via the k3s install command

One-liners worth memorizing

# Heavy smoke test through CF
for url in https://api.myhoneydue.com/api/health/ https://admin.myhoneydue.com/ https://myhoneydue.com/; do
  ok=0
  for i in $(seq 1 20); do
    [[ "$(curl -sS -o /dev/null -w '%{http_code}' --max-time 10 "$url")" == "200" ]] && ok=$((ok+1))
  done
  printf "%-45s %d/20\n" "$url" "$ok"
done

# Pods not ready
kubectl get pods -A | awk '$3!="Running" && $3!="Completed" && $3!="STATUS"'

# Restart everything in our namespace
for d in api admin worker redis; do
  kubectl rollout restart deploy/$d -n honeydue
done

# Watch all rollouts simultaneously
for d in api admin worker redis; do
  kubectl rollout status deploy/$d -n honeydue &
done; wait