Skip to content

MM-68718: Document Azure Blob Storage as a file storage backend#8976

Draft
agarciamontoro wants to merge 3 commits into
masterfrom
MM-67096-azure-blob-storage-docs
Draft

MM-68718: Document Azure Blob Storage as a file storage backend#8976
agarciamontoro wants to merge 3 commits into
masterfrom
MM-67096-azure-blob-storage-docs

Conversation

@agarciamontoro
Copy link
Copy Markdown
Member

@agarciamontoro agarciamontoro commented May 15, 2026

Summary

Documents the new Azure Blob Storage filestore backend. Two layers:

  1. Reference (source/administration-guide/configure/environment-configuration-settings.rst):

    • Adds the azureblob driver-name option.
    • Adds individual entries for each Azure setting -- storage account, container, path prefix, shared key, endpoint, SSL, and request timeout.
    • Extends the Enable dedicated export filestore target list with the matching ExportAzure* keys.
    • Adds a seealso pointer from the File storage section to the walk-through page below.
  2. Walk-through (source/administration-guide/configure/azure-blob-storage.rst, new):

    • Prerequisites.
    • Step-by-step Azure portal and az CLI commands for creating the storage account, container, and retrieving the shared key.
    • System Console field-by-field configuration with Test Connection semantics.
    • Restart-required warning (pointing to MM-68816).
    • "Switching driver doesn't migrate existing files" caveat.
    • Verification steps including the blob layout admins should expect in the container.
    • Optional export backend pointer.
    • Troubleshooting table.

Both pages are wired into the existing configure/configuration-settings.rst toctree and bullet list so they're discoverable.

Ticket Link

Notes for reviewers

  • Stays in Draft until the code-side PRs land.
  • This branch is the source of truth for everything docs-related on the Azure Blob Storage rollout. Migration content from S3 (tracked in MM-68817) will be added here.
  • The restart-required warning is included because the file backend currently doesn't hot-reload on config change (MM-68816). When that ticket ships, both the inline note and the warning block in the walk-through can be dropped.
  • Walk-through placement is intentionally in configure/ next to the reference; if the docs team prefers it under deployment-guide/ instead, easy to move.

Adds Azure Blob Storage to the File storage system reference: a new
azureblob driver-name option and individual entries for the
FileSettings.AzureStorageAccount, AzureContainer, AzurePathPrefix,
AzureAccessKey, AzureEndpoint, AzureSSL, and
AzureRequestTimeoutMilliseconds settings. Extends the dedicated export
filestore list with the matching Export* variants.

Calls out the restart-required behaviour when changing file storage
settings so admins know Save in System Console isn't enough on its
own.

------
AI assisted commit
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 08315ba

@agarciamontoro agarciamontoro changed the title Document Azure Blob Storage as a file storage backend MM-68718: Document Azure Blob Storage as a file storage backend May 15, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 71cd497

@esethna esethna added this to the v11.8.0 milestone May 16, 2026
Folds the full prereqs, Azure portal/CLI provisioning, System Console
walk-through, Test Connection semantics, restart-required warning,
verification, optional export backend, and troubleshooting sections
into a dedicated configure/azure-blob-storage page.

Wires the new page into the configuration-settings toctree and bullet
list, and adds a seealso link from the File storage section of
environment-configuration-settings so admins can find it from the
reference page.

------
AI assisted commit
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA eaa2e51

@Combs7th Combs7th added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor labels May 20, 2026
@Combs7th
Copy link
Copy Markdown
Contributor

Thank you for the docs, @agarciamontoro! Is there a dev who you can recommend we tag to be the technical reviewer for this one?

@agarciamontoro
Copy link
Copy Markdown
Member Author

Hey, @Combs7th, I'll assign someone as soon as this is ready for review. For now, it's just an info dump of everything in progress, I'm still waiting for some PRs to be merged. Will move the PR to ready for review and assign a dev when it's done, thanks!

@agarciamontoro
Copy link
Copy Markdown
Member Author

This will ship in v11.9, btw, not in v11.8

@agarciamontoro agarciamontoro removed this from the v11.8.0 milestone May 20, 2026
Adds a Migrate existing files from Amazon S3 section to the Azure
Blob Storage walk-through. Covers the recommended trickle-then-cutover
pattern (long rclone sync, short AzCopy maintenance window), the
prerequisites for the migration host, phase-by-phase commands,
verification queries (object count parity, sha256 spot-check), the
rollback path, and caveats (S3 versioning, sync vs copy, prefix
rewrites, cross-region cost, Storage Mover preview status).

Updates the migration note under step 4 and the troubleshooting entry
for missing pre-cutover files to cross-reference the new section.

------
AI assisted commit
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 9c68289

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants