Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added testing note #7680

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions source/scale/scale-to-100000-users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,25 @@ This page describes the Mattermost reference architecture designed for the load
.. note::
- Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.
- From Mattermost v10.4, Mattermost Enterprise customers can configure `Redis <https://redis.io/>`_ (Remote Dictionary Server) as an alternative cache backend. Using Redis can help ensure that Mattermost remains performant and efficient, even under heavy usage. See the :ref:`Redis cache backend <configure/environment-configuration-settings:redis cache backend>` configuration settings documentation for details.
- While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort.

Requirements
------------

+------------------------+-----------+----------------+-------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+===================+
| Mattermost Application | 6 | 16/32 | c7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Writer | 1 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Reader | 5 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-------------------+
| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search |
+------------------------+-----------+----------------+-------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
+------------------------+-----------+----------------+-----------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+=======================+
| Mattermost Application | 6 | 16/32 | c7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Writer | 1 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Reader | 5 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search |
+------------------------+-----------+----------------+-----------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+

Lifetime storage
----------------
Expand Down
32 changes: 17 additions & 15 deletions source/scale/scale-to-30000-users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load
- **Database Configuration**: writer, multiple readers

.. note::
Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.

- Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.
- While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort.

Requirements
------------

+------------------------+-----------+----------------+-------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+===================+
| Mattermost Application | 2 | 8/16 | c7i.2xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Writer | 1 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Reader | 1 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-------------------+
| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search |
+------------------------+-----------+----------------+-------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
+------------------------+-----------+----------------+-----------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+=======================+
| Mattermost Application | 2 | 8/16 | c7i.2xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Writer | 1 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Reader | 1 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-----------------------+
| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search |
+------------------------+-----------+----------------+-----------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+

Lifetime storage
----------------
Expand Down
32 changes: 17 additions & 15 deletions source/scale/scale-to-50000-users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load
- **Database Configuration**: writer, multiple readers

.. note::
Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.

- Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.
- While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort.

Requirements
------------

+------------------------+-----------+----------------+-------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+===================+
| Mattermost Application | 5 | 8/16 | c7i.2xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Writer | 1 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Reader | 4 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-------------------+
| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search |
+------------------------+-----------+----------------+-------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
+------------------------+-----------+----------------+-----------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+=======================+
| Mattermost Application | 5 | 8/16 | c7i.2xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Writer | 1 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Reader | 4 | 8/64 | db.r7g.2xlarge |
+------------------------+-----------+----------------+-----------------------+
| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search |
+------------------------+-----------+----------------+-----------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+

Lifetime storage
----------------
Expand Down
32 changes: 17 additions & 15 deletions source/scale/scale-to-80000-users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load
- **Database Configuration**: writer, multiple readers

.. note::
Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.

- Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.
- While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort.

Requirements
------------

+------------------------+-----------+----------------+-------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+===================+
| Mattermost Application | 4 | 16/32 | c7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Writer | 1 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Reader | 3 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-------------------+
| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search |
+------------------------+-----------+----------------+-------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
+------------------------+-----------+----------------+-----------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+=======================+
| Mattermost Application | 4 | 16/32 | c7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Writer | 1 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Reader | 3 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search |
+------------------------+-----------+----------------+-----------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+

Lifetime storage
----------------
Expand Down
32 changes: 17 additions & 15 deletions source/scale/scale-to-90000-users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load
- **Database Configuration**: writer, multiple readers

.. note::
Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.

- Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are.
- While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort.

Requirements
------------

+------------------------+-----------+----------------+-------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+===================+
| Mattermost Application | 5 | 16/32 | c7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Writer | 1 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-------------------+
| RDS Reader | 4 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-------------------+
| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search |
+------------------------+-----------+----------------+-------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-------------------+
+------------------------+-----------+----------------+-----------------------+
| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** |
| | | Memory (GiB)** | |
+========================+===========+================+=======================+
| Mattermost Application | 5 | 16/32 | c7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Writer | 1 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| RDS Reader | 4 | 16/128 | db.r7g.4xlarge |
+------------------------+-----------+----------------+-----------------------+
| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search |
+------------------------+-----------+----------------+-----------------------+
| Proxy | 1 | 16/64 | m7i.4xlarge |
+------------------------+-----------+----------------+-----------------------+

Lifetime storage
----------------
Expand Down
4 changes: 4 additions & 0 deletions source/scale/scaling-for-enterprise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The following reference architectures are available as recommended starting poin
* :doc:`Scale up to 90000 users </scale/scale-to-90000-users>` - Learn how to scale Mattermost to up to 90000 users.
* :doc:`Scale up to 100000 users </scale/scale-to-100000-users>` - Learn how to scale Mattermost to up to 100000 users.

.. important::

Due to constraints in testing, the proxy instance specifications were fixed for all the tests from which we derived these reference architectures. This was done to avoid a combinatorial explosion of variables in tests, but it resulted in minor gaps in our understandings of certain aspects of the reference architectures. In particular, the proxy instance is overspecified for the smaller user counts.

Testing methodology and updates
--------------------------------

Expand Down
Loading