mirror of
https://github.com/hanzoai/team.git
synced 2026-11-01 07:55:31 +00:00
b5f007d35e
* docs: resolve cross-file anchor mismatches from RST-to-MDX migration
The Sphinx-to-Docusaurus migration converted `:ref:`/`{ref}` links using
naive text-slugification, so anchors that pointed to headings in a
different file (e.g. release-summary tables linking into their
respective changelog pages) were emitted as same-page fragments and
silently resolved to nothing.
Built a label registry from the original Sphinx `.. _label:` / `(label)=`
targets to recover the true source file for each cross-reference, then
rewrote the affected links to point at the correct file + heading
anchor. Fixes 282 broken cross-file anchors, primarily in the mobile/
desktop/server release-summary pages, plus assorted same-page anchor
mismatches caught by re-auditing after the prior admonition/anchor fix.
* docs: manually resolve remaining anchor mismatches after cross-file audit
Hand-verified fixes for anchors that fuzzy-matching alone couldn't
safely resolve (confirmed against actual heading text/context, and in a
few cases against the original RST source, before applying):
- Typos and dropped words carried over from the original Sphinx docs
(e.g. "bot-acocunts", "auto-follow-all-new-channel-threads" ->
"follow-all-new-channel-threads").
- Sphinx auto-generated duplicate-heading IDs (#id1/#id3/#id4) resolved
to their real target headings.
- Numbered-step TOC links in enterprise-roll-out-checklist.mdx that
dropped the leading "N. " used in the actual heading slugs.
- Push-notification docs pointing at the wrong file entirely
(environment-configuration-settings instead of
push-notification-server-configuration-settings).
- SAML "saml-enterprise" label resolved to its true cross-file target
(authentication-configuration-settings#saml-2-0), recovered from the
original RST label definition that the automated registry missed
because it sat after an RST transition marker.
- sso-saml-technical references converted from broken same-page/
malformed-path anchors to correct page links.
* docs: fix SAML 2.0 anchor slug (saml-2-0 -> saml-20)
github-slugger strips periods rather than hyphenating them, so "SAML
2.0" slugifies to saml-20, not saml-2-0 as previously fixed.
* docs: fix broken path links found during docs/main migration cleanup
* docs: convert div.tab blocks to Docusaurus Tabs/TabItem components
* docs: restore missing Kubernetes deployment architecture diagrams
The RST-to-MDX migration never copied over the AWS/Azure/Oracle
architecture diagrams referenced by the deployment-architecture-at-scale
page, leaving broken images in each Tabs/TabItem.
* docs: fix 7 anchor mismatches from the fragment/heading audit
Covers three root causes from the anchor mismatch breakdown:
- Fragment repeated the target page's own title instead of a real
heading, so the link is simplified to point at the bare page.
- Heading exists verbatim but lives on a sibling settings page
(experimental-configuration-settings, push-notification-server-
configuration-settings) rather than environment-configuration-settings.
- A page path was mistakenly pasted into a same-page #fragment instead
of being used as a real cross-page link.
* docs: fix 8 anchor slugs that were close but didn't match the real heading
Repoints links whose fragment was a plausible guess (typo, reworded
heading, or wrong section) at the actual auto-generated slug of the
target heading, confirmed by inspecting each target page directly.
* docs: merge split Tabs blocks so tabs render horizontally
The div.tab conversion script split some sibling tab groups into
separate single-item Tabs blocks whenever a stray blockquote marker
sat between them, causing them to render stacked instead of as one
horizontal tab bar. Merges the MySQL/PostgreSQL and Team/Enterprise
Edition tab groups back into single Tabs blocks.
* docs: remove Azure tab and restore Kubernetes deploy content
The Mattermost Operator, Azure, and Oracle platform tabs on the
Kubernetes deployment guide were split across two separate Tabs
blocks (rendering stacked instead of as one tab bar) and all three
tab bodies were empty because the migration never flattened the
original RST include directives. Removes the unsupported Azure tab
and restores the Mattermost Operator and Oracle content from the
pre-migration RST sources as a single merged Tabs block.
* addresscoderabbitreview
* docs: unify Linux/Kubernetes/Containers deploy pages and fix FIPS/STIG placement
Kubernetes and Containers duplicated full install content across a top-level
page (Tabs) and orphaned sidebar subpages that nothing linked to. Reworked
both to follow the Linux page's pattern: shared content on the landing page,
platform-specific instructions live once in their own subpage.
Also removed configure-fips-at-install-time.mdx, which claimed FIPS is
available for native Linux installs — FIPS/STIG in Mattermost is a container
image property (Chainguard-based build), not available outside Docker/
Kubernetes. Consolidated all FIPS/STIG references onto
containers/fips-stig.mdx and pointed the Mattermost Operator subpage (not
Oracle OKE, which doesn't expose image selection) at it.
* docs: fix review findings — image alt text, Important callout markup, typo
- Replace generic alt="image" on scaling diagrams with descriptive text
identifying cloud provider and user scale.
- Convert raw div.important markup in deploy-containers.mdx to the
repo's <Important> component, matching usage elsewhere in the file.
- Fix "Matermost" typo in manage-your-display-options.mdx.
---------
Co-authored-by: Hanzo Dev <[email protected]>
109 lines
5.6 KiB
Plaintext
109 lines
5.6 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](/administration-guide/configure/calls-metrics-monitoring#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](/administration-guide/configure/calls-metrics-monitoring) 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](/administration-guide/configure/calls-rtcd-setup): 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](/administration-guide/configure/calls-metrics-monitoring): Guide to monitoring Calls performance using metrics and observability
|
|
- [Calls Logging](calls-logging.mdx): Detailed guidance for collecting Calls logs and client diagnostics
|