Page MenuHomePhabricator

Document compatible and recommended versions of the dependencies and software required to install and run Wikibase software components
Closed, ResolvedPublic3 Estimated Story Points

Description

As an administrator of a Wikibase instance, installing the software from the official WMDE tarball releases, I want to know what versions of dependencies are compatible, so that I know what to install and update on my system when installing or updating Wikibase software packages.

Acceptance criteria

  • The format of documenting the compatible/required/recommended versions of the accompanying software has been established
  • The format and procedure of updating the dependency data has been documented for the information of WMDE developers
  • Compatible version of dependencies and software include in the below list have been documented

List of (incomplete) software depdendencies that need to have compatible versions specified

  • PHP runtime version
  • RDBMS engine (MySQL/Mariadb, Sqlite), and its versions
  • MediaWiki version
  • Elasticsearch version

Notes

  • As of November 2020 it is assumed this information will mostly be essential for users of tarball releases. Docker container images are expected to come equipped with the compatible and recommended version of the accompanying software

Event Timeline

Adds testing of databases we claim to support -> https://github.com/wmde/wikibase-release-pipeline/pull/119
A simple script that outputs what was used -> https://github.com/wmde/wikibase-release-pipeline/pull/120

The format of documenting the compatible/required/recommended versions of the accompanying software has been established

Wikibase requires web server, SQL database server and PHP runtime.

  • PHP versions supported: 7.3
  • SQL databases recommended: Maria DB (version 10.3 or newer), MySQL (version 5.6 or newer)

Additional software

  • Elasticsearch 6.5.4
  • WDQS/Blazegraph 0.3.40

The format and procedure of updating the dependency data has been documented for the information of WMDE developers
Compatible version of dependencies and software include in the below list have been documented

The pipeline can now output a list of versions for the components it tested. This is included in the BuildMetadata artifacts.

Example output from wmde.0

Mediawiki 1.35
Elasticsearch 6.5.4
WDQS 0.3.40
PHP 7.3
Databases: mysql:5.6, mariadb:10.3

Example output from master

Mediawiki 1.36
Elasticsearch 6.5.4
WDQS 0.3.40
PHP 7.2
Databases: mysql:5.6, mariadb:10.3

This can then be used to update the formatted text on the documentation site.

Looks like the peer review has concluded.

Is it actually intended that PHP 7.2 is used? Per what you wrote above as:

PHP versions supported: 7.3

PHP version requirement to be confirmed. Otherwise this looks okay.
I guess we might also want to add some of the compatibility information to some README file(s) in some git repositories. But this is out of scope of this task.