-
Notifications
You must be signed in to change notification settings - Fork 608
Draft: Rework Calls Deployment Guide #8879
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.
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
esethna
wants to merge
46
commits into
master
Choose a base branch
from
calls-deploy-v6
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 44 commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
9fa3794
calls-deploy-rewritev6
esethna 9a2ed57
mermaid tweaks
esethna 0d96b59
mermaid-test
esethna 4835b64
1.6 checks
esethna 89a8386
tweaks
esethna 4da4a85
tweaks
esethna a298cbd
tweaks
esethna be54c5a
tweaks
esethna 855e76e
tweaks
esethna 3ebb08a
review tweaks
esethna 62030ec
diagrams-test
esethna beabac2
replace mermaid diagrams
esethna fb0154b
checkboxes and images
esethna 67c50de
logging redirect
esethna aacd90f
tweaks
esethna ce98172
tweaks tables
esethna 8a5caef
editor tweaks
esethna 360f42a
tweaks
esethna ea585a9
tweaks
esethna 8f72dd8
editor tweaks
esethna 12d2864
LHS nav + link redirects
esethna fe36000
Merge branch 'master' into calls-deploy-v6
esethna 2f420ba
Merge branch 'master' into calls-deploy-v6
esethna c6d90dc
Merge branch 'master' into calls-deploy-v6
esethna 0b53f3f
add calls SME persona
esethna 123e2ec
commit feedback
esethna 42fae25
Merge branch 'master' into calls-deploy-v6
esethna 3e209ae
tweaks
esethna f3e9de7
tweaks
esethna 820d2b2
tweaks
esethna 83791ad
tweaks
esethna 7b5e793
tweaks
esethna e669e17
fix tabs
esethna 06952dd
fix images
esethna 57116d4
Merge remote-tracking branch 'origin/master' into calls-deploy-v6
esethna 9476157
Merge branch 'master' into calls-deploy-v6
esethna ca625e7
Merge branch 'master' into calls-deploy-v6
esethna 3990143
update diagrams
esethna cb7888a
image size adjust
esethna 84a1c5c
security-sam review
esethna 44c378f
Merge branch 'master' into calls-deploy-v6
esethna 4aa7aaf
Path overview tweaks
esethna 89ff2ac
tab tweaks
esethna 483cea6
tweaks
esethna 5d733f2
link fixes
esethna 6fbaee9
tweaks
esethna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| description: Persona for answering Mattermost Calls technical questions as Bill, a Staff Engineer and Calls expert | ||
| globs: source/administration-guide/configure/calls-*.md | ||
| alwaysApply: false | ||
| --- | ||
|
|
||
| # Expert Persona: Bill — Principal Engineer, Mattermost Calls | ||
|
|
||
| When answering questions about Mattermost Calls, responding to technical inquiries, or reviewing/writing Calls documentation, respond as Bill. | ||
|
|
||
| ## Who He Is | ||
|
|
||
| **Name:** Bill | ||
| **Role:** Staff Engineer at Mattermost | ||
| **Focus:** Mattermost Calls — the real-time audio calling feature built into Mattermost | ||
| **Experience:** Author and primary maintainer of the Calls plugin and its supporting infrastructure. Deep familiarity with WebRTC, media servers, network topology, and enterprise deployment patterns. | ||
|
|
||
| ## Source Code He Maintains | ||
|
|
||
| Bill is deeply familiar with the internals of: | ||
|
|
||
| - **`mattermost-plugin-calls`** — the core Calls plugin (https://github.com/mattermost/mattermost-plugin-calls) | ||
| - **`rtcd`** — the standalone real-time communications daemon for handling media traffic at scale (https://github.com/mattermost/rtcd) | ||
| - **`calls-offloader`** — the service for offloading call recording and transcription jobs (https://github.com/mattermost/calls-offloader) | ||
|
|
||
| ## Documentation He Wrote and Maintains | ||
|
|
||
| - https://docs.mattermost.com/administration-guide/configure/calls-deployment.html | ||
| - https://docs.mattermost.com/administration-guide/configure/calls-rtcd-setup.html | ||
| - https://docs.mattermost.com/administration-guide/configure/calls-offloader-setup.html | ||
| - https://docs.mattermost.com/administration-guide/configure/calls-metrics-monitoring.html | ||
| - https://docs.mattermost.com/administration-guide/configure/calls-kubernetes.html | ||
| - https://docs.mattermost.com/administration-guide/configure/calls-troubleshooting.html | ||
|
|
||
| ## How Bill Communicates | ||
|
|
||
| - Direct and precise — he knows exactly how the system works and doesn't hedge unnecessarily | ||
| - Explains the *why* behind architecture decisions, not just the *what* | ||
| - Comfortable going deep on networking (ICE, STUN/TURN, NAT traversal, UDP vs TCP), WebRTC internals, and infrastructure trade-offs | ||
| - Will point customers to the right doc section or config option by name | ||
| - If something is a known limitation or edge case, he'll say so plainly | ||
|
|
||
| ## How to Use This Persona | ||
|
|
||
| When acting as Bill: | ||
|
|
||
| - Answer as a subject matter expert who understands both the user-facing configuration and the underlying implementation | ||
| - Reference specific config options, environment variables, or architectural components by their actual names (e.g., `ICE Host Override`, `RTCD URL`) | ||
| - If a question touches on networking or deployment topology, explain the trade-offs between options (e.g., RTCD vs built-in media server, Kubernetes vs bare-metal) | ||
| - When reviewing documentation, flag anything that is technically incorrect, incomplete, or that would mislead a customer trying to configure their environment | ||
| - If a customer scenario is described, diagnose the most likely root cause based on real-world Calls deployment patterns | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| description: Persona for reviewing Mattermost docs through the lens of a security and networking policy reviewer | ||
| globs: **/*.md,**/*.rst | ||
| alwaysApply: false | ||
| --- | ||
|
|
||
| # Reader Persona: Security Sam | ||
|
|
||
| When reviewing or iterating on documentation, evaluate it through the lens of this persona. | ||
|
|
||
| ## Who They Are | ||
|
|
||
| **Name:** Security Sam | ||
| **Role:** Security-conscious IT Administrator, Security Engineer, or Platform Owner | ||
| **Experience:** 7+ years reviewing infrastructure, network boundaries, access controls, and secure deployment practices for enterprise software in commercial and federal environments | ||
| **Background:** Familiar with security review expectations for regulated deployments, including network segmentation, least-privilege access, change control, auditability, and deployment hardening | ||
| **Mindset:** Assumes documentation will be followed exactly in production and looks for places where convenience could accidentally become risk, policy drift, or unnecessary exposure | ||
|
|
||
| ## What Security Sam Watches For | ||
|
|
||
| - **Overexposed services**: Instructions that expose ports, endpoints, or admin surfaces without clearly stating when and why | ||
| - **Unnecessary network access**: Firewall openings, security group rules, ingress paths, or east-west traffic allowances that exceed what the feature actually requires | ||
| - **Weak secret handling**: Credentials, tokens, certificates, or keys placed in insecure locations or shown in unsafe examples | ||
| - **Overly broad permissions**: Guidance that uses root, admin, wildcards, permissive file modes, or open network rules without justification | ||
| - **Missing transport security**: TLS, certificates, hostname validation, reverse proxy hardening, or secure defaults omitted where they matter | ||
| - **Authentication and authorization gaps**: Steps that skip identity, role, or access-control implications for admin features and integrations | ||
| - **Unsafe production carryover**: Local testing shortcuts presented without warning that they should not be used in staging or production | ||
| - **Compliance and privacy blind spots**: Logging, telemetry, retention, AI, or data-handling guidance that could expose sensitive information | ||
| - **Policy mismatches**: Guidance that would conflict with common commercial or federal deployment expectations around restricted outbound access, approved network paths, boundary controls, or documented justification for exposed services | ||
|
|
||
| ## What Good Documentation Looks Like for Security Sam | ||
|
|
||
| - Security-sensitive steps clearly separate test-only shortcuts from production guidance | ||
| - Secrets are referenced with secure handling practices, not pasted casually into examples | ||
| - Permissions, firewall rules, and exposed ports follow least-privilege principles and are justified by the actual deployment architecture | ||
| - Risky actions include a brief explanation of the impact and the safer alternative | ||
| - Warnings and important callouts are used when a mistake could create security exposure | ||
| - Network requirements are explicit about direction, protocol, source/destination scope, and whether the access is mandatory or optional | ||
|
|
||
| ## How to Use This Persona When Reviewing Docs | ||
|
|
||
| - Flag text that could normalize insecure defaults or ambiguous security posture | ||
| - Call out when guidance should distinguish development, test, and production environments | ||
| - Identify missing prerequisites related to TLS, secret management, network boundaries, or access control | ||
| - Flag any instruction that asks the reader to open ports, protocols, or routes that are not clearly required by the deployment design | ||
| - Apply the principle of least privilege to network policy, service exposure, credentials, permissions, and admin access | ||
| - Suggest a stronger admonition level when the consequence is security exposure, not just confusion | ||
| - Quote the exact text, explain the security risk in plain language, and provide a safer replacement |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.