LumenVox Kubernetes Helm Charts

This code is provided as-is with no warranties

Usage

Helm must be installed to use charts. Please refer to Helm's documentation to get started

Prerequisites

• Kubernetes 1.26.4 (and below)
• Helm 3+

Get Repo Info

Once Helm is set up correctly, add the repo as shown here:

helm repo add lumenvox https://lumenvox.github.io/helm-charts
helm repo update

See helm repo for command documentation.

You can then run helm search repo lumenvox to see the charts

See helm search repo for details

Contributing

We'd love to have you contribute! Please contact us for details

LumenVox Chart

The LumenVox chart serves as a root chart through which various combinations of products can be managed. Using this chart, you can install our Speech stack, our Voice Biometrics stack, or both.

To install the LumenVox chart using Helm, you should contact LumenVox first and obtain license and configuration information that is needed before you can start.

You will also need to provision the following, ideally in a hosted cloud environment for production, but locally can be used during testing or development:

• Postgres Database
• MongoDB Database
• Redis
• RabbitMQ

See the Dependencies section below for important details

Configuration

You will need to work with your LumenVox account manager and the support team before running LumenVox application in Kubernetes. This is needed to provide you with the necessary license configuration as well as overall system configuration steps

NOTE

When making us of a custom DNS hostname suffix please be sure to enter the full suffix as pet the example below: .domain-name.com

To see all configurable options, visit the chart's values.yaml, or run the following:

helm show values lumenvox/lumenvox

Installation

helm install lumenvox lumenvox/lumenvox -f my-lumenvox-values.yaml -n lumenvox

See helm install for command documentation.

Uninstallation

helm delete lumenvox

This removes all the Kubernetes components associated with the chart and deletes the release.

Voice-Biometrics Chart

This chart can be used to install the voice biometrics stack. This has been migrated to a subchart of the LumenVox chart, and it will be deprecated in the near future.

To install LumenVox Voice Biometrics using Helm, you should contact LumenVox first and obtain license and configuration information that is needed before you can start.

You will also need to provision the following, ideally in a hosted cloud environment for production, but locally can be used during testing or development:

• Postgres Database
• MongoDB Database
• Redis
• RabbitMQ

See the Dependencies section below for important details

Configuration

You will need to work with your LumenVox account manager and the support team before running LumenVox application in Kubernetes. This is needed to provide you with the necessary license configuration as well as overall system configuration steps

To see all configurable options, visit the chart's values.yaml, or run the following:

helm show values lumenvox/voice-biometrics

Installation

helm install lumenvox-vb lumenvox/voice-biometrics -f my-lumenvox-values.yaml -n lumenvox

See helm install for command documentation.

Uninstallation

helm delete lumenvox-vb

Dependencies

The following dependencies can optionally be installed:

  - name: "redis"
    version: 7.0.13
    repository: "https://charts.bitnami.com/bitnami"

  - name: "mongodb"
    version: 5.0.16
    repository: "https://charts.bitnami.com/bitnami"

  - name: "rabbitmq"
    version: 3.9.16
    repository: "https://charts.bitnami.com/bitnami"

  - name: "postgresql"
    version: 13
    repository: "https://charts.bitnami.com/bitnami"

  - name: "grafana"
    version: 7
    repository: "https://charts.bitnami.com/bitnami"

Note that these dependencies are provided for setting up a test environment only.

We recommend that when creating a production environment, you provision your own cloud-hosted services to replace these test dependencies, which are not configured for persistence or scale.

Each of these dependencies can be disabled in the values.yaml file in their respective sections. For example, to disable the redis dependency when using your own, set the redis.enabled setting to false in your values.yaml file. The same can be done for all of these dependencies, allowing you to easily use the LumenVox Helm Charts in either test or production configurations.

To configure Grafana for monitoring, when setting up the test environment with the optional dependencies enabled, log into Grafana and specify a dashboard to use with Prometheus monitoring, for example:

• 12740 (Select Prometheus at the bottom) - Kubernetes Monitoring Dashboard

Testing Environment: Minimum Resource Requirements

Provided below are the minimum requirements for a testing/lab environment. For production environments, please contact LumenVox for assistance with sizing.

Cluster Resources

• LumenVox Speech: minimum of 3 nodes with at least 8CPUs and 16GB memory each.
• LumenVox Voice Biometrics: minimum of 3 node with at least 8CPUs and 16GB memory.

External Resources

	RabbitMQ	MongoDB	Postgres	Redis	Persistent Storage
CPU	1	2	2	-	-
Memory	2GB	16GB	8GB	5GB	-
Boot Disk Size	10GB	10GB	10GB	-	-
Data Storage	-	300GB	30GB	-	300 GB