Skip to content

Commit fe80c4c

Browse files
cwarnermmcwarnermm
authored
Moved experimental feature to GA (#8035)
1 parent 88df0ed commit fe80c4c

File tree

5 files changed

+53
-39
lines changed

5 files changed

+53
-39
lines changed

‎source/about/cloud-dedicated.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Connections to calls are secured with a combination of:
7070
Cloud native exports
7171
~~~~~~~~~~~~~~~~~~~~
7272

73-
Mattermost supports optional :ref:`filestore configuration settings <configure/experimental-configuration-settings:enable dedicated export filestore target>` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as admins who manage a given Mattermost deployment. The exports can also be accessed by generating unique download links as needed.
73+
Mattermost supports optional :ref:`filestore configuration settings <configure/environment-configuration-settings:enable dedicated export filestore target>` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as admins who manage a given Mattermost deployment. The exports can also be accessed by generating unique download links as needed.
7474

7575
The following diagram provides a high-level view of how this functionality works:
7676

‎source/about/cloud-shared.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Connections to calls are secured with a combination of:
7070
Cloud native exports
7171
~~~~~~~~~~~~~~~~~~~~
7272

73-
Mattermost supports optional :ref:`filestore configuration settings <configure/experimental-configuration-settings:enable dedicated export filestore target>` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as deployment admins who manage a given installation. The exports can also be accessed by generating unique download links as needed.
73+
Mattermost supports optional :ref:`filestore configuration settings <configure/environment-configuration-settings:enable dedicated export filestore target>` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as deployment admins who manage a given installation. The exports can also be accessed by generating unique download links as needed.
7474

7575
The following diagram provides a high-level view of how this functionality works:
7676

‎source/comply/compliance-export.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Use the following guides to configure exports for `CSV <#csv>`__, `Actiance XML
2828
.. note::
2929

3030
- For self-hosted deployments, compliance exports are written to the ``exports`` subdirectory of the configured filestore in the chosen format. This will either be in the :ref:`Local Storage directory <configure/environment-configuration-settings:file storage>` or the Mattermost S3 bucket if S3 storage is configured.
31-
- Alternatively, you can specify an alternate filestore target and generate an S3 presigned URL for compliance exports. See the :ref:`dedicated export filestore target <configure/experimental-configuration-settings:enable dedicated export filestore target>` configuration settings documentation for details.
31+
- Alternatively, you can specify an alternate filestore target and generate an S3 presigned URL for compliance exports. See the :ref:`dedicated export filestore target <configure/environment-configuration-settings:enable dedicated export filestore target>` configuration settings documentation for details.
3232
- Compliance exports don't contain posts sent before the feature was enabled. For self-hosted deployments, you can export past history via the ``export`` :doc:`command line tool <../manage/command-line-tools>`.
3333

3434
CSV

‎source/configure/environment-configuration-settings.rst

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4006,7 +4006,7 @@ Redis cache prefix
40064006
.. config:setting:: enable-webhub-channel-iteration
40074007
:displayname: Enable webhub channel iteration
40084008
:systemconsole: N/A
4009-
:configjson: EnableWebHubChannelIteration
4009+
:configjson: ServiceSettings.EnableWebHubChannelIteration
40104010
:environment: MM_SERVICESETTINGS_ENABLEWEBHUBCHANNELITERATION
40114011

40124012
- **true**: Improves websocket broadcasting performance; however, performance may decrease when users join or leave a channel. Not recommended unless you have at least 200,000 concurrent users actively using Mattermost.
@@ -4027,4 +4027,52 @@ Enable webhub channel iteration
40274027
| concurrent users actively using Mattermost. | |
40284028
| | |
40294029
| Disabled by default. | |
4030-
+------------------------------------------------------+--------------------------------------------------------------------------------------------------+
4030+
+------------------------------------------------------+--------------------------------------------------------------------------------------------------+
4031+
4032+
.. config:setting:: enable-dedicated-export-filestore-target
4033+
:displayname: Enable dedicated export filestore target
4034+
:systemconsole: N/A
4035+
:configjson: EnableWebHubChannelIteration
4036+
:environment: MM_FILESETTINGS_DEDICATEDEXPORTSTORE
4037+
4038+
- **true**: A new ``ExportFileBackend()`` is generated under ``FileSettings`` using new configuration values for select configuration settings.
4039+
- **false**: **(Default)** Standard file storage is used. Standard file storage will also be used when the configuration setting or value is omitted.
4040+
4041+
Enable dedicated export filestore target
4042+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4043+
4044+
+------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
4045+
| Enables the ability to specify an alternate filestore | - System Config path: **N/A** |
4046+
| target for Mattermost | - ``config.json setting``: ``FileSettings`` > ``DedicatedExportStore`` |
4047+
| :doc:`bulk exports </manage/bulk-export-tool>` and | - Environment variable: ``MM_FILESETTINGS_DEDICATEDEXPORTSTORE`` |
4048+
| :doc:`compliance exports </comply/compliance-export>`. | |
4049+
| | |
4050+
| - **True**: A new ``ExportFileBackend()`` is generated | |
4051+
| under ``FileSettings`` using new configuration values | |
4052+
| for the following configuration settings: | |
4053+
| | |
4054+
| - ``ExportDriverName`` | |
4055+
| - ``ExportDirectory`` | |
4056+
| - ``ExportAmazonS3AccessKeyId`` | |
4057+
| - ``ExportAmazonS3SecretAccessKey`` | |
4058+
| - ``ExportAmazonS3Bucket`` | |
4059+
| - ``ExportAmazonS3PathPrefix`` | |
4060+
| - ``ExportAmazonS3Region`` | |
4061+
| - ``ExportAmazonS3Endpoint`` | |
4062+
| - ``ExportAmazonS3SSL`` | |
4063+
| - ``ExportAmazonS3SignV2`` | |
4064+
| - ``ExportAmazonS3SSE`` | |
4065+
| - ``ExportAmazonS3Trace`` | |
4066+
| - ``ExportAmazonS3RequestTimeoutMilliseconds`` | |
4067+
| - ``ExportAmazonS3PresignExpiresSeconds`` | |
4068+
| | |
4069+
| - **False**: (**Default**) Standard | |
4070+
| :ref:`file storage <configure/environment-configuration-settings:file storage>` | |
4071+
| is used. Standard file storage will also be used when the configuration setting | |
4072+
| or value is omitted. | |
4073+
+------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
4074+
4075+
.. note::
4076+
4077+
- When an alternate filestore target is configured, Mattermost Cloud admins can generate an S3 presigned URL for exports using the ``/exportlink [job-id|zip file|latest]`` slash command. See the :ref:`Mattermost data migration <manage/cloud-data-export:create the export>` documentation for details. Alternatively, Cloud and self-hosted admins can use the :ref:`mmctl export generate-presigned-url <manage/mmctl-command-line-tool:mmctl export generate-presigned-url>` command to generate a presigned URL directly from mmctl.
4078+
- Generating an S3 presigned URL requires the feature flag ``EnableExportDirectDownload`` to be set to ``true``, the storage must be compatible with generating an S3 link, and this experimental configuration setting must be set to ``true``. Presigned URLs for exports aren't supported for systems with shared storage.

‎source/configure/experimental-configuration-settings.rst

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -640,40 +640,6 @@ This setting controls whether or not the channel link autocomplete triggers imme
640640
| This feature's ``config.json`` setting is ``"ExperimentalSettings.DelayChannelAutocomplete": false`` with options ``true`` and ``false``. |
641641
+-------------------------------------------------------------------------------------------------------------------------------------------+
642642

643-
Enable dedicated export filestore target
644-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
645-
646-
This setting enables you to specify an alternate filestore target for Mattermost :doc:`bulk exports </manage/bulk-export-tool>` and :doc:`compliance exports </comply/compliance-export>`.
647-
648-
**True**: A new ``ExportFileBackend()`` is generated under ``FileSettings`` using new configuration values for the following configuration settings:
649-
650-
- ``ExportDriverName``
651-
- ``ExportDirectory``
652-
- ``ExportAmazonS3AccessKeyId``
653-
- ``ExportAmazonS3SecretAccessKey``
654-
- ``ExportAmazonS3Bucket``
655-
- ``ExportAmazonS3PathPrefix``
656-
- ``ExportAmazonS3Region``
657-
- ``ExportAmazonS3Endpoint``
658-
- ``ExportAmazonS3SSL``
659-
- ``ExportAmazonS3SignV2``
660-
- ``ExportAmazonS3SSE``
661-
- ``ExportAmazonS3Trace``
662-
- ``ExportAmazonS3RequestTimeoutMilliseconds``
663-
- ``ExportAmazonS3PresignExpiresSeconds``
664-
665-
**False**: Standard :ref:`file storage <configure/environment-configuration-settings:file storage>` is used (or when the configuration setting is omitted).
666-
667-
When an alternate filestore target is configured, Mattermost Cloud admins can generate an S3 presigned URL for exports using the ``/exportlink [job-id|zip file|latest]`` slash command. See the :ref:`Mattermost data migration <manage/cloud-data-export:create the export>` documentation for details. Alternatively, Cloud and self-hosted admins can use the :ref:`mmctl export generate-presigned-url <manage/mmctl-command-line-tool:mmctl export generate-presigned-url>` command to generate a presigned URL directly from mmctl.
668-
669-
.. note::
670-
671-
Generating an S3 presigned URL requires the feature flag ``EnableExportDirectDownload`` to be set to ``true``, the storage must be compatible with generating an S3 link, and this experimental configuration setting must be set to ``true``. Presigned URLs for exports aren't supported for systems with shared storage.
672-
673-
+-------------------------------------------------------------------------------------------------------------------------------------------+
674-
| This feature's ``config.json`` setting is ``"ExperimentalSettings.DedicatedExportStore": false`` with options ``true`` and ``false``. |
675-
+-------------------------------------------------------------------------------------------------------------------------------------------+
676-
677643
YouTube referrer policy
678644
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
679645

0 commit comments

Comments
 (0)