Help:Toolforge/Elasticsearch

Toolforge

• Cloud Services overview
• Toolforge user docs

Get started

• Quickstart: set up and get access
• How Toolforge works
• Rules you must follow
• Tutorials

Build and run tools

• Navigate tool accounts and files
• Kubernetes backend
• Run a web service
• Schedule and manage jobs
• Language-specific details:
  • Python
  • Pywikibot
  • Node.js
  • PHP
  • ...more languages/frameworks
• Use Redis for caching
• Index content with Elasticsearch

Access shared storage and databases

• Access shared storage and public wiki dumps
• Access wiki replicas
• Access replica search indices
• Manage tool databases

Share and maintain tools

• Set up version control and code review
• Develop successful tools
• Find and share tools on Toolhub
• Deprecate a tool
• Contribute to Toolforge

Get help

• How and where to get help
• Troubleshooting

Useful links

• Toolforge admin docs
• List of tools
• Toolforge Admin Console (toolsadmin)

[]

Overview

This page contains information about local Elasticsearch services in Toolforge. For information about the replica of the Wikimedia CirrusSearch Elasticsearch indices available from Toolforge and Cloud VPS instances, see Help:CirrusSearch elasticsearch replicas.

About Elasticsearch

Elasticsearch is a full-text search system built on Apache Lucene. It can be used to index and search data stored as JSON documents.

Elasticsearch is the technology used to power Wikimedia's CirrusSearch system.

Elasticsearch for Toolforge

An Elasticsearch version 7 cluster for all tools is available at http://elasticsearch.svc.tools.eqiad1.wikimedia.cloud, on the non-standard port 80.

This Elasticsearch cluster is a shared resource. All documents indexed in it can be read by anonymous users from within Toolforge. Write access is needed to create new indexes, and a password is needed to store or update documents. However, see addition notes on the talk page.

Read-only access

The Elasticsearch servers allow anyone to read any of the indexes that it contains. This access is limited to other hosts in the Toolforge project (e.g. the OGE job grid, Kubernetes containers, and the bastion servers).

The Elasticsearch service is available on port 80 at http://elasticsearch.svc.tools.eqiad1.wikimedia.cloud

Note: The default Elasticsearch port (9200) is not used.

Write access

Elasticsearch does not offer multi-tenant access control in its open source version.

PUT, POST, or DELETE requests sent to the Elasticsearch servers require HTTP Basic Authentication using a username and password specific to each tool.

Requests for write access can be made by filing this Phabricator task.

When credentials have been created they will be placed in /data/project/$TOOL/.elasticsearch.ini. Access requests are currently processed manually and may take a few days to be fulfilled.

Communication and support

Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. Please reach out with questions and join the conversation:

Discuss and receive general support

• Chat in real time in the IRC channel #wikimedia-cloud ^connect, the bridged Telegram group, or the bridged Mattermost channel
• Discuss via email after you have subscribed to the cloud@ mailing list

Stay aware of critical changes and plans

• Subscribe to the cloud-announce@ mailing list (all messages are also mirrored to the cloud@ list)
• Read the News wiki page

Track work tasks and report bugs

Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself

Read stories and WMCS blog posts

Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)