Skip to content

AWS OpenSearch as an option to Elasticsearch #7900

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

Open
wants to merge 8 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
2 changes: 1 addition & 1 deletion source/about/editions-and-offerings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Mattermost Enterprise is an enterprise-grade collaboration system that supports

This offering includes all the features of `Mattermost Professional <#mattermost-professional>`__, plus:

- :doc:`Enterprise-scale search with dedicated indexing and usage resourcing via cluster support </scale/elasticsearch>`.
- :doc:`Enterprise-scale search with dedicated indexing and usage resourcing via cluster support </scale/enterprise-search>`.
- :doc:`Sychronization of access controls, channels, and teams with AD/LDAP Groups </onboard/ad-ldap-groups-synchronization>`.
- :doc:`eDiscovery and compliance export automation </comply/compliance-export>`.
- :doc:`Enterprise mobile device management with custom EMM support via AppConfig </deploy/mobile/deploy-mobile-apps-using-emm-provider>`.
Expand Down
8 changes: 4 additions & 4 deletions source/about/mattermost-v9-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,16 @@

### Important Upgrade Notes

- Added support for Elasticsearch v8. Also added Beta support for [Opensearch v1.x and v2.x](https://opensearch.org/). A new config setting ``ElasticsearchSettings.Backend`` has been added to differentiate between Elasticsearch and Opensearch. The default value is `elasticsearch`, which breaks support for AWS Elasticsearch v7.10.x since the official v8 client only works from Elasticsearch v7.11 and higher versions. See the important note below for details.
- Added support for Elasticsearch v8. Also added Beta support for [OpenSearch v1.x and v2.x](https://opensearch.org/). A new config setting ``ElasticsearchSettings.Backend`` has been added to differentiate between Elasticsearch and OpenSearch. The default value is `elasticsearch`, which breaks support for AWS Elasticsearch v7.10.x since the official v8 client only works from Elasticsearch v7.11 and higher versions. See the important note below for details.
- Mattermost supports Elasticsearch v7.17+. However, we recommend upgrading your Elasticsearch v7 instance to v8.x. See the [Elasticsearch upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html) documentation for details.
- When using Elasticsearch v8, ensure you set ``action.destructive_requires_name`` to ``false`` in ``elasticsearch.yml`` to allow for wildcard operations to work.

```{Important}
**AWS Elasticsearch**

If you're using AWS Elasticsearch, you must:
1. Upgrade to AWS Opensearch. Refer to the [Opensearch upgrade](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/version-migration.html) documentation for details.
2. Disable "compatibility mode" in Opensearch.
1. Upgrade to AWS OpenSearch. Refer to the [OpenSearch upgrade](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/version-migration.html) documentation for details.
2. Disable "compatibility mode" in OpenSearch.
3. Upgrade Mattermost server.
4. Update the Mattermost `ElasticsearchSettings.Backend` configuration setting value from `elasticsearch` to `opensearch` manually or using [mmctl](https://docs.mattermost.com/manage/mmctl-command-line-tool.html#mmctl-config-set). This value cannot be changed using the System Console. See the Mattermost [Elasticsearch backend type](https://docs.mattermost.com/configure/environment-configuration-settings.html#elastic-backendtype) documentation for additional details.
5. Restart the Mattermost server.
Expand Down Expand Up @@ -163,7 +163,7 @@ New setting options were added to ``config.json``. Below is a list of the additi

#### Changes to the Enterprise plan:
- Under ``ElasticsearchSettings`` in ``config.json``:
- Added ``Backend`` to differentiate between Elasticsearch and Opensearch. The default value is Elasticsearch.
- Added ``Backend`` to differentiate between Elasticsearch and OpenSearch. The default value is ``elasticsearch``.

### API Changes
- Added new API endpoints to manage remote clusters.
Expand Down
2 changes: 1 addition & 1 deletion source/comply/data-retention-policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You can also run the deletion job manually at any time by selecting **Run Deleti

.. note::

If using data retention and :doc:`ElasticSearch </scale/elasticsearch>`, ensure the :ref:`ElasticSearch aggregate search indexes <configure/environment-configuration-settings:aggregate search indexes>` setting is set to a value that is greater than your data retention policy in days.
If using data retention with :doc:`ElasticSearch </scale/elasticsearch-setup>`, ensure the :ref:`ElasticSearch aggregate search indexes <configure/environment-configuration-settings:aggregate search indexes>` setting is set to a value that is greater than your data retention policy in days.

Frequently Asked Questions (FAQs)
---------------------------------
Expand Down
5 changes: 4 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -1947,7 +1947,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/deploy/server/server-deployment-planning.html",
"configure/using-outbound-proxy.html":
"https://docs.mattermost.com/deploy/server/server-deployment-planning.html",

"configure/environment-configuration-settings.html#elasticsearch":
"https://docs.mattermost.com/configure/environment-configuration-settings.html#enterprise-search",

# Deploy redirects
"deploy/mobile-apps-faq.html":
Expand Down Expand Up @@ -3792,6 +3793,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/scale/scale-to-80000-users.html",
"scale/scale-to-88000-users.html":
"https://docs.mattermost.com/scale/scale-to-90000-users.html",
"scale/elasticsearch.html":
"https://docs.mattermost.com/scale/enterprise-search.html",

# Upgrade redirects
"upgrade/upgrading-mattermost-server.html#prepare-to-upgrade-to-the-latest-version":
Expand Down
2 changes: 1 addition & 1 deletion source/configure/bleve-search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ The following conditions are applied when using Bleve search:
How does search work with Bleve disabled?
-------------------------------------------

Mattermost performs full text searches against the database unless you have an :ref:`Enterprise license <about/editions-and-offerings:mattermost enterprise edition>` and :doc:`Elasticsearch </scale/elasticsearch>` configured.
Mattermost performs full text searches against the database unless you have an :ref:`Enterprise license <about/editions-and-offerings:mattermost enterprise edition>` and :doc:`enterprise search </scale/enterprise-search>` configured.
Loading