Kubernetes Home Assistant Integration
Welcome to the documentation for the Kubernetes Home Assistant Integration. This custom integration allows Home Assistant to monitor and interact with Kubernetes clusters.
Quick Navigation
Getting Started
- Configuration Guide - Detailed configuration options and settings
- Service Account Setup - Kubernetes RBAC and service account configuration
- RBAC Reference - Comprehensive RBAC permissions guide
- Examples and Automations - Practical examples and automation ideas
Reference Documentation
- Entities Documentation - Sensors, binary sensors, and switches reference
- Services Documentation - Available services for programmatic control
Advanced Topics
- Development Guide - Information for developers and contributors
- Entity Management - Automatic entity cleanup and dynamic discovery
- Logging Configuration - How to configure and troubleshoot logging
- Troubleshooting - Common issues and solutions
Overview
This integration provides sensors, binary sensors, and switches to monitor your Kubernetes cluster directly from Home Assistant. You can track pod counts, individual node status with detailed system information, resource usage, and control deployments and statefulsets.
Key Features
- Cluster Metrics: Monitor pod, node, deployment, statefulset, and cronjob counts
- Individual Node Monitoring: Detailed sensors for each Kubernetes node with status, IP addresses, memory/CPU resources, and system information
- Workload Control: Start/stop deployments and statefulsets via Home Assistant switches
- Health Monitoring: Binary sensor for overall cluster health
- Dynamic Discovery: Automatic entity creation and cleanup as resources change
Getting Started
For installation instructions, please refer to the main README in the project repository, then follow the Configuration Guide and Service Account Setup for detailed setup instructions.
Support
If you encounter issues, please check the Troubleshooting guide first, then feel free to open an issue on the GitHub repository.