You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2022/08/23 10:25:11 UTC
[james-project] 18/26: JAMES-3771 Site: Elastic => OpenSearch rewords
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 6bbf58b543aca5cf30fba762ecffbe383d49518c
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Mon Aug 8 09:29:07 2022 +0700
JAMES-3771 Site: Elastic => OpenSearch rewords
---
.../server/install/guice-cassandra-rabbitmq-s3.md | 9 +-
.../markdown/server/install/guice-cassandra.md | 8 +-
src/site/markdown/server/manage-cli.md | 2 +-
.../server/manage-guice-distributed-james.md | 20 +--
src/site/markdown/server/manage-webadmin.md | 2 +-
src/site/site.xml | 2 +-
src/site/xdoc/download.xml | 4 +-
src/site/xdoc/server/config-guice.xml | 2 +-
src/site/xdoc/server/config-jmap.xml | 2 +-
...fig-elasticsearch.xml => config-opensearch.xml} | 144 +++++++++------------
src/site/xdoc/server/feature-performance.xml | 6 +-
src/site/xdoc/server/features.xml | 2 +-
src/site/xdoc/server/index.xml | 2 +-
src/site/xdoc/server/install.xml | 6 +-
src/site/xdoc/server/objectives.xml | 2 +-
src/site/xdoc/server/packaging.xml | 12 +-
src/site/xdoc/server/quick-start-cassandra.xml | 6 +-
17 files changed, 103 insertions(+), 128 deletions(-)
diff --git a/src/site/markdown/server/install/guice-cassandra-rabbitmq-s3.md b/src/site/markdown/server/install/guice-cassandra-rabbitmq-s3.md
index 7bac6574de..020933f1c1 100644
--- a/src/site/markdown/server/install/guice-cassandra-rabbitmq-s3.md
+++ b/src/site/markdown/server/install/guice-cassandra-rabbitmq-s3.md
@@ -5,7 +5,7 @@
### Requirements
- Java 11 SDK
- - Docker ∕ ElasticSearch 7.10.2, RabbitMQ Management 3.8.18, compatible S3 ObjectStorage and Cassandra 3.11.10
+ - Docker ∕ OpenSearch 2.1.0, RabbitMQ Management 3.8.18, compatible S3 ObjectStorage and Cassandra 3.11.10
- Maven 3
### Building the artifacts
@@ -26,7 +26,7 @@ mvn clean install
### Requirements
* Cassandra 3.11.10
- * ElasticSearch 7.10.2
+ * OpenSearch 2.1.0
* RabbitMQ-Management 3.8.18
* Zenko Cloudserver or AWS S3 compatible API
@@ -44,12 +44,11 @@ You also need to generate a keystore in your conf folder with the following comm
$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
```
-You need to have a Cassandra, ElasticSearch, S3 and RabbitMQ instance running. You can either install the servers or launch them via docker:
+You need to have a Cassandra, OpenSearch, S3 and RabbitMQ instance running. You can either install the servers or launch them via docker:
```bash
$ docker run -d -p 9042:9042 --name=cassandra cassandra:3.11.10
-$ docker run -d -p 9200:9200 --name=elasticsearch --env 'discovery.type=single-node' docker.elastic.co/elasticsearch/elasticsearch:7.10.2
-$ docker run -d -p 5672:5672 -p 15672:15672 --name=rabbitmq rabbitmq:3.9.18-management
+$ docker run -d --network james -p 9200:9200 --name=opensearch --env 'discovery.type=single-node' opensearchproject/opensearch:2.1.0$ docker run -d -p 5672:5672 -p 15672:15672 --name=rabbitmq rabbitmq:3.9.18-management
$ docker run -d --env 'REMOTE_MANAGEMENT_DISABLE=1' --env 'SCALITY_ACCESS_KEY_ID=accessKey1' --env 'SCALITY_SECRET_ACCESS_KEY=secretKey1' --name=s3 zenko/cloudserver:8.2.6
```
diff --git a/src/site/markdown/server/install/guice-cassandra.md b/src/site/markdown/server/install/guice-cassandra.md
index 291b269a41..370da40080 100644
--- a/src/site/markdown/server/install/guice-cassandra.md
+++ b/src/site/markdown/server/install/guice-cassandra.md
@@ -5,7 +5,7 @@
### Requirements
- Java 11 SDK
- - Docker ∕ ElasticSearch 7.10.2 and Cassandra 3.11.10
+ - Docker ∕ OpenSearch 2.1.0 and Cassandra 3.11.10
- Maven 3
*WARNING*: JAMES-3591 Cassandra is not made to store large binary content, its use will be suboptimal compared to
@@ -29,7 +29,7 @@ mvn clean install
### Requirements
* Cassandra 3.11.10
- * ElasticSearch 7.10.2
+ * OpenSearch 2.1.0
### James Launch
@@ -45,11 +45,11 @@ You also need to generate a keystore in your conf folder with the following comm
$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
```
-You need to have a Cassandra and an ElasticSearch instance running. You can either install the servers or launch them via docker:
+You need to have a Cassandra and an OpenSearch instance running. You can either install the servers or launch them via docker:
```bash
$ docker run -d -p 9042:9042 --name=cassandra cassandra:3.11.10
-$ docker run -d -p 9200:9200 --name=elasticsearch --env 'discovery.type=single-node' docker.elastic.co/elasticsearch/elasticsearch:7.10.2
+$ docker run -d --network james -p 9200:9200 --name=opensearch --env 'discovery.type=single-node' opensearchproject/opensearch:2.1.0
```
Once everything is set up, you just have to run the jar with:
diff --git a/src/site/markdown/server/manage-cli.md b/src/site/markdown/server/manage-cli.md
index 85d2d3a757..d3d9cbc332 100644
--- a/src/site/markdown/server/manage-cli.md
+++ b/src/site/markdown/server/manage-cli.md
@@ -278,7 +278,7 @@ Moreover, James allows to specify global maximum values, at the server level. No
## Re-indexing
-James allow you to index your emails in a search engine, for making search faster. Both ElasticSearch and Lucene are supported.
+James allow you to index your emails in a search engine, for making search faster. Both OpenSearch and Lucene are supported.
For some reasons, you might want to re-index your mails (inconsistencies across datastore, migrations).
diff --git a/src/site/markdown/server/manage-guice-distributed-james.md b/src/site/markdown/server/manage-guice-distributed-james.md
index bb654c1950..7d09cbbc03 100644
--- a/src/site/markdown/server/manage-guice-distributed-james.md
+++ b/src/site/markdown/server/manage-guice-distributed-james.md
@@ -19,7 +19,7 @@ advanced users.
- [Basic Monitoring](#Basic_Monitoring)
- [Cassandra table level configuration](#Cassandra_table_level_configuration)
- [Deleted Messages Vault](#Deleted_Messages_Vault)
- - [ElasticSearch Indexing](#Elasticsearch_Indexing)
+ - [OpenSearch Indexing](#Opensearch_Indexing)
- [Mailbox Event Bus](#Mailbox_Event_Bus)
- [Mail Processing](#Mail_Processing)
- [Mail Queue](#Mail_Queue)
@@ -35,7 +35,7 @@ In order to achieve this goal, this product leverages the following technologies
- **Cassandra** for meta-data storage
- **ObjectStorage** (S3) for binary content storage
- - **ElasticSearch** for search
+ - **OpenSearch** for search
- **RabbitMQ** for messaging
A [docker-compose](https://github.com/apache/james-project/blob/master/server/apps/distributed-app/docker-compose.yml) file is
@@ -88,7 +88,7 @@ Here is related [webadmin documentation](manage-webadmin.html#HealthCheck)
Here are the available checks alongside the insight they offer:
- **Cassandra backend**: Cassandra storage. Ensure queries can be executed on the connection James uses.
- - **ElasticSearch Backend**: ElasticSearch storage. Triggers an ElasticSearch health request on indices James uses.
+ - **OpenSearch Backend**: OpenSearch storage. Triggers an OpenSearch health request on indices James uses.
- **EventDeadLettersHealthCheck**: EventDeadLetters checking.
- **RabbitMQ backend**: RabbitMQ messaging. Verifies an open connection and an open channel are well available.
- **Guice application lifecycle**: Ensures James Guice successfully started, and is up. Logs should contain
@@ -180,7 +180,7 @@ Mailbox listeners can register themselves on this event bus system to be called
allowing to do different kind of extra operations on the system, like:
- Current quota calculation
- - Message indexation with ElasticSearch
+ - Message indexation with OpenSearch
- Mailbox annotations cleanup
- Ham/spam reporting to SpamAssassin
- ...
@@ -217,11 +217,11 @@ If for some other reason you don't need to redeliver all events, you have more f
[redeliver group events](manage-webadmin.html#Redeliver_group_events) or even just
[redeliver a single event](manage-webadmin.html#Redeliver_a_single_event).
-## ElasticSearch Indexing
+## OpenSearch Indexing
-A projection of messages is maintained in ElasticSearch via a listener plugged into the mailbox event bus in order to enable search features.
+A projection of messages is maintained in OpenSearch via a listener plugged into the mailbox event bus in order to enable search features.
-You can find more information about ElasticSearch configuration [here](config-elasticsearch.html).
+You can find more information about OpenSearch configuration [here](config-opensearch.html).
### Usual troubleshooting procedures
@@ -244,7 +244,7 @@ or even just [reIndex a single mail](manage-webadmin.html#ReIndexing_a_single_ma
When checking the result of a reIndexing task, you might have failed reprocessed mails. You can still use the task ID to
[reprocess previously failed reIndexing mails](manage-webadmin.html#Fixing_previously_failed_ReIndexing).
-### On the fly ElasticSearch Index setting update
+### On the fly OpenSearch Index setting update
Sometimes you might need to update index settings. Cases when an administrator might want to update index settings include:
@@ -265,8 +265,8 @@ from the old index to the new one (this actively relies on `_source` field being
- Now that the migration to the new index is done, you can
[drop the old index](https://www.elastic.co/guide/en/elasticsearch/reference/6.3/indices-delete-index.html)
- You might want as well modify the James configuration file
-[elasticsearch.properties](https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/elasticsearch.properties)
-by setting the parameter `elasticsearch.index.mailbox.name` to the name of your new index. This is to avoid that James
+[opensearch.properties](https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/opensearch.properties)
+by setting the parameter `opensearch.index.mailbox.name` to the name of your new index. This is to avoid that James
re-creates index upon restart
_Note_: keep in mind that reindexing can be a very long operation depending on the volume of mails you have stored.
diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index 6768aef9af..042b54d242 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -99,7 +99,7 @@ Will return a list of healthChecks execution result, with an aggregated result:
Supported health checks include:
- **Cassandra backend**: Cassandra storage. Included in Cassandra Guice based products.
- - **ElasticSearch Backend**: ElasticSearch storage. Included in Cassandra Guice based products.
+ - **OpenSearch Backend**: OpenSearch storage. Included in Cassandra Guice based products.
- **EventDeadLettersHealthCheck**: Included in all Guice products.
- **Guice application lifecycle**: included in all Guice products.
- **JPA Backend**: JPA storage. Included in JPA Guice based products.
diff --git a/src/site/site.xml b/src/site/site.xml
index e163337499..255feb63e3 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -115,7 +115,7 @@
<item name="Blob Export" href="/server/config-blob-export.html" />
<item name="BlobStore" href="/server/config-blobstore.html" />
<item name="Cassandra" href="/server/config-cassandra.html" />
- <item name="ElasticSearch" href="/server/config-elasticsearch.html" />
+ <item name="OpenSearch" href="/server/config-opensearch.html" />
<item name="Deleted Messages Vault" href="/server/config-vault.html" />
<item name="DNS Service" href="/server/config-dnsservice.html" />
<item name="Domain List" href="/server/config-domainlist.html" />
diff --git a/src/site/xdoc/download.xml b/src/site/xdoc/download.xml
index 1edc123e26..5dfca08aa2 100644
--- a/src/site/xdoc/download.xml
+++ b/src/site/xdoc/download.xml
@@ -74,7 +74,7 @@
<p><b>Distributed James server</b>:</p>
- <p>This artifact packages the distributed James server, that operates on top of Cassandra, ElasticSearch,
+ <p>This artifact packages the distributed James server, that operates on top of Cassandra, OpenSearch,
RabbitMQ, and S3 API. It is intended for large scale deployments where scalability is required.</p>
<li>Binary (ZIP Format) for the Distributed James server:
@@ -116,7 +116,7 @@
<p><b>Distributed James server</b>:</p>
- <p>This artifact packages the distributed James server, that operates on top of Cassandra, ElasticSearch,
+ <p>This artifact packages the distributed James server, that operates on top of Cassandra, OpenSearch,
RabbitMQ, and S3 API. It is intended for large scale deployments where scalability is required.</p>
<li>Binary (ZIP Format) for the Distributed James server:
diff --git a/src/site/xdoc/server/config-guice.xml b/src/site/xdoc/server/config-guice.xml
index 5f99af6bd2..3d709098b6 100644
--- a/src/site/xdoc/server/config-guice.xml
+++ b/src/site/xdoc/server/config-guice.xml
@@ -73,7 +73,7 @@
</tr>
<tr>
<td><a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/elasticsearch.properties">elasticsearch.properties</a></td>
- <td><a href="config-elasticsearch.html">ElasticSearch Configuration</a></td>
+ <td><a href="config-opensearch.html">OpenSearch Configuration</a></td>
<td></td>
</tr>
<tr>
diff --git a/src/site/xdoc/server/config-jmap.xml b/src/site/xdoc/server/config-jmap.xml
index 8027995faf..7dcbda82b9 100644
--- a/src/site/xdoc/server/config-jmap.xml
+++ b/src/site/xdoc/server/config-jmap.xml
@@ -76,7 +76,7 @@
<dt><strong>view.email.query.enabled</strong></dt>
<dd>Optional boolean. Defaults to false.</dd>
- <dd>Should simple Email/query be resolved against a Cassandra projection, or should we resolve them against ElasticSearch?
+ <dd>Should simple Email/query be resolved against a Cassandra projection, or should we resolve them against OpenSearch?
This enables a higher resilience, but the projection needs to be correctly populated.</dd>
<dt><strong>user.provisioning.enabled</strong></dt>
diff --git a/src/site/xdoc/server/config-elasticsearch.xml b/src/site/xdoc/server/config-opensearch.xml
similarity index 64%
rename from src/site/xdoc/server/config-elasticsearch.xml
rename to src/site/xdoc/server/config-opensearch.xml
index 17d232eb04..09dedf2aac 100644
--- a/src/site/xdoc/server/config-elasticsearch.xml
+++ b/src/site/xdoc/server/config-opensearch.xml
@@ -20,45 +20,45 @@
<document>
<properties>
- <title>Apache James Server 3 - ElasticSearch Configuration</title>
+ <title>Apache James Server 3 - OpenSearch Configuration</title>
</properties>
<body>
- <section name="ElasticSearch Configuration">
+ <section name="OpenSearch Configuration">
This configuration applies only to Guice wiring.
- <p>Consult <a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/elasticsearch.properties">elasticsearch.properties</a> to get some examples and hints.</p>
+ <p>Consult <a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/opensearch.properties">opensearch.properties</a> to get some examples and hints.</p>
Connection to a cluster :
<dl>
- <dt><strong>elasticsearch.masterHost</strong></dt>
- <dd>Is the IP (or host) of the ElasticSearch master</dd>
- <dt><strong>elasticsearch.port</strong></dt>
- <dd>Is the port of ElasticSearch master</dd>
+ <dt><strong>opensearch.masterHost</strong></dt>
+ <dd>Is the IP (or host) of the OpenSearch master</dd>
+ <dt><strong>opensearch.port</strong></dt>
+ <dd>Is the port of OpenSearch master</dd>
- <dt><strong>elasticsearch.hostScheme</strong></dt>
+ <dt><strong>opensearch.hostScheme</strong></dt>
<dd>
Optional. Only http or https are accepted, default is http. In case of <strong>https</strong>,
and you want to override the default SSL Validation behavior of the client,
consult the section <strong>SSL Trusting Configuration</strong> for more details.
</dd>
- <dt><strong>elasticsearch.user</strong></dt>
+ <dt><strong>opensearch.user</strong></dt>
<dd>
Optional.
- Basic auth username to access elasticsearch.
- Ignore elasticsearch.user and elasticsearch.password to not be using authentication (default behaviour).
+ Basic auth username to access OpenSearch.
+ Ignore opensearch.user and opensearch.password to not be using authentication (default behaviour).
Otherwise, you need to specify both properties.
</dd>
- <dt><strong>elasticsearch.password</strong></dt>
+ <dt><strong>opensearch.password</strong></dt>
<dd>
Optional.
- Basic auth password to access elasticsearch.
- Ignore elasticsearch.user and elasticsearch.password to not be using authentication (default behaviour).
+ Basic auth password to access opensearch.
+ Ignore opensearch.user and opensearch.password to not be using authentication (default behaviour).
Otherwise, you need to specify both properties.
</dd>
</dl>
@@ -66,105 +66,81 @@
Or you can connect a cluster by :
<dl>
- <dt><strong>elasticsearch.hosts</strong></dt>
- <dd>List of comma separated hosts. An host is composed of an address and a port separated by a ':'. Example : elasticsearch.hosts=host1:9200,host2:9200</dd>
+ <dt><strong>opensearch.hosts</strong></dt>
+ <dd>List of comma separated hosts. An host is composed of an address and a port separated by a ':'. Example : opensearch.hosts=host1:9200,host2:9200</dd>
</dl>
Other options includes :
<dl>
- <dt><strong>elasticsearch.clusterName</strong></dt>
+ <dt><strong>opensearch.clusterName</strong></dt>
<dd>Is the name of the cluster used by James.</dd>
- <dt><strong>elasticsearch.nb.shards</strong></dt>
+ <dt><strong>opensearch.nb.shards</strong></dt>
<dd>Number of shards for index provisionned by James</dd>
- <dt><strong>elasticsearch.nb.replica</strong></dt>
+ <dt><strong>opensearch.nb.replica</strong></dt>
<dd>Number of replica for index provisionned by James (default: 0)</dd>
- <dt><strong>elasticsearch.index.waitForActiveShards (default: 1)</strong></dt>
+ <dt><strong>opensearch.index.waitForActiveShards (default: 1)</strong></dt>
<dd>Wait for a certain number of active shard copies before proceeding with the operation.</dd>
<dd>You may consult the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html#active-shards">documentation</a> for more information.</dd>
- <dt><strong>elasticsearch.index.mailbox.name</strong></dt>
+ <dt><strong>opensearch.index.mailbox.name</strong></dt>
<dd>Name of the mailbox index backed by the alias. It will be created if missing.</dd>
- <dt><strong>elasticsearch.index.name</strong></dt>
- <dd><strong>Deprecated</strong> Use <strong>elasticsearch.index.mailbox.name</strong> instead. <br/>
+ <dt><strong>opensearch.index.name</strong></dt>
+ <dd><strong>Deprecated</strong> Use <strong>opensearch.index.mailbox.name</strong> instead. <br/>
Name of the mailbox index backed by the alias. It will be created if missing.</dd>
- <dt><strong>elasticsearch.max.connections</strong></dt>
- <dd>Maximum count of HTTP connections allowed for the ElasticSearch driver. Optional integer, if unspecified driver defaults
+ <dt><strong>opensearch.max.connections</strong></dt>
+ <dd>Maximum count of HTTP connections allowed for the OpenSearch driver. Optional integer, if unspecified driver defaults
applies (30 connections).</dd>
- <dt><strong>elasticsearch.max.connections.per.hosts</strong></dt>
- <dd>Maximum count of HTTP connections per host allowed for the ElasticSearch driver. Optional integer, if unspecified driver defaults
+ <dt><strong>opensearch.max.connections.per.hosts</strong></dt>
+ <dd>Maximum count of HTTP connections per host allowed for the OpenSearch driver. Optional integer, if unspecified driver defaults
applies (10 connections).</dd>
- <dt><strong>elasticsearch.alias.read.mailbox.name</strong></dt>
+ <dt><strong>opensearch.alias.read.mailbox.name</strong></dt>
<dd>Name of the alias to use by Apache James for mailbox reads. It will be created if missing.
The target of the alias is the index name configured above.</dd>
- <dt><strong>elasticsearch.alias.read.name</strong></dt>
- <dd><strong>Deprecated</strong> Use <strong>elasticsearch.alias.read.mailbox.name</strong> instead. <br/>
+ <dt><strong>opensearch.alias.read.name</strong></dt>
+ <dd><strong>Deprecated</strong> Use <strong>opensearch.alias.read.mailbox.name</strong> instead. <br/>
Name of the alias to use by Apache James for mailbox reads. It will be created if missing.
The target of the alias is the index name configured above.</dd>
- <dt><strong>elasticsearch.alias.write.mailbox.name</strong></dt>
+ <dt><strong>opensearch.alias.write.mailbox.name</strong></dt>
<dd>Name of the alias to use by Apache James for mailbox writes. It will be created if missing.
The target of the alias is the index name configured above.</dd>
- <dt><strong>elasticsearch.alias.write.name</strong></dt>
- <dd><strong>Deprecated</strong> Use <strong>elasticsearch.alias.write.mailbox.name</strong> instead. <br/>
+ <dt><strong>opensearch.alias.write.name</strong></dt>
+ <dd><strong>Deprecated</strong> Use <strong>opensearch.alias.write.mailbox.name</strong> instead. <br/>
Name of the alias to use by Apache James for mailbox writes. It will be created if missing.
The target of the alias is the index name configured above.</dd>
- <dt><strong>elasticsearch.retryConnection.maxRetries</strong></dt>
+ <dt><strong>opensearch.retryConnection.maxRetries</strong></dt>
<dd>Number of retries when connecting the cluster</dd>
- <dt><strong>elasticsearch.retryConnection.minDelay</strong></dt>
+ <dt><strong>opensearch.retryConnection.minDelay</strong></dt>
<dd>Minimum delay between connection attempts</dd>
- <dt><strong>elasticsearch.indexAttachments</strong></dt>
+ <dt><strong>opensearch.indexAttachments</strong></dt>
<dd>Indicates if you wish to index attachments or not (default: true).</dd>
- <dt><strong>elasticsearch.index.quota.ratio.name</strong></dt>
- <dd>Specify the ElasticSearch alias name used for quotas</dd>
- <dt><strong>elasticsearch.alias.read.quota.ratio.name</strong></dt>
- <dd>Specify the ElasticSearch alias name used for reading quotas</dd>
- <dt><strong>elasticsearch.alias.write.quota.ratio.name</strong></dt>
- <dd>Specify the ElasticSearch alias name used for writing quotas</dd>
+ <dt><strong>opensearch.index.quota.ratio.name</strong></dt>
+ <dd>Specify the OpenSearch alias name used for quotas</dd>
+ <dt><strong>opensearch.alias.read.quota.ratio.name</strong></dt>
+ <dd>Specify the OpenSearch alias name used for reading quotas</dd>
+ <dt><strong>opensearch.alias.write.quota.ratio.name</strong></dt>
+ <dd>Specify the OpenSearch alias name used for writing quotas</dd>
</dl>
<p>
- ElasticSearch component can be disabled but consider it would make search feature to not work. In particular it will break JMAP protocol and SEARCH IMAP comment in an nondeterministic way.
+ OpenSearch component can be disabled but consider it would make search feature to not work. In particular it will break JMAP protocol and SEARCH IMAP comment in an nondeterministic way.
This is controlled in the <code>search.properties</code> file via the <code>implementation</code> property (defaults
- to <code>ElasticSearch</code>). Setting this configuration parameter to <code>scanning</code> will effectively disable ElasticSearch, no
+ to <code>OpenSearch</code>). Setting this configuration parameter to <code>scanning</code> will effectively disable OpenSearch, no
further indexation will be done however searches will rely on the scrolling search, leading to expensive and longer
- searches. Disabling ElasticSearch requires no extra action, however
+ searches. Disabling OpenSearch requires no extra action, however
<a href="https://github.com/apache/james-project/blob/master/src/site/markdown/server/manage-webadmin.md#reindexing-all-mails">
- a full re-indexing</a> needs to be carried out when enabling ElasticSearch.
+ a full re-indexing</a> needs to be carried out when enabling OpenSearch.
</p>
- For configuring the metric reporting on ElasticSearch :
-
- <p>
- In server version 3.6.0 james moved from Elasticsearch 6 to 7 and the metric reporting on Elasticsearch is deprecated.
- You can still use metric reporting on Elasticsearch but that requires you to run a separate Elasticsearch 6 instance and use that in your Elasticsearch metric reporting configuration.
- </p>
-
- <dl>
- <dt><strong>elasticsearch.http.host</strong></dt>
- <dd>Host to report metrics on. Defaults to master host. Compatible with 6.x hosts</dd>
-
- <dt><strong>elasticsearch.http.port</strong></dt>
- <dd>Http port to use for publishing metrics</dd>
-
- <dt><strong>elasticsearch.metrics.reports.enabled</strong></dt>
- <dd>Boolean value. Enables metrics reporting.</dd>
-
- <dt><strong>elasticsearch.metrics.reports.period</strong></dt>
- <dd>Seconds between metric reports</dd>
-
- <dt><strong>elasticsearch.metrics.reports.index</strong></dt>
- <dd>Index to publish metrics on</dd>
- </dl>
-
-<p>If you want more explanation about ElasticSearch configuration, you should visit the dedicated <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">documentation</a>.</p>
+<p>If you want more explanation about OpenSearch configuration, you should visit the dedicated <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">documentation</a>.</p>
</section>
<section name="Tika Configuration">
- <p>When using ElasticSearch, you can configure an external Tika server for extracting and indexing text from attachments.
+ <p>When using OpenSearch, you can configure an external Tika server for extracting and indexing text from attachments.
Thus you can significantly improve user experience upon text searches.</p>
- <p>Note that to use this feature you need Guice, built with ElasticSearch</p>
+ <p>Note that to use this feature you need Guice, built with OpenSearch</p>
<p>Consult <a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/tika.properties">tika.properties</a> to get some examples and hints.</p>
@@ -219,7 +195,7 @@
</p>
<dl>
- <dt><strong>elasticsearch.hostScheme.https.sslValidationStrategy</strong></dt>
+ <dt><strong>opensearch.hostScheme.https.sslValidationStrategy</strong></dt>
<dd>
Optional. Accept only <strong>default</strong>, <strong>ignore</strong>, <strong>override</strong>. Default is <strong>default</strong>
</dd>
@@ -259,17 +235,17 @@
</p>
<dl>
- <dt><strong>elasticsearch.hostScheme.https.trustStorePath</strong></dt>
+ <dt><strong>opensearch.hostScheme.https.trustStorePath</strong></dt>
<dd>
- Optional. Use it when https is configured in elasticsearch.hostScheme, and sslValidationStrategy is <strong>override</strong>
- Configure Elasticsearch rest client to use this trustStore file to recognize nginx's ssl certificate.
+ Optional. Use it when https is configured in opensearch.hostScheme, and sslValidationStrategy is <strong>override</strong>
+ Configure OpenSearch rest client to use this trustStore file to recognize nginx's ssl certificate.
Once you chose <strong>override</strong>, you need to specify both trustStorePath and trustStorePassword.
</dd>
- <dt><strong>elasticsearch.hostScheme.https.trustStorePassword</strong></dt>
+ <dt><strong>opensearch.hostScheme.https.trustStorePassword</strong></dt>
<dd>
- Optional. Use it when https is configured in elasticsearch.hostScheme, and sslValidationStrategy is <strong>override</strong>
- Configure Elasticsearch rest client to use this trustStore file with the specified password.
+ Optional. Use it when https is configured in opensearch.hostScheme, and sslValidationStrategy is <strong>override</strong>
+ Configure OpenSearch rest client to use this trustStore file with the specified password.
Once you chose <strong>override</strong>, you need to specify both trustStorePath and trustStorePassword.
</dd>
</dl>
@@ -279,7 +255,7 @@
You can configure to use which HostNameVerifier in the client.
</p>
<dl>
- <dt><strong>elasticsearch.hostScheme.https.hostNameVerifier</strong></dt>
+ <dt><strong>opensearch.hostScheme.https.hostNameVerifier</strong></dt>
<dd>
Optional. Default is <strong>default</strong>.
</dd>
@@ -292,7 +268,7 @@
<section name="Search overrides">
<p><b>Search overrides</b> allow resolution of predefined search queries against alternative sources of data
- and allow bypassing ElasticSearch. This is useful to handle most resynchronisation queries that
+ and allow bypassing OpenSearch. This is useful to handle most resynchronisation queries that
are simple enough to be resolved against Cassandra.</p>
<ul>Possible values are:<br/>
@@ -310,13 +286,13 @@
</ul>
<p>
- Please note that custom overrides can be defined here. <pre>elasticsearch.search.overrides</pre> allow specifying search overrides and is a
+ Please note that custom overrides can be defined here. <pre>opensearch.search.overrides</pre> allow specifying search overrides and is a
coma separated list of search override FQDNs. Default to none.
</p>
<p>EG:</p>
- <pre><code>elasticsearch.search.overrides=org.apache.james.mailbox.cassandra.search.AllSearchOverride,org.apache.james.mailbox.cassandra.search.DeletedSearchOverride, org.apache.james.mailbox.cassandra.search.DeletedWithRangeSearchOverride,org.apache.james.mailbox.cassandra.search.NotDeletedWithRangeSearchOverride,org.apache.james.mailbox.cassandra.search.UidSearchOverride,org.apache.james.mailbox.cassandra.search.UnseenSearchOverride</code></pre>
+ <pre><code>opensearch.search.overrides=org.apache.james.mailbox.cassandra.search.AllSearchOverride,org.apache.james.mailbox.cassandra.search.DeletedSearchOverride, org.apache.james.mailbox.cassandra.search.DeletedWithRangeSearchOverride,org.apache.james.mailbox.cassandra.search.NotDeletedWithRangeSearchOverride,org.apache.james.mailbox.cassandra.search.UidSearchOverride,org.apache.james.mailbox.cassandra.search.UnseenSearchOverride</code></pre>
</section>
</body>
diff --git a/src/site/xdoc/server/feature-performance.xml b/src/site/xdoc/server/feature-performance.xml
index df731ffbbf..4759fde7a7 100644
--- a/src/site/xdoc/server/feature-performance.xml
+++ b/src/site/xdoc/server/feature-performance.xml
@@ -44,7 +44,7 @@
<img src="images/performances/gatling_2.png"/>
- <p>Load testing was conducted both on top of JPA and Cassandra + ElasticSearch implementations. We succeeded to support
+ <p>Load testing was conducted both on top of JPA and Cassandra + OpenSearch implementations. We succeeded to support
1.000 Thunderbird like users on top of both backends.</p>
<p>The following results were obtained on a server with an Intel Xeon CPU (E3–1231 3.40GHz 4 cores 8 threads) with 32
@@ -54,7 +54,7 @@
<subsection name="Metric collection">
<p> Additionally, we added metrics a bit everywhere in James using the brand new metrics API. We collect and export
- everything in ElasticSearch using <a href="http://metrics.dropwizard.io/3.2.1/">Dropwizard metrics</a>. Then we
+ everything in OpenSearch using <a href="http://metrics.dropwizard.io/3.2.1/">Dropwizard metrics</a>. Then we
graph it all using <a href="http://grafana.com/">Grafana</a>. This allows us to collect all statistics and percentiles.
Boards can be downloaded <a href="https://github.com/apache/james-project/tree/master/grafana-reporting">here</a>.</p>
@@ -67,7 +67,7 @@
</ul>
<ul>All these solutions allow us to identify the components that need improvement. Here are some example of classical
- metrics James can reach with a mono server Guice + Cassandra + ElasticSearch installation:
+ metrics James can reach with a mono server Guice + Cassandra + OpenSearch installation:
<li>About 100 users</li>
<li>So far a number of 1.500.000 e-mails, that we imported using IMAP-sync scripts</li>
<li>Around 15.000 incoming e-mails a day</li>
diff --git a/src/site/xdoc/server/features.xml b/src/site/xdoc/server/features.xml
index 3fd73b2587..e0e383229e 100644
--- a/src/site/xdoc/server/features.xml
+++ b/src/site/xdoc/server/features.xml
@@ -172,7 +172,7 @@
<td></td>
</tr>
<tr>
- <td>ElasticSearch search</td>
+ <td>OpenSearch search</td>
<td>Stable</td>
<td>yes</td>
<td>no</td>
diff --git a/src/site/xdoc/server/index.xml b/src/site/xdoc/server/index.xml
index d363b3649b..c79c17209c 100644
--- a/src/site/xdoc/server/index.xml
+++ b/src/site/xdoc/server/index.xml
@@ -56,7 +56,7 @@
<p>Apache James Server 3.7.0 and following versions require Java 1.11. A migration guide for
users willing to upgrade from 2.3 to 3.7.0 is <a href="upgrade-2.3.html">available</a>. If relying on Guice
- wiring, you can use some additional components (Cassandra, ElasticSearch, ...).</p>
+ wiring, you can use some additional components (Cassandra, OpenSearch, ...).</p>
diff --git a/src/site/xdoc/server/install.xml b/src/site/xdoc/server/install.xml
index 5ac2dac48b..c789fcb8e0 100644
--- a/src/site/xdoc/server/install.xml
+++ b/src/site/xdoc/server/install.xml
@@ -77,8 +77,8 @@
<ul>Using these instructions, you can build the following images:
<li>Guice + JPA + Lucene</li>
- <li>Guice + Cassandra + ElasticSearch</li>
- <li>Guice + Cassandra + ElasticSearch + LDAP</li>
+ <li>Guice + Cassandra + OpenSearch</li>
+ <li>Guice + Cassandra + OpenSearch + LDAP</li>
<li>Spring</li>
</ul>
@@ -90,7 +90,7 @@
</p>
<p>A <a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/docker-compose.yml">
- docker-compose</a> is available for Guice + Cassandra + ElasticSearch + RabbitMQ</p>
+ docker-compose</a> is available for Guice + Cassandra + OpenSearch + RabbitMQ</p>
</section>
<section name="Install Step by Step">
diff --git a/src/site/xdoc/server/objectives.xml b/src/site/xdoc/server/objectives.xml
index 7c8977a0ed..4b20116acf 100644
--- a/src/site/xdoc/server/objectives.xml
+++ b/src/site/xdoc/server/objectives.xml
@@ -45,7 +45,7 @@
<b>Horizontally scalable email server</b>
</i> Apache James uses resource abstraction (see below) to provide and assemble
the components of a <a href="https://james.staged.apache.org/james-distributed-app/3.7.0/index.html">Distributed Email server</a>
- based on modern, scalable NoSQL solutions: Cassandra, objectstorage, ElasticSearch, RabbitMQ/Pulsar.</p>
+ based on modern, scalable NoSQL solutions: Cassandra, objectstorage, OpenSearch, RabbitMQ/Pulsar.</p>
<p>
<i>
<b>Protocol abstraction</b>
diff --git a/src/site/xdoc/server/packaging.xml b/src/site/xdoc/server/packaging.xml
index 75a321f5fd..a18298fc78 100644
--- a/src/site/xdoc/server/packaging.xml
+++ b/src/site/xdoc/server/packaging.xml
@@ -40,9 +40,9 @@
<li><a href="https://github.com/apache/james-project/tree/master/server/app">Spring</a>: Allows you to
choose across various available implementations for each component. Requires more configuration effort.</li>
<li><a href="https://github.com/apache/james-project/tree/master/server/container/guice/cassandra-guice">
- Cassandra-guice</a>: Ships a James server storing emails in Cassandra and index them in ElasticSearch targeting single server deployment. Optional support for LDAP authentication.</li>
+ Cassandra-guice</a>: Ships a James server storing emails in Cassandra and index them in OpenSearch targeting single server deployment. Optional support for LDAP authentication.</li>
<li><a href="https://github.com/apache/james-project/tree/master/server/container/guice/cassandra-rabbitmq-guice">
- Distributed: cassandra-rabbitmq-guice</a>: Ships a James server storing emails in Cassandra and index them in ElasticSearch targeting multi node deployments. S3 is used to store blobs. RabbitMQ is used for inter-node messaging. Optional support for LDAP authentication.</li>
+ Distributed: cassandra-rabbitmq-guice</a>: Ships a James server storing emails in Cassandra and index them in OpenSearch targeting multi node deployments. S3 is used to store blobs. RabbitMQ is used for inter-node messaging. Optional support for LDAP authentication.</li>
<li><a href="https://github.com/apache/james-project/tree/master/server/container/guice/jpa-guice">
Jpa-Guice</a>: Ships a James server storing emails in a SQL database (derby by default) accessed with JPA and Lucene to index emails and targets single node deployment.</li>
<li><a href="https://github.com/apache/james-project/tree/master/server/container/guice/jpa-smtp">
@@ -164,8 +164,8 @@
<tr>
<td>Indexer implementation</td>
<td>Lucene/None</td>
- <td>ElasticSearch</td>
- <td>ElasticSearch</td>
+ <td>OpenSearch</td>
+ <td>OpenSearch</td>
<td>Lucene</td>
<td>None</td>
</tr>
@@ -235,7 +235,7 @@
<td>Cassandra</td>
<td>S3 or Cassandra</td>
<td>RabbitMQ</td>
- <td>ElasticSearch</td>
+ <td>OpenSearch</td>
<td>SMTP, IMAP, JMAP, POP3, LMTP, WebAdmin</td>
</tr>
<tr>
@@ -271,7 +271,7 @@
<td>Cassandra</td>
<td>Cassandra</td>
<td>In VM</td>
- <td>ElasticSearch</td>
+ <td>OpenSearch</td>
<td>SMTP, IMAP, JMAP, POP3, LMTP, WebAdmin</td>
</tr>
</table>
diff --git a/src/site/xdoc/server/quick-start-cassandra.xml b/src/site/xdoc/server/quick-start-cassandra.xml
index 13a65447b7..0c71406c21 100644
--- a/src/site/xdoc/server/quick-start-cassandra.xml
+++ b/src/site/xdoc/server/quick-start-cassandra.xml
@@ -66,10 +66,10 @@ You may skip this part if you already have a running Cassandra on your network.
<i>$ docker run --detach=true --name=cassandra cassandra:3.11.10</i>
-3.2. Deploy ElasticSearch (optional)
-You may skip this part if you already have a running ElasticSearch on your network.
+3.2. Deploy OpenSearch (optional)
+You may skip this part if you already have a running OpenSearch on your network.
-<i>$ docker run --detach=true --name=elasticsearch --env 'discovery.type=single-node' docker.elastic.co/elasticsearch/elasticsearch:7.10.2</i>
+<i>$ docker run -d --network james -p 9200:9200 --name=opensearch --env 'discovery.type=single-node' opensearchproject/opensearch:2.1.0</i>
Step 4: Configure
#################
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org