Restore Azure Blob Storage + ID-attribute docs, fix nav description#9096
Conversation
PR #8976 (merged for v11.9.0) was accidentally reverted by the "V11.8 Docs" merge (#8974), which removed both the azure-blob-storage.rst walk-through page and the Azure sections in environment-configuration-settings.rst. This restores that content and adds the nav entry with corrected, action-oriented wording. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01739QHYVMKh6R81gcqEfGgP
The bullet-list entry alone isn't enough for Sphinx to include the page in the nav sidebar; it also needs to be listed in the toctree directive, which was dropped by the same revert. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01739QHYVMKh6R81gcqEfGgP
PR #9020 was accidentally reverted from master by the "V11.8 Docs" merge (#8974), which removed the case-sensitivity notes for the AD/LDAP ID attribute, AD/LDAP Group ID attribute, and SAML ID attribute settings. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01739QHYVMKh6R81gcqEfGgP
amyblais
changed the title
There was a problem hiding this comment.
Pull request overview
Restores and re-links Mattermost documentation for using Azure Blob Storage as a file storage backend after prior merges inadvertently removed the walk-through page and related configuration reference content.
Changes:
- Restores the Azure Blob Storage walk-through page (
azure-blob-storage.rst) and adds it back to Server Configuration navigation. - Reintroduces and updates Azure Blob Storage entries in the Environment configuration reference, including
azureblobdriver details and Azure-specific settings. - Updates export filestore documentation to include Azure export settings and presigned/SAS URL behavior.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| source/administration-guide/manage/admin/server-configuration.rst | Adds the Azure Blob Storage walk-through page to the Server Configuration nav (toctree + bullet list). |
| source/administration-guide/configure/environment-configuration-settings.rst | Restores Azure Blob Storage support in file storage reference, adds Azure-specific settings, and updates export filestore notes to include Azure. |
| source/administration-guide/configure/azure-blob-storage.rst | Restores the full Azure Blob Storage walk-through (provisioning, auth modes, configuration, verification, migration notes, troubleshooting). |
|
Newest code from mattermost has been published to preview environment for Git SHA 8fa1439 |
|
Newest code from mattermost has been published to preview environment for Git SHA 9f30059 |
|
Warning Review limit reached
Next review available in: 51 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds administration documentation for configuring Mattermost with Azure Blob Storage, including authentication, settings, migration, export storage, troubleshooting, environment mappings, and navigation. ChangesAzure Blob Storage documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/administration-guide/configure/azure-blob-storage.rst`:
- Around line 102-104: Update the prerequisite note near the role assignment
instructions to include Role Based Access Control Administrator alongside User
Access Administrator and Owner as valid roles for running az role assignment
create; retain the existing Contributor limitation and scope guidance.
- Around line 75-76: Update the Non-Azure host or container guidance in the
Azure Blob Storage configuration table to require injecting service-principal
secrets and certificate paths at runtime through a secret manager, while warning
against plaintext manifests and shell history. Add guidance to rotate
credentials and prefer managed or workload identity when available.
- Line 147: The local-disk migration guidance at
source/administration-guide/configure/azure-blob-storage.rst lines 147-147 must
provide a runnable azcopy command, explain the required Azure authentication
setup, and specify pre-cutover validation that confirms uploaded files are
present at the expected keys. Update the troubleshooting guidance at
source/administration-guide/configure/azure-blob-storage.rst lines 201-201 to
repeat or link to this same verified migration procedure before administrators
switch the driver.
- Around line 97-100: Update the az role assignment create example to use the
service principal object ID rather than the application ID. Replace the current
--assignee placeholder with the appropriate object-ID form, preferably using
--assignee-object-id together with --assignee-principal-type ServicePrincipal,
while preserving the existing role and scope arguments.
- Around line 71-74: Update the AKS workload-identity guidance in the Azure Blob
Storage configuration document to include enabling the OIDC issuer, creating a
federated identity credential, annotating the Mattermost ServiceAccount with the
client ID, and adding azure.workload.identity/use: "true" to the pod template.
Revise the role-assignment example’s system-assigned wording so it accurately
reflects AKS pod workload identities.
In
`@source/administration-guide/configure/environment-configuration-settings.rst`:
- Around line 2018-2035: Update the azureblob description in the “File storage
system” documentation to state that required fields depend on the selected
authentication mode: account name and container are needed, while the shared
storage key is only required when using key-based authentication;
default_credential can authenticate through Entra ID without AzureAccessKey.
- Around line 2559-2565: Update the credential-order description for
default_credential to state that DefaultAzureCredential checks Environment,
Workload Identity, Managed Identity, Azure CLI, Azure Developer CLI, then Azure
PowerShell, with the first available credential selected. Replace the current
ordering and remove the inaccurate placement of service-principal environment
variables while preserving the surrounding deployment guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f3271eda-88ad-43af-9518-63ab0141204d
📒 Files selected for processing (3)
source/administration-guide/configure/azure-blob-storage.rstsource/administration-guide/configure/environment-configuration-settings.rstsource/administration-guide/manage/admin/server-configuration.rst
Summary
Two PRs were accidentally reverted from
masterby the "V11.8 Docs" merge (#8974), whose stale branch stripped recently-merged content:configure/azure-blob-storage.rstand the Azure sections ofenvironment-configuration-settings.rst... note::blocks (AD/LDAP ID, AD/LDAP Group ID, SAML ID) fromauthentication-configuration-settings.rst.This restores all of that content onto current
master(preserving later July changes):source/administration-guide/configure/azure-blob-storage.rstverbatim from reviewed MM-68718: Document Azure Blob Storage as a file storage backend #8976.environment-configuration-settings.rst.authentication-configuration-settings.rst.server-configuration.rst, with the corrected, action-oriented description text from review feedback.Supersedes #9095, which only added nav links on a different branch without restoring the underlying page/content those links point to.
Test plan
azure-blob-storage.rstrenders without warnings and appears in the Server Configuration nav.azure-blob-storage.rstandenvironment-configuration-settings.rstresolve correctly.authentication-configuration-settings.rst.