Better documentation of the compatible Elasticsearch version

Bug #1517729 reported by Aaron Wells
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mahara
Fix Released
Low
Unassigned

Bug Description

See the discussion at the bottom of Bug 1389446.

Currently, Mahara is using Elastica version 2.0 for our Elasticsearch PHP library. The Elastica project uncoupled their version numbers from Elasticsearch's version numbers with the 2.0 release, so Elastica 2.0 was written to support Elasticsearch 1.5.

However, there doesn't seem to be anywhere in the Mahara documentation that specifies *which* version of Elasticsearch we support. Even the README.Mahara file in htdocs/lib/elastica doesn't say it! So, we should really document that somewhere. Possibly in Mahara's main README, and/or the Elastica README, maybe even on the elasticsearch plugin's config page.

In fact... maybe it would be a good idea if the elasticsearch plugin was able to sniff the elasticsearch version and tell you that it's not a compatible version? Of course, that does rely on the version detection system of Elasticsearch being backwards compatible.

On a related note, we should also upgrade our Elastica version.

Revision history for this message
Aaron Wells (u-aaronw) wrote :

For the record, in Mahara 15.10 we use Elastica 2.0.0, which supports up to Elasticsearch 1.5.2: http://elastica.io/2015/05/13/release-2-dot-0-0/

In 15.04 to 1.8 we were using Elastica 0.90.1, which supports up to Elasticsearc 0.90.1: http://elastica.io/2013/06/07/release-v0-dot-90-dot-1-0/

Aaron Wells (u-aaronw)
tags: added: documentation elasticsearch
no longer affects: mahara/15.10
no longer affects: mahara/16.04
Robert Lyon (robertl-9)
Changed in mahara:
milestone: 16.10.1 → 17.04.0
no longer affects: mahara/16.10
Changed in mahara:
milestone: 17.04.0 → 17.10.0
Revision history for this message
Robert Lyon (robertl-9) wrote :

In the 17.10+ versions of Mahara we specify the versions needed in elasticsearch/lib.php

    /**
     * The version of elasticsearch this plugin is compatible with.
     */
    const elasticsearch_version = '5.0';

    /**
     * The version of elasticsearch-php this plugin is compatible with.
     */
    const elasticsearchphp_version = '5.0';

Changed in mahara:
status: Confirmed → Fix Committed
Robert Lyon (robertl-9)
Changed in mahara:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.