Skip to content
This repository has been archived by the owner on Jul 4, 2021. It is now read-only.

Latest commit

 

History

History
68 lines (46 loc) · 3.75 KB

README.md

File metadata and controls

68 lines (46 loc) · 3.75 KB

wdqs docker image

Wikibase specific blazegraph image.

Automated build.

Tags

Image name Parent image WDQS Version
wikibase/wdqs : 0.3.40, latest openjdk:8-jdk-alpine 0.3.40
wikibase/wdqs : 0.3.10 openjdk:8-jdk-alpine 0.3.10
wikibase/wdqs : 0.3.6 openjdk:8-jdk-alpine 0.3.6

Upgrading

When upgrading between wdqs versions the data stored in /wdqs/data may not be compatible with the newer version. When testing the new image if no data appears to be loaded into the query service you will need to reload the data.

If all changes are still in RecentChanges then simply removing /wdqs/data and restarting the service should reload all data.

If you can not use RecentChanges then you will need to reload from an RDF dump:

Environment variables

Variable Default Since Description
MEMORY "" 0.2.5 Memory limit for blazegraph
HEAP_SIZE "1g" 0.2.5 Heap size for blazegraph
WIKIBASE_HOST "wikibase.svc" 0.2.5 Hostname of the Wikibase host
WIKIBASE_SCHEME "http" 0.2.5 Scheme of the Wikibase host
WDQS_HOST "wdqs.svc" 0.2.5 Hostname of the WDQS host (this service)
WDQS_PORT "9999" 0.2.5 Port of the WDQS host (this service)
WDQS_ENTITY_NAMESPACES "120,122" 0.2.5 Wikibase Namespaces to load data from
WIKIBASE_MAX_DAYS_BACK "90" 0.3.0 Max days updater is allowed back from now

Filesystem layout

File Description
/wdqs/whitelist.txt Whitelist file for other SPARQL endpoints
/wdqs/RWStore.properties Properties for the service
/templates/mwservices.json Template for MediaWiki services (substituted to /wdqs/mwservices.json at runtime)

Troubleshooting

  • The query service is not running or seems to get killed by the OS?
    • The image requires more than 2GB of available RAM to start. While being developed the dev machine had 4GB of RAM.

Development

New versions of this image should be created alongside new versions of wdqs that are used in production for Wikidata.

New releases that are available for images to be created can be found on archiva: https://archiva.wikimedia.org/repository/releases/org/wikidata/query/rdf/service/

When creating a new image RWStore.properties will need to be updated to match the properties used in production at the time the snapshot was being used.

For this reason it is easier to only create new releases for wdqs versions currently being used in Wikidata production.

When creating a new release the WMF Search platform team should be contacted for help syncing the wdqs version and RWStore.properties file.

The process is generally:

  • Create a new directory using a previous one as an example
  • Update the service snapshot that is being fetched
  • Update the CI build by checking the steps in the main README Development section in this repo.