Skip to content

Commit

Permalink
Merge branch 'master' into config-in-db-cli-correction
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Jan 12, 2024
2 parents addb4d0 + f79b528 commit b085f0e
Show file tree
Hide file tree
Showing 10 changed files with 144 additions and 30 deletions.
18 changes: 18 additions & 0 deletions source/_static/badges/ent-cloud-dedicated.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:orphan:
:nosearch:

.. raw:: html

<div class="mm-badge">

|plans-img| Available only on `Enterprise <https://mattermost.com/contact-sales/>`__ plans

|deployment-img| Available only for `Cloud Dedicated <https://customers.mattermost.com/cloud/signup/>`__ deployments

.. |plans-img| image:: ../_static/images/badges/flag_icon.svg

.. |deployment-img| image:: ../_static/images/badges/deployment_icon.svg

.. raw:: html

</div>
4 changes: 2 additions & 2 deletions source/configure/reporting-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Site statistics
| sessions, commands, webhooks, active users, connections, | - ``config.json setting``: N/A |
| and playbooks. | - Environment variable: N/A |
+---------------------------------------------------------------+-------------------------------------------------------------+
| **Note**: Inactive and deactivated users, as well as remote users in |
| **Note**: Deactivated users as well as synthetic users in |
| `Microsoft Teams integrations </collaborate/collaborate-using-mattermost-for-microsoft-teams.html>`__ |
| and `shared channels users </onboard/shared-channels.html>`__, aren't counted towards the total number of active users. |
+---------------------------------------------------------------+-------------------------------------------------------------+
Expand All @@ -39,7 +39,7 @@ Team statistics
| number of public and private channels, total post count, and | - ``config.json`` setting: N/A |
| count of paid users (self-hosted only). | - Environment variable: N/A |
+---------------------------------------------------------------+---------------------------------------------------------------+
| **Note**: Inactive and deactivated users are not counted towards the total number of active users. |
| **Note**: Deactivated users are not counted towards the total number of active users. |
+---------------------------------------------------------------+---------------------------------------------------------------+

----
Expand Down
10 changes: 10 additions & 0 deletions source/deploy/legacy-self-hosted-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ From Mattermost v9.2, see the [Mattermost Changelog](/deploy/mattermost-changelo

## Release v9.1 - [Feature Release](https://docs.mattermost.com/upgrade/release-definitions.html#feature-release)

- **9.1.5, released 2024-01-09**
- Mattermost v9.1.5 contains medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/).
- Mattermost v9.1.5 contains the following functional changes:
- Fixed an issue where invalid reactions could be added to posts. Added default limit of the number of reactions per post.
- **9.1.4, released 2023-11-29**
- Mattermost v9.1.4 contains medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/).
- Mattermost v9.1.4 contains no database or functional changes.
Expand Down Expand Up @@ -267,6 +271,12 @@ Multiple setting options were added to ``config.json``. Below is a list of the a

## Release v8.1 - [Extended Support Release](https://docs.mattermost.com/upgrade/release-definitions.html#extended-support-release-esr)

- **8.1.8, released 2024-01-09**
- Mattermost v8.1.8 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/).
- Fixed an issue with double URL encoding of Oauth redirect URI params.
- Pre-packaged Jira plugin version [v4.0.1](https://github.com/mattermost/mattermost-plugin-jira/releases/tag/v4.0.1). Also see [v4.0.0](https://github.com/mattermost/mattermost-plugin-jira/releases/tag/v4.0.0) for recent breaking changes.
- Mattermost v8.1.8 contains the following functional changes:
- Fixed an issue where invalid reactions could be added to posts. Added default limit of the number of reactions per post.
- **8.1.7, released 2023-11-29**
- Mattermost v8.1.7 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/).
- Mattermost v8.1.7 contains no database or functional changes.
Expand Down
4 changes: 4 additions & 0 deletions source/deploy/mattermost-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ See [this walkthrough video](https://www.youtube.com/watch?v=eXA8emM97Bo) on som

## Release v9.2 - [Feature Release](https://docs.mattermost.com/upgrade/release-definitions.html#feature-release)

- **9.2.4, released 2024-01-09**
- Mattermost v9.2.4 contains medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/).
- Mattermost v9.2.4 contains the following functional changes:
- Fixed an issue where invalid reactions could be added to posts. Added default limit of the number of reactions per post.
- **9.2.3, released 2023-11-29**
- Mattermost v9.2.3 contains medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/).
- Mattermost v9.2.3 contains no database or functional changes.
Expand Down
1 change: 1 addition & 0 deletions source/guides/cloud-workspace-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Cloud workspace management
* :doc:`Workspace usage </manage/workspace-usage>` - Keep your workspace active.
* :doc:`Workspace migration </manage/cloud-data-export>` - Migrate your workspace using the mmctl tool.
* :doc:`Cloud data residency </manage/cloud-data-residency>` - Find information about your data in the Cloud.
* :doc:`Cloud Bring Your Own Key (BYOK) </manage/cloud-byok>` - Learn how to manage data encryption processes within a Mattermost Cloud Enterprise Dedicated deployment.
2 changes: 1 addition & 1 deletion source/install/download-latest-tarball.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Using ``wget``, download the Mattermost Server release you want to install.

<div class="mm-code-copy__wrapper">
<code class="mm-code-copy__text mm-code-copy__trigger" data-click-el="Snippet">
wget https://releases.mattermost.com/8.1.7/mattermost-8.1.7-linux-amd64.tar.gz
wget https://releases.mattermost.com/8.1.8/mattermost-8.1.8-linux-amd64.tar.gz
</code>
<span class="mm-code-copy__copied-notice">Copied to clipboard</span>
</div>
Expand Down
81 changes: 81 additions & 0 deletions source/manage/cloud-byok.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
Cloud Dedicated Bring Your Own Key
===================================

