Setting up a deployment
This guide explains how to create and configure a new deployment within the Capacity Private Cloud environment. A deployment represents an isolated instance of the speech platform, complete with its own database connections, configuration, and service endpoints. Whether you are standing up your first environment or provisioning an additional deployment for development or testing, the steps below will walk you through the process from initial portal access to a fully configured deployment ready to accept traffic.
Prerequisites
Before creating a deployment, ensure the following requirements are met:
- A running Kubernetes cluster with the Capacity Private Cloud Helm chart installed.
- External services (Redis, PostgreSQL, and MongoDB) are provisioned and network-reachable from the cluster.
- DNS or host-file entries are configured on every machine that will access the Portal and APIs.
Configure Host Entries
Every machine that needs to reach the Portal or speech APIs must have the following host entries configured. Replace the IP address with the address of the VM or load balancer running the Capacity Private Cloud containers, and replace <hostnameSuffix> with the value configured in your Helm chart's values.yaml.
192.168.1.123 biometric-api.<hostnameSuffix>
192.168.1.123 reporting-api.<hostnameSuffix>
192.168.1.123 lumenvox-api.<hostnameSuffix>
192.168.1.123 admin-portal.<hostnameSuffix>
192.168.1.123 management-api.<hostnameSuffix>
192.168.1.123 deployment-portal.<hostnameSuffix>
192.168.1.123 reporting-bio-api.<hostnameSuffix>Note: The IP address 192.168.1.123 above is an example. Use the actual IP of the VM or load balancer that hosts your deployment.
Access the Admin Portal
Open a web browser and navigate to the Admin Portal using the hostname you configured above:
https://admin-portal.<hostnameSuffix>If this is a fresh installation with a self-signed TLS certificate, your browser may display a certificate warning. Accept the warning to proceed.
Create the Deployment
From the Admin Portal dashboard, click Create Deployment. You will be prompted to provide connection strings for the three external services that the platform requires.
Connection Strings
Enter the connection strings for each external service. The format for each is shown below. Replace the credentials, hostnames, and ports with the values specific to your environment.
Redis:
redis://:<password>@<host>:<port>PostgreSQL:
postgres://<user>:<password>@<host>:<port>/<database>?sslmode=disableMongoDB:
mongodb://<user>:<password>@<host>:<port>Example values (test environment only):
Redis: redis://:redis1234@10.128.0.47:6379
PostgreSQL: postgres://lvuser:postgres1234@10.128.0.47:5432/lumenvox_single_db?sslmode=disable
MongoDB: mongodb://lvuser:mongo1234@10.128.0.47:27017Important: The example credentials above are for illustration only. Always use strong, unique passwords in production environments. Never expose database credentials in documentation or version control.
Custom Deployment ID
The Custom Deployment ID field is optional. If left blank, the system will automatically generate a random GUID to identify this deployment. If your organization requires a specific identifier for tracking or integration purposes, you may enter one here.
Save and Verify
After completing all required fields:
- Review the connection strings to ensure they are correct and the external services are reachable from the cluster.
- Click Save to create the deployment.
- The new deployment will appear in the Admin Portal dashboard. Verify that its status indicates a successful connection to all three external services.
Tip: If the deployment fails to connect to one or more external services, verify network connectivity from inside the cluster using kubectl exec to run basic connectivity checks (e.g., ping, telnet, or curl) against the service hosts and ports.
