Skip to content

Charts realtime docs updates #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smvenkateshc wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Charts realtime docs updates #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
bbeb7f9
Realtime charts docs
smvenkateshc Dec 18, 2025
55c6f9c
minor fix
smvenkateshc Dec 18, 2025
a8821ce
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
b68d7a8
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
c23fbcc
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
56072b4
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
1d9849d
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
9782bee
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
394c65d
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
5461eba
Update docs/deployments/kubernetes/realtime.mdx
smvenkateshc Dec 18, 2025
f09a7e6
Extra contents
smvenkateshc Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/deployments/kubernetes/prerequisites.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ import TabItem from '@theme/TabItem';

# Prerequisites

## Access to the Docker and Helm Registry
## Helm version

Ensure you are using Helm version 3.16.0
Copy link
Contributor

@owaisaamir owaisaamir Dec 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.16.0 is only a minimum version contstaint. It can be helm version >3.16.x but <4.x.


## Access to the docker and helm registry

:::info
It is important to create and reference resources within the same namespace if you do not have full control of your Kubernetes cluster or if it is a shared cluster
Expand All @@ -39,7 +43,7 @@ helm registry login speechmaticspublic.azurecr.io \
--password <password>
```

## Speechmatics License
## Speechmatics license

Please speak to `[email protected]` if you do not already have a valid Speechmatics license.

Expand All @@ -61,7 +65,7 @@ global:
license: $B64_ENCODED_LICENSE
```

## GPU Drivers
## GPU drivers

The Speechmatics inference server runs Nvidia Triton Server, which requires an Nvidia GPU. When running GPU nodes in Kubernetes, you will require the Nvidia device plugin which allows containers on the cluster to access the GPUs.

Expand All @@ -79,7 +83,9 @@ You can validate a node has allocatable GPU resources with:
kubectl get nodes -o yaml | yq .[].[].status.allocatable | grep nvidia
```

## Nginx Ingress Controller
## Ingress controller

### Nginx

When setting up Speechmatics via an ingress controller, it is recommended to use the `ingress-nginx` ingress controller with snippet annotations enabled. You can confirm if your cluster supports Nginx with snippet annotations enabled using the following command:

Expand Down Expand Up @@ -127,7 +133,7 @@ helm repo add nginx https://kubernetes.github.io/ingress-nginx
helm install nginx nginx/ingress-nginx --version 4.11.4 -f nginx.values.yaml
```

### Using Another Ingress Controller
### Using another ingress controller

If you are running another ingress controller, when enabling ingress on the chart, you need to ensure that a `Request-Id` header is passed through. This is used to manage session usage.

Expand Down
Loading