You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/11/01 10:51:26 UTC

[james-project] 05/06: JAMES-2917 Document breaking changes in changelog + upgrade instructions

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 41723651088d0fd68b67c2142919760fc7b40824
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Thu Oct 10 14:14:58 2019 +0700

    JAMES-2917 Document breaking changes in changelog + upgrade instructions
---
 CHANGELOG.md            |  5 +++++
 upgrade-instructions.md | 23 +++++++++++++++++++++++
 2 files changed, 28 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5558963..d2894c4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
 
+### Changed
+- Multiple changes have been made to enhance ElasticSearch performance:
+  - Use of routing keys to collocate documents per mailbox
+  - Read related [upgrade instructions](upgrade-instructions.md)
+
 ### Removed
 - Classes marked as deprecated whose removal was planned after 3.4.0 release (See JAMES-2703). This includes:
   - SieveDefaultRepository. Please use SieveFileRepository instead.
diff --git a/upgrade-instructions.md b/upgrade-instructions.md
index 3ee23cb..18b8d7f 100644
--- a/upgrade-instructions.md
+++ b/upgrade-instructions.md
@@ -16,8 +16,31 @@ Changes to apply between 3.4.x and 3.5.x will be reported here.
 
 Change list:
 
+ - [ElasticSearch performance enhancements](#elasticsearch-performance-enhancements)
  - [JAMES-2703 Post 3.4.0 release removals](#james-2703-post-340-release-removals)
  
+### ElasticSearch performance enhancements
+
+Date 10/10/2019
+
+SHA-1 0d72783ff4
+
+JIRAS:
+ - https://issues.apache.org/jira/browse/JAMES-2917
+
+Concerned product: Guice product relying on ElasticSearch
+
+We significantly improved our usage of ElasticSearch. Underlying changes include:
+
+ - The use of routing to collocate emails of a same mailbox within a same shard. This enables search queries to avoid cluster
+ level synchronisation, and thus enhance throughput, latencies and scalability.
+
+The downside of these changes is that a reindex is needed, implying a downtime on search:
+ - Delete the indexes used by James
+ - Start James in order to create the missing indexes
+ - Trigger a [Full ReIndexing](https://james.apache.org/server/manage-webadmin.html#ReIndexing_all_mails), which can take
+  time to complete.
+ 
 #### JAMES-2703 Post 3.4.0 release removals
 
 Date: 25/09/2019


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org