Example Documentation: Kubernetes Platform operations
1. Goal
Assess observability, autoscaling, GitOps, upgrades, backup and cost model.
2. What Is Done
The example is inspected through manifest review, kubectl output, events, logs and cleanup notes. Without a cluster, controller impact is simulated with explicit reasoning.
3. Why It Is Done
Kubernetes is declarative and controller-based. A manifest can alter workloads, network, storage, permissions or policies and therefore needs validation.
4. Typical Commands
kubectl get all -A 2>/dev/null || true
kubectl get events -A --sort-by=.lastTimestamp 2>/dev/null || true
kubectl describe deploy -A 2>/dev/null || true
kubectl auth can-i --list 2>/dev/null || true
5. Validate Success
- resources exist in the expected namespace.
- status, conditions and events are plausible.
- service, storage, NetworkPolicy or securityContext behavior matches the documentation.
- rollback and owner are documented.
6. Common Mistakes
- wrong namespace or selector.
- missing requests and limits.
- secret stored as plaintext in Git.
- service without endpoints.
- overly broad RBAC or privileged workloads.
7. Security Aspects
Do not use real secrets. Evaluate RBAC, NetworkPolicy, Pod Security Restricted, image signatures and admission policies.
8. Realistic Use
The example maps to GitOps, platform runbooks, review checklists, incident response, DR tests and audit evidence.