Skip to content

Latest commit

 

History

History

README.md

KubeAid Documentation

Welcome to the KubeAid documentation.

KubeAid gives you one way to install and operate Kubernetes on any cloud (or your own servers), with GitOps, security, monitoring, and compliance built in from day one. It uses Cluster API to unify installation across providers, ships 100+ curated Helm charts with best-practice defaults, and maps its security posture to ISO 27001:2022.

→ New here? Start with Why KubeAid? to understand the problem we solve, then follow the Getting Started Guide to deploy your first cluster.

Table of Contents

Getting Started

🎬 Watch the Installation Video - a step-by-step walkthrough of setting up KubeAid via KubeAid-cli.

The complete installation guide for setting up a KubeAid-managed Kubernetes cluster:

Guide Description
Getting Started Guide Complete installation walkthrough
Prerequisites Required tools and setup
Pre-Configuration Configuration file setup
Installation Bootstrap your cluster
Post-Configuration Access dashboards and verify setup
Basic Operations Day-to-day operations and cleanup

Hosting Reference

Hosting-specific details and considerations:

Guide Description
Cloud Providers AWS, Azure, Hetzner HCloud
Bare Metal On-premise dedicated servers
Single Host K8s Single-node deployments
Hybrid Setup Mixed cloud and bare metal

Operations

Guides for ongoing cluster management:

Guide Description
Backup & Restore Disaster recovery procedures
Backup Exporter Velero and PostgreSQL backup monitoring
Node Reboot Safe node maintenance
Node Disk Repair Procedure to replace and fix corrupted node disks
AWS Private Link Setup Cross-account connectivity
Operations Tips Legacy operational procedures and debugging

Monitoring

Guide Description
Monitoring kube-prometheus metrics stack and log monitoring options (OpenObserve, Graylog, OpenSearch + Kibana)
Pod Autoscaling HPA and VPA configuration
Prometheus Namespaces Namespace-level monitoring

Development

Guide Description
CI/CD Setup Pipeline configuration
Helm Charts Chart development
Release Procedure Release workflow
Update ArgoCD Apps Updating deployed apps

Access Tokens

Guide Description
GitHub Token GitHub PAT setup
GitLab Token GitLab PAT setup

About KubeAid

Guide Description
Why KubeAid The problem KubeAid solves
KubeAid Comparison In-depth comparison with Terraform, Ansible, Puppet, and alternatives
Features Technical Details In-depth feature documentation
Helm Umbrella Pattern How KubeAid manages applications
Prometheus Configuration Configuring monitoring with kube-prometheus
Monitoring Metrics and log monitoring overview
GitOps Drift Detection ArgoCD sync status and alerting

Architecture & Decisions

Guide Description
Architecture Decisions Technical choices and architectural evolution
GitOps Decision Record Real-world GitOps patterns and incident lessons

Security & Compliance

Guide Description
Cilium Host-Firewall Node-level network policy for bare-metal clusters
CISO Assistant GRC compliance platform setup

Support

For general questions, bug reports, and feature requests, please use our GitHub Issues.

For enterprise support, visit Obmondo.