From 81fd93293df93f90076f4f4ba6e2f5c682392468 Mon Sep 17 00:00:00 2001
From: "Carrie Warner (Mattermost)"
<74422101+cwarnermm@users.noreply.github.com>
Date: Tue, 18 Mar 2025 16:07:16 -0400
Subject: [PATCH] Javascript to provide upgrade path guidance
---
source/upgrade/important-upgrade-notes.rst | 294 ++++++++++++++++++++-
1 file changed, 293 insertions(+), 1 deletion(-)
diff --git a/source/upgrade/important-upgrade-notes.rst b/source/upgrade/important-upgrade-notes.rst
index 6d944ffc50b..5d22d104721 100644
--- a/source/upgrade/important-upgrade-notes.rst
+++ b/source/upgrade/important-upgrade-notes.rst
@@ -4,7 +4,299 @@ Important Upgrade Notes
.. important::
.. include:: ../about/common-esr-support-rst.rst
-
+
+.. raw:: html
+
+
+
+
+
+
+
+
+
+
+
+
+
Upgrade Notes: v9.0 to v9.5
+
+
v9.5
+
+
Breaking Changes: Support for MySQL v5.7 has been discontinued due to its end of life. Customers are urged to upgrade their MySQL instance as soon as possible.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations: A safety limit error message has been added for compiled Team Edition and Enterprise Edition deployments. This occurs when enterprise-scale and access control automation features are unavailable, and the count of registered (but not deactivated) users exceeds 10,000. Refer to the error documentation: ERROR_SAFETY_LIMITS_EXCEEDED.
+
+
+
v9.0
+
+
Breaking Changes: The deprecated Insights feature has been completely removed.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: Mattermost Boards and various other plugins are now fully community supported. For more details, refer to this forum post.
+
Other Considerations: The channel_viewed WebSocket event has been updated to multiple_channels_viewed. This event now only triggers for channels with unread messages.
+
+
+
+
+
+
+
Upgrade Notes: v9.1 to v9.5
+
+
v9.5
+
+
Breaking Changes: Support for MySQL v5.7 has been discontinued due to its end of life. Customers are urged to upgrade their MySQL instance as soon as possible.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations: A safety limit error message has been added for compiled Team Edition and Enterprise Edition deployments. This occurs when enterprise-scale and access control automation features are unavailable, and the count of registered (but not deactivated) users exceeds 10,000. Refer to the error documentation: ERROR_SAFETY_LIMITS_EXCEEDED.
+
+
+
v9.1
+
+
Breaking Changes: Minimum supported Desktop App version is now v5.3. OAuth/SAML flows were updated to include desktop_login, making earlier versions incompatible.
+
Database Updates: A new table migration was introduced for handling retention IDs:
+
+
MySQL:
+
+ CREATE TABLE IF NOT EXISTS RetentionIdsForDeletion (
+ Id VARCHAR(26) NOT NULL,
+ TableName VARCHAR(64),
+ Ids JSON,
+ PRIMARY KEY (Id),
+ KEY idx_retentionidsfordeletion_tablename (TableName)
+ ) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4;
+
+
+
PostgreSQL:
+
+ CREATE TABLE IF NOT EXISTS retentionidsfordeletion (
+ id VARCHAR(26) PRIMARY KEY,
+ tablename VARCHAR(64),
+ ids VARCHAR(26)[]
+ );
+ CREATE INDEX IF NOT EXISTS idx_retentionidsfordeletion_tablename
+ ON retentionidsfordeletion (tablename);
+
+
+
+
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations:
+
+
Improved performance on data retention DeleteOrphanedRows queries.
+
Hard deleting a user or channel now also cleans up associated reactions.
+
Removed the DataRetentionConcurrencyEnabled feature flag. Data retention now runs without concurrency to prevent performance issues.
+
Added new configuration setting DataRetentionSettings.RetentionIdsBatchSize to control the number of ID batches fetched at a time during deletion (default: 100).
+
+
+
+
+
+
+
+
+
Upgrade Notes: v9.2 to v9.5
+
+
v9.5
+
+
Breaking Changes: Support for MySQL v5.7 has been discontinued due to its end of life. Customers are urged to upgrade their MySQL instance as soon as possible.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations: A safety limit error message has been added for compiled Team Edition and Enterprise Edition deployments. This occurs when enterprise-scale and access control automation features are unavailable, and the count of registered (but not deactivated) users exceeds 10,000. Refer to the error documentation: ERROR_SAFETY_LIMITS_EXCEEDED.
+
+
+
v9.2
+
+
Breaking Changes: Fixed data retention behavior for jobs. Custom retention policies will now automatically run even when the global data retention policy is set to "keep-forever". Posts may unintentionally be deleted if this is not adjusted before the upgrade. Admins should disable all custom data retention policies prior to the upgrade and re-enable them afterward.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations: No other considerations in this release.
+
+
+
+
+
+
+
Upgrade Notes: v9.5 to v9.11
+
+
v9.11
+
+
Breaking Changes: Added support for Elasticsearch v8 and Beta support for Opensearch v1.x and v2.x. The new configuration setting ElasticsearchSettings.Backend differentiates between Elasticsearch and Opensearch, with a default value of elasticsearch. This breaks support for AWS Elasticsearch v7.10.x, as the official v8 client only works with Elasticsearch v7.11+.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations:
+
+
For AWS customers on Opensearch:
+
+
You must modify Mattermost configuration from elasticsearch to opensearch and disable compatibility mode. See the Opensearch documentation for upgrade details.
+
After upgrading the Mattermost server, use mmctl or manually edit the configuration, then restart the Mattermost server.
+
If using Opensearch, you must set the backend to opensearch, or Mattermost will not function.
+
+
+
If you are using Elasticsearch v8:
+
+
Set action.destructive_requires_name to false in elasticsearch.yml to allow wildcard operations to work.
+
+
+
+
+
+
+
v9.5
+
+
Breaking Changes: Support for MySQL v5.7 has been discontinued due to its end of life. Customers are urged to upgrade their MySQL instance as soon as possible.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations: A safety limit error message has been added for compiled Team Edition and Enterprise Edition deployments. This occurs when enterprise-scale and access control automation features are unavailable, and the count of registered (but not deactivated) users exceeds 10,000. Refer to the error documentation: ERROR_SAFETY_LIMITS_EXCEEDED.
+
+
+
+
+
+
+
Upgrade Notes: v10.0 to v10.5
+
+
v10.0:
+
+
Breaking Changes:
+
+
We no longer support new installations using MySQL starting in v10. All new customers and/or deployments will only be supported with PostgreSQL. End of support for MySQL is targeted for Mattermost v11.
+
Apps Framework is deprecated for new installations. Please extend Mattermost using webhooks, slash commands, OAuth2 apps, and plugins.
Removed the deprecated pageSize query parameter from most API endpoints.
+
+
+
Feature Deprecations:
+
+
The experimental Strict CSRF token enforcement is deprecated and will be fully removed in Mattermost v11.
+
The /api/v4/image endpoint is fully deprecated when the image proxy is disabled.
+
+
+
Other Considerations:
+
+
Mattermost v10 introduces Playbooks v2 for all Enterprise licensed customers. Professional SKU customers may continue using Playbooks v1, which will remain supported until September 2025, followed by a grandfathering strategy. More details can be found here.
+
Renamed the following areas for better clarity:
+
+
"Channel Moderation" to "Advanced Access Control" in the channel management section of the **System Console**.
+
Announcement banner feature to "System-Wide Notifications".
+
"Collapsed Reply Threads" to "Threaded Discussions" in the System Console.
+
"System Roles" to "Delegated Granular Administration" in the System Console.
Group calls are no longer supported on unlicensed servers to focus quality and supportability on licensed servers.
+
Unlicensed servers can continue using Calls in direct message channels, which represents the majority of activity.
+
+
+
+
+
+
+
+
+
+
+
Upgrade Notes: v10.1 to v10.5
+
+
No significant changes introduced in v10.1.
+
+
+
+
+
Upgrade Notes: v10.2 to v10.5
+
+
v10.2:
+
+
Breaking Changes: Docker Content Trust (DCT) for signing Docker image artifacts has been replaced by Sigstore Cosign in v10.2 (November 2024). If you rely on artifact verification using DCT, please transition to using Cosign. See the Upcoming DCT Deprecation Mattermost forum post for more details.
+
Database Updates: No database updates in this release.
+
Feature Deprecations: No feature deprecations in this release.
+
Other Considerations: No other considerations in this release.