Helm Installation

Install KTube using Helm for advanced customization and production deployments.

Prerequisites

  • Helm 3.10 or later
  • kubectl configured with cluster access
  • Cluster admin permissions

Installation

1. Add the Helm Repository

$ helm repo add ktube https://ktube-dev.github.io/charts
$ helm repo update

2. Install KTube

$ helm install ktube ktube/ktube \
--namespace ktube-system \
--create-namespace

3. Verify Installation

$ kubectl get pods -n ktube-system
NAME                                READY   STATUS    RESTARTS   AGE
ktube-operator-7d8f9b6c4d-x2j9k     1/1     Running   0          30s
ktube-dashboard-5c7d8e9f1b-m3n4p    1/1     Running   0          30s

Configuration

Using Values File

Create a values.yaml:

# Operator configuration
operator:
  replicas: 2
  resources:
    limits:
      memory: 512Mi
      cpu: 1000m
    requests:
      memory: 256Mi
      cpu: 100m

# Dashboard configuration
dashboard:
  replicas: 2
  service:
    type: ClusterIP
    port: 8080

# Logging
logging:
  level: info
  format: json

Install with values:

$ helm install ktube ktube/ktube \
--namespace ktube-system \
--create-namespace \
-f values.yaml

Common Configuration Options

ParameterDescriptionDefault
operator.replicasOperator replicas1
operator.image.tagOperator image taglatest
dashboard.replicasDashboard replicas1
logging.levelLog levelinfo

Upgrade

$ helm repo update
$ helm upgrade ktube ktube/ktube --namespace ktube-system

Uninstall

$ helm uninstall ktube --namespace ktube-system

Note: This keeps CRDs and your Tunnel resources. To remove CRDs:kubectl delete crd tunnels.ktube.dev tunnelproviders.ktube.dev tunnelbindings.ktube.dev

Next Steps