Documentation

Getting Started

Installation

Download KubChen from our download page and follow the platform-specific instructions:

macOS: Open the .dmg file and drag KubChen to Applications
Windows: Run the .msi installer
Linux: Use the .AppImage or install the .deb package

First Launch

Launch KubChen
Your local kubeconfig clusters will be automatically discovered
Select a cluster from the sidebar to connect

User Guide

Cluster Connection

KubChen automatically discovers clusters from your local ~/.kube/config file. To connect:

Click on a cluster in the left sidebar
Wait for the connection to establish
Browse resources in the resource tree

Resources are organized by category:

Workloads: Pods, Deployments, StatefulSets, DaemonSets, Jobs, CronJobs
Network: Services, Ingresses, NetworkPolicies
Storage: PersistentVolumes, PersistentVolumeClaims, StorageClasses
Config: ConfigMaps, Secrets
Access Control: ServiceAccounts, Roles, RoleBindings

Viewing Resources

Click any resource to view:

Overview: Key metadata and status
YAML: Full resource definition with syntax highlighting
Events: Related Kubernetes events
Related: Connected resources (e.g., Pods for a Deployment)

Configuration

Settings

Access settings via the gear icon or Cmd/Ctrl + ,:

Theme: Light, Dark, or System
Language: English, Chinese
Cluster Settings: Connection timeout, refresh intervals

Troubleshooting

Connection Issues

Problem: Cannot connect to cluster

Solutions:

Verify your kubeconfig is valid: kubectl cluster-info
Check network connectivity to the API server
Ensure your credentials haven’t expired

Performance

Problem: Slow resource loading

Solutions:

Check the number of resources in the namespace
Try filtering by namespace instead of viewing all namespaces
Ensure your API server is responsive

Contributing

KubChen is open source! Visit our GitHub repository to:

Report bugs
Request features
Contribute code

Need help? Open an issue on GitHub.