How nataliagranato/kubernetes-troubleshooting works
Project Type and Purpose
• The project serves as an educational resource for practicing and understanding troubleshooting on Kubernetes clusters.
• It includes practical exercises using kubeadm for cluster setup/removal and workloads that simulate different error cases (e.g., crashing pods, misconfigurations).
Analyzing the File Structure
• Top-Level Items: Files like LICENSE, README.md, and documentation (docs folder) indicate general project info and guides.
• Directories:
• The “exercícios” folder is divided into subdirectories:
• “kubeadm”: Contains scripts like controlplane-install.sh, worker-install.sh, and uninstall.sh which are used to set up and dismantle the Kubernetes control plane and worker nodes.
• “workloads”: Contains YAML files that simulate various error scenarios (e.g., bad_prometheus_rule.yaml, failing_liveness_probe.yaml, resource errors, etc.).
• Other Files: Files such as nginx-ingress-bare-metal.yaml might be used to demonstrate load balancing or ingress controller scenarios.
• The “docs” folder contains PDFs and additional markdown resources, which likely provide background and supportive learning material.
Main Components
a. Educational Resources & Documentation:
b. Cluster Setup/Management:
• “Kubeadm Scripts”: Two primary components for managing the cluster:
• “Control Plane Setup” (controlplane-install.sh)
• “Worker Install” (worker-install.sh)
• “Uninstallation Script” (uninstall.sh)
c. Workloads and Error Scenarios:
• Pod lifecycle errors (e.g., crashloop, pending resources)
• Configuration errors (e.g., image errors, resource misconfigurations)
• Service errors (e.g., svc-errs.yaml)
d. Cluster Components (Conceptually):
• Standard Kubernetes architecture elements such as “API Server”, “Scheduler”, “Controller Manager”, “etcd”, “Worker Nodes”, and “Pods.”
• This helps bridge the gap between the abstract exercises and the real-world Kubernetes components they affect.
Relationships and Interactions
• How the “Kubeadm Scripts” interact with the cluster components to set up the control plane and worker nodes.
• Data flow between the “Documentation” and the exercises, indicating that users refer to guides while applying troubleshooting practices.
• Interaction between an external user (or “student”) and the cluster, representing commands executed via the command-line interface.
Architectural Patterns and Design Principles
• The design emphasizes separation of concerns: distinct components for cluster setup (kubeadm scripts) and error simulation (workloads).
• It follows a layered approach, from documentation & exercises down to the underlying Kubernetes cluster components.
• This reinforces learning by mapping scripted exercises to real cluster behavior.