How kubedeckio/kubebuddy works
Project type and purpose
• KubeBuddy is a PowerShell-based CLI tool / module for Kubernetes cluster health and best-practice checks.
• It connects to a K8s API (and optionally Azure APIs for AKS), executes health/security/storage/network checks, and generates HTML, JSON, or text reports.
File structure
• Top-level module files:
• KubeBuddy.psd1 (module manifest)
• KubeBuddy.psm1 (public cmdlet definitions)
• Public/kubebuddy.ps1 (wrapper CLI)
• run.ps1 (test runner or entry script)
• “Private/” folder: contains core engine scripts—helper-functions.ps1, menu-functions.ps1, summary-functions.ps1, YAML-checks loader, JSON/HTML report generators, and AKS-specific checks under “Private/aks/…”.
• “Private/yamlChecks/” holds the check definitions in YAML (one file per resource-check type).
• “docs/” and “images/” support documentation and examples; GitHub workflows handle CI/CD, packaging, and publishing to PowerShell Gallery.
README for additional insights
• Confirms the module’s features: cluster health, workload analysis, event reporting, RBAC/security checks, networking/storage insights, customizable thresholds, report formats, and AKS best-practice checks.
• Shows the configuration mechanism (YAML file at ~/.kube/kubebuddy-config.yaml).
• Describes usage patterns: Invoke-KubeBuddy with parameters directing which checks to run and which report format to emit.