Jump to: navigation, search

Searchlight

Mission Statement

To provide advanced and scalable indexing and search across multi-tenant cloud resources.

Project Links

Developer Documentation http://docs.openstack.org/developer/searchlight/
API Reference http://developer.openstack.org/api-ref/search/
Source code - API and Listener Services https://github.com/openstack/searchlight
Source code - Horizon UI Plugin https://github.com/openstack/searchlight-ui
Source code - Python Client https://github.com/openstack/python-searchlightclient
Gerrit Reviews https://review.openstack.org/#/q/project:%255E.*searchlight.*+status:open,n,z
Bug tracker https://bugs.launchpad.net/searchlight
Feature tracker https://blueprints.launchpad.net/searchlight
IRC #openstack-searchlight
Meeting Times http://eavesdrop.openstack.org/#Searchlight_Team_Meeting
Meeting Agenda https://etherpad.openstack.org/p/search-team-meeting-agenda
Meeting Logs http://eavesdrop.openstack.org/meetings/openstack_search/

Overview

Searchlight dramatically improves the user focused search capabilities and performance on behalf of various OpenStack cloud services.

It accomplishes this by offloading user search queries from existing API servers and indexing their data into ElasticSearch. ElasticSearch is a search server based on Lucene. It provides a distributed, scalable, near real-time, faceted, multitenant-capable full-text search engine with a RESTful web interface and schema-free JSON documents. ElasticSearch is developed and released as open source under the terms of the Apache License. Notable users of ElasticSearch include Wikimedia, StumbleUpon, Mozilla, Quora, Foursquare, Etsy, SoundCloud, GitHub, FDA, CERN, and Stack Exchange. (Source: http://en.wikipedia.org/wiki/Elasticsearch). The elastic-recheck project also uses Elasticsearch (and kibana) to classify and track OpenStack gate failures. (Source: http://status.openstack.org/elastic-recheck)

Screencasts

Design

Concept Overview

Searchlight-Concept-1.png

Concept Internals Overview

Get Involved

Please join with us to help move forward together as a communityǃ

Searchlight is an open project and we encourage contribution from everybody.

We support both developers and non-developers who want to provide input, requests for features, and bug fixes. We want to be able to move quickly without getting too bogged down in process, but still provide a rich mechanism for feature reviews as needed.

History

Searchlight was originally developed and released in the Kilo release of Glance as the Catalog Index Service [1]. At the Liberty Summit we decided to broaden the scope to provide advanced and scalable search across multi-tenant cloud resources.

[1] http://specs.openstack.org/openstack/glance-specs/specs/kilo/catalog-index-service.html