Distributed James Server — Operate the Distributed server

The following pages detail how to operate the Distributed James Server.

Once you have a Distributed James Server up and running you then need to ensure it operates correctly and has a decent performance. You may also need to perform some operation maintenance or recover from incidents. This section covers these topics.

Read more about Logging.

The WebAdmin Restfull administration API is the recommended way to operate the Distributed James Server. It allows managing and interacting with most server components.

The Command line interface allows to interact with some server components. However it relies on JMX technologies and its use is discouraged.

The metrics allows to build latency and throughput graphs, that can be visualized, for instance in Grafana.

We did put together a detailed guide for distributed James operators. We also propose a performance checklist.

We also included a guide for migrating existing data into the distributed server.

Additional functional visualisations can be set up using OpenSearch dashboards as documented in this example.

Read more about Cassandra data migration.

Additional functional visualisations can be set up using OpenSearch dashboards as documented in this example.

Upgrading

This section sums up and links upgrade instructions for people willing to upgrade their Distributed server to newer versions.

Table 1. Upgrade path
Upgrade from Recommended upgrade path to 3.7.4

3.7.0 - 3.7.4

Upgrade, and apply 3.8.0 upgrade instructions

3.6.0 - 3.6.2

1. Upgrade, and apply 3.7.0 upgrade instructions

2. Upgrade, and apply 3.8.0 upgrade instructions

3.5.0

1. Upgrade, and apply 3.6.0 upgrade instructions

Note: Because of ElasticSearch upgrade (6.3 → 7.10) this migration cannot be done in a rolling fashion manner.

2. Upgrade, and apply 3.7.0 upgrade instructions

3. Upgrade, and apply 3.8.0 upgrade instructions

3.4.0

1. Rolling upgrade to 3.5.0, and apply 3.5.0 upgrade instructions

2. Upgrade to 3.6.0, and apply 3.6.0 upgrade instructions

Note: Because of ElasticSearch upgrade (6.3 → 7.10) this migration cannot be done in a rolling fashion manner.

3. Upgrade, and apply 3.7.0 upgrade instructions

4. Upgrade, and apply 3.8.0 upgrade instructions

3.3.0

1. upgrade to 3.4.0, and apply 3.4.0 upgrade instructions

Note: Because of ElasticSearch upgrade (2.2 → 6.3) this migration cannot be done in a rolling fashion manner.

2. Rolling upgrade to 3.5.0, and apply 3.5.0 upgrade instructions

3. Upgrade to 3.6.0, and apply 3.6.0 upgrade instructions

Note: Because of ElasticSearch upgrade (6.3 → 7.10) this migration cannot be done in a rolling fashion manner.

4. Upgrade, and apply 3.7.0 upgrade instructions

5. Upgrade, and apply 3.8.0 upgrade instructions