Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
109 lines
5.4 KiB
Plaintext
109 lines
5.4 KiB
Plaintext
---
|
|
title: "Calls Deployment on Kubernetes"
|
|
---
|
|
<PlanAvailability slug="all-commercial" />
|
|
|
|
This guide provides detailed information for deploying Mattermost Calls on Kubernetes environments.
|
|
|
|
## Overview
|
|
|
|
Mattermost Calls has been designed to integrate with Kubernetes for improved scalability and control over the deployment. Using the RTCD service is the only supported deployment model.
|
|
|
|
## Architecture
|
|
|
|

|
|
|
|
This diagram shows how the RTCD standalone service can be deployed in a Kubernetes cluster. In this architecture:
|
|
|
|
1. Calls traffic is handled by dedicated RTCD pods
|
|
2. Scaling is managed through Kubernetes deployment configurations
|
|
3. Call recording and transcription is handled by the calls-offloader service (see [Calls Offloader Setup and Configuration](calls-offloader-setup.mdx))
|
|
|
|
If Mattermost isn't already deployed in your Kubernetes cluster and you want to use this deployment type, visit the [Kubernetes operator guide](/deployment-guide/server/deploy-kubernetes).
|
|
|
|
## Helm Chart Deployment
|
|
|
|
The recommended way to deploy Calls-related components in a Kubernetes environment is to use the officially provided Helm charts:
|
|
|
|
### RTCD Helm Chart
|
|
|
|
The RTCD Helm chart deploys the RTCD service needed for call media handling:
|
|
|
|
```bash
|
|
helm repo add mattermost https://helm.mattermost.com
|
|
helm repo update
|
|
|
|
helm install mattermost-rtcd mattermost/mattermost-rtcd \
|
|
--set service.annotations."service\\.beta\\.kubernetes\\.io/aws-load-balancer-backend-protocol"=udp
|
|
```
|
|
|
|
For complete configuration options, see the [RTCD Helm chart documentation](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-rtcd).
|
|
|
|
### Calls-Offloader Helm Chart
|
|
|
|
If you need call recording and transcription capabilities, deploy the calls-offloader service:
|
|
|
|
```bash
|
|
helm install mattermost-calls-offloader mattermost/mattermost-calls-offloader \
|
|
--set ingress.enabled=true \
|
|
--set ingress.host=calls-offloader.example.com
|
|
```
|
|
|
|
For complete configuration options, see the [Calls-Offloader Helm chart documentation](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-calls-offloader).
|
|
|
|
## Kubernetes-Specific Configuration
|
|
|
|
### Network Configuration
|
|
|
|
For Kubernetes deployments, you need to ensure specific connectivity paths:
|
|
|
|
1. **Client to RTCD connectivity**: UDP and TCP traffic on port 8443 is properly routed from clients to RTCD pods (for media, with TCP acting as a fallback).
|
|
2. **Mattermost to RTCD API connectivity**: There needs to be a clear connectivity path between Mattermost and RTCD on the API port (TCP 8045)
|
|
3. **Network policies**: Network policies must allow the required communications between Mattermost and RTCD services
|
|
|
|
### Resource Requirements
|
|
|
|
Resource requirements for RTCD pods depend heavily on the expected call volume, participant count, and whether screen sharing is used.
|
|
|
|
We strongly recommend reviewing the [Performance Baselines](calls-metrics-monitoring.mdx#performance-baselines) to determine the appropriate CPU, memory, and network requests and limits for your specific deployment needs rather than relying on generic defaults.
|
|
|
|
### Scaling Considerations
|
|
|
|
Horizontal scaling of RTCD pods is possible, but remember:
|
|
|
|
1. Each call is hosted entirely on a single RTCD pod
|
|
2. DNS A records should be set up for all RTCD pods so server can discover RTCD servers.
|
|
3. Health checks should ensure that only healthy pods are reported via DNS
|
|
4. Calls remain on their assigned pod for their entire duration
|
|
|
|
### Limitations
|
|
|
|
Due to the inherent complexities of hosting a WebRTC service, some limitations apply when deploying Calls in a Kubernetes environment.
|
|
|
|
One key requirement is that each `rtcd` process must live in a dedicated Kubernetes node. This is necessary to forward the data correctly while allowing for horizontal scaling. Data should generally direct directly to the pod running the `rtcd` process, as routing this traffic through a standard ingress is not recommended for RTCD deployments.
|
|
|
|
The general recommendation is to expose one external IP address per `rtcd` instance (Kubernetes node). This makes it simpler to scale as the application is able to detect its own external address (through STUN) and advertise it to clients to achieve connectivity with minimal configuration.
|
|
|
|
## Monitoring and Metrics
|
|
|
|
For detailed information on metrics collection and monitoring, see the [Calls Metrics and Monitoring](calls-metrics-monitoring.mdx) guide.
|
|
|
|
## Troubleshooting
|
|
|
|
For Kubernetes-specific troubleshooting:
|
|
|
|
1. Check pod logs: `kubectl logs -f deployment/mattermost-rtcd`
|
|
2. Verify service connectivity: `kubectl port-forward service/mattermost-rtcd 8045:8045`
|
|
3. Ensure UDP and TCP traffic is properly routed through your load balancer
|
|
4. Verify network policies allow required communication paths
|
|
|
|
For detailed logging guidance, see the [Calls Logging](calls-logging.mdx) guide.
|
|
|
|
## Other Calls Documentation
|
|
|
|
- [Calls Deployment Guide](calls-deployment-guide.mdx): Overview of deployment options and architecture
|
|
- [RTCD Setup and Configuration](calls-rtcd-setup.mdx): Comprehensive guide for setting up the dedicated RTCD service
|
|
- [Calls Offloader Setup and Configuration](calls-offloader-setup.mdx): Setup guide for call recording and transcription
|
|
- [Calls Metrics and Monitoring](calls-metrics-monitoring.mdx): Guide to monitoring Calls performance using metrics and observability
|
|
- [Calls Logging](calls-logging.mdx): Detailed guidance for collecting Calls logs and client diagnostics
|