Skip to main content

Installation Overview

This guide walks you through installing Kube-DC on your Kubernetes cluster.

Prerequisites​

Before installing Kube-DC, ensure you have:

  • Kubernetes Cluster: RKE2 or K3s cluster (v1.28+)
  • kubectl: Configured to access your cluster
  • Minimum Resources:
    • 3 worker nodes (4 CPU, 16GB RAM each)
    • 100GB+ available storage per node

Installation Methods​

Kube-DC supports multiple installation methods:

The automated installer handles all components:

curl -sfL https://get.kube-dc.cloud | sh -

This installs:

  • Kube-DC operators
  • OVN networking
  • MetalLB load balancer
  • Cert-manager
  • Keycloak SSO

2. Manual Installation​

For customized deployments:

# Clone the repository
git clone https://github.com/shalb/kube-dc.git
cd kube-dc

# Install with custom configuration
./installer/install.sh

3. GitOps (ArgoCD/Flux)​

Deploy using GitOps tools:

# See installer/kube-dc/project.yaml for configuration
kubectl apply -f installer/kube-dc/

Post-Installation​

After installation:

  1. Verify Components:

    kubectl get pods -n kube-dc
    kubectl get pods -n kube-ovn
    kubectl get pods -n envoy-gateway-system

  2. Access UI:

    kubectl get svc -n kube-dc kube-dc-ui

  3. Create First Organization:

    kubectl apply -f examples/organization/01-organization.yaml

What's Next?​

After installation, you can:

  • Create your first organization
  • Deploy workloads
  • Configure networking

Troubleshooting​

Common issues:

  • Pods not starting: Check node resources and storage with kubectl get pods -A
  • Network issues: Verify OVN configuration with kubectl get pods -n kube-ovn
  • Certificate errors: Ensure cert-manager is running with kubectl get pods -n cert-manager