Quick Start

Add Helm Repository

$
helm repo add smallest-self-host https://smallest-inc.github.io/smallest-self-host
$
helm repo update

Create Namespace

$
kubectl create namespace smallest
$
kubectl config set-context --current --namespace=smallest

Configure Values

Create a values.yaml file:

1
global:
2
  licenseKey: "your-license-key-here"
3
  imageCredentials:
4
    create: true
5
    registry: quay.io
6
    username: "your-registry-username"
7
    password: "your-registry-password"
8
    email: "your-email@example.com"
9
10
models:
11
  asrModelUrl: "your-model-url-here"
12
13
scaling:
14
  replicas:
15
    lightningAsr: 1
16
    licenseProxy: 1
17
18
lightningAsr:
19
  nodeSelector:
20
  tolerations:
21
22
redis:
23
  enabled: true
24
  auth:
25
    enabled: true

Install

$
helm install smallest-self-host smallest-self-host/smallest-self-host \
>
  -f values.yaml \
>
  --namespace smallest

Monitor the deployment:

$
kubectl get pods -w

Verify Installation

$
kubectl get pods,svc

All pods should show Running status with the following services available:

Test the API

Port forward and send a health check:

$
kubectl port-forward svc/api-server 7100:7100

$
curl http://localhost:7100/health

Autoscaling

Enable automatic scaling based on real-time inference load:

1
scaling:
2
  auto:
3
    enabled: true

This deploys HorizontalPodAutoscalers that scale based on active requests:

How It Works

1. Lightning ASR exposes asr_active_requests metric on port 9090
2. Prometheus scrapes this metric via ServiceMonitor
3. Prometheus Adapter makes it available to the Kubernetes metrics API
4. HPA scales pods when average requests per pod exceeds target

Configuration

1
scaling:
2
  auto:
3
    enabled: true
4
    lightningAsr:
5
      hpa:
6
        minReplicas: 1
7
        maxReplicas: 10
8
        targetActiveRequests: 4

Verify Autoscaling

$
kubectl get hpa

NAME            REFERENCE                  TARGETS   MINPODS   MAXPODS   REPLICAS
lightning-asr   Deployment/lightning-asr   0/4       1         10        1
api-server      Deployment/api-server      1/2       1         10        1

The TARGETS column shows current/target. When current exceeds target, pods scale up.

Helm Operations

$
helm upgrade smallest-self-host smallest-self-host/smallest-self-host \
>
  -f values.yaml -n smallest

Troubleshooting

For detailed troubleshooting, see Troubleshooting Guide.

Next Steps