.. include:: ../_static/badges/ent-cloud-dedicated.rst
:start-after: :nosearch:

Bring Your Own Key (BYOK) provides Enterprise Cloud customers with autonomy over their encryption key life cycle. BYOK supports encryption at rest with custom KMS keys that the enterprise provides and maintains.

BYOK requires a subscription to Mattermost Cloud Enterprise Dedicated, which offers enhanced data security and compliance by ensuring that enterprises have full control over their data encryption processes.

In Mattermost Cloud Enterprise Dedicated, you can use KMS keys in 2 ways:

- One KMS key for all services; or,
- Per-service KMS keys (EBS, RDS, S3)
- Keys do not need to be unique to each service.
- All services must be encrypted at rest.
- Selective enablement of this feature can be supported.
- In cases where a global database is needed, we recommend providing 2 KMS keys (1 per region).

Configure BYOK
------------------------
1. Enterprise customer provides their AWS KMS ARN to the Mattermost Infrastructure SRE team.
2. Enterprise customer adds the following blocks to their KMS Policy for the AWS KMS ARN provided:

.. code-block:: JSON
{
"Sid": "Allow use of the key",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::<MATTERMOST_AWS_ACCOUNT_ID>:user/mattermost-cloud-<environment>-provisioning-<VPC_ID>"
},
"Action": [
"kms:Encrypt",
"kms:Decrypt",
"kms:ReEncrypt*",
"kms:GenerateDataKey*",
"kms:DescribeKey"
],
"Resource": "<CUSTOM_CUSTOMER_KMS_ID>"
},
{
"Sid": "Allow use of the key role nodes",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::<MATTERMOST_AWS_ACCOUNT_ID>:role/nodes.<CLUSTER_ID>-kops.k8s.local"
},
"Action": [
"kms:Encrypt",
"kms:Decrypt",
"kms:ReEncrypt*",
"kms:GenerateDataKey*",
"kms:DescribeKey"
],
"Resource": "<CUSTOM_CUSTOMER_KMS_ID>"
},
3. The Mattermost Infrastructure SRE team updates the kops cluster and S3, RDS resources after the KMS policy is updated on the customer's end.

Alternatively, the Enterprise customer can provide an external key (non-KMS) to the Mattermost Infrastructure SRE team that Mattermost maintains on behalf of the customer.
This path offers less control to customers but simplifies the setup process.

Requirements
~~~~~~~~~~~~~~~~~~~~~~~

- Customers must own their AWS Account. (In the alternative path mentioned above this is delegated to Mattermost.)
- Customers oversee the maintenance life cycle of their custom KMS key.
- A valid AWS KMS ARN for encrypting storage and databases should be provided to the Infrastructure SRE team.
- The customer should incorporate the provided policy blocks from the Infrastructure SRE team into their KMS key policy.

Considerations
~~~~~~~~~~~~~~~~~~~~~~~
- Changing the AWS KMS key in the database necessitates downtime due to AWS Aurora's encryption `limitations. <https://repost.aws/knowledge-center/update-encryption-key-rds>`__
- Proper communication is essential for setting expectations and scheduling changes.

Conclusion
--------------

If you are a large enterprise with compliance requirements, or are working in highly-regulated industries, using Mattermost Cloud Dedicated with BYOK ensures full data control.

For any further assistance or queries, `contact our support team </https://mattermost.com/support/>`__.
4 changes: 2 additions & 2 deletions source/manage/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ Frequently asked questions
Does Mattermost have an audit log besides the system ``auditd``?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Yes. See the `audit logging <#audit-logging-experimental-beta>`__ documentation for details.
Yes. See the `audit logging <#audit-logging-beta>`__ documentation for details.

When syslog is configured as the target, does it contain the IP address of the emitter of the data (i.e., the Mattermost app node)?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -486,4 +486,4 @@ See `enable-webhook-debugging </configure/environment-configuration-settings.htm
How do I adjust the maximum log field size?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

See `maximum-field-size </configure/environment-configuration-settings.html#maximum-field-size>`__
See `maximum-field-size </configure/environment-configuration-settings.html#maximum-field-size>`__
2 changes: 1 addition & 1 deletion source/upgrade/extended-support-release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ What are the current supported Extended Support Release versions?
+-------------+----------------+------------------+------------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------+
| Version | Type | Release Date | End of Support | Latest Dot Release Download link | Upgrade Notes |
+=============+================+==================+==================+============================================================================================+=====================================================+
| 8.1 | Feature | August 16, 2023 | May 15, 2024 | `8.1.7 <https://releases.mattermost.com/8.1.7/mattermost-8.1.7-linux-amd64.tar.gz>`_ | |
| 8.1 | Feature | August 16, 2023 | May 15, 2024 | `8.1.8 <https://releases.mattermost.com/8.1.8/mattermost-8.1.8-linux-amd64.tar.gz>`_ | |
+-------------+----------------+------------------+------------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------+
| 7.8 | Feature | February 16, 2023| November 15, 2023| `7.8.15 <https://releases.mattermost.com/7.8.15/mattermost-7.8.15-linux-amd64.tar.gz>`_ | |
+-------------+----------------+------------------+------------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------+
Expand Down
Loading

0 comments on commit b085f0e

Please sign in to comment.