openstack/searchlight
Code Issues Proposed changes

Retire the Searchlight project

Browse Source 
As announced in openstack-discuss ML[1], Searchlight project
is retiring in Wallaby cycle.

This commit retires this repository as per process deinfed in
project-guide[2]. Anyone would like to maintain it again, please
revert back this commit and propose the re-adding of Searchlight
to governance.

The community wishes to express our thanks and appreciation to all of
those who have contributed to the Searchlight project over the years.

Depends-On: https://review.opendev.org/c/openstack/project-config/+/764519
Needed-By: https://review.opendev.org/c/openstack/governance/+/764530

[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018637.html
[2] https://docs.openstack.org/project-team-guide/repository.html#retiring-a-repository

Change-Id: I0c5c9a961cca19113f4d59e37cb16e3bc0ccf8e1
This commit is contained in:
Ghanshyam Mann 2020-11-27 21:46:40 -06:00
parent ae76091a3b
commit 7331642231
388 changed files with 8 additions and 53968 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.coveragerc
View File

@ -1,7 +0,0 @@
[run]
branch = True
source = searchlight
omit = searchlight/tests/*
[report]
ignore_errors = True

44
.gitignore vendored
View File

@ -1,44 +0,0 @@
*.pyc
*.log
.searchlight-venv
.venv
.stestr/
.tox
.coverage*
cover/*
covhtml
nosetests.xml
coverage.xml
searchlight.sqlite
AUTHORS
ChangeLog
build
.DS_Store
dist
*.egg
searchlight.egg-info
tests.sqlite
searchlight/versioninfo
etc/searchlight.conf.sample
!/.coveragerc
#Files created by releasenotes build
releasenotes/build
# Swap files range from .saa to .swp
*.s[a-w][a-p]
# generated policy file
etc/searchlight/policy.yaml.sample
# Files created by doc build
doc/source/api
_static/
# IDE files
.project
.pydevproject
.idea
.e4p
.eric5project/
.issues/
.ropeproject

4
.stestr.conf
View File

@ -1,4 +0,0 @@
[DEFAULT]
test_path=./searchlight/tests
top_dir=.

8
.zuul.yaml
View File

@ -1,8 +0,0 @@
- project:
templates:
- openstack-python3-victoria-jobs
- openstack-cover-jobs
- publish-openstack-docs-pti
- check-requirements
- openstack-lower-constraints-jobs
- release-notes-jobs-python3

21
CONTRIBUTING.rst
View File

@ -1,21 +0,0 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps documented at:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Storyboard, not GitHub:
https://storyboard.openstack.org/#!/project_group/searchlight
Further documentation on feature request and bug report processes may be
found here:
https://docs.openstack.org/searchlight/latest/contributor/feature-requests-bugs.html

19
HACKING.rst
View File

@ -1,19 +0,0 @@
Searchlight Style Commandments
==============================
- Step 1: Read the OpenStack Style Commandments
https://docs.openstack.org/hacking/latest
- Step 2: Read on
Searchlight Specific Commandments
---------------------------------
- [SL316] Change assertTrue(isinstance(A, B)) by optimal assert like
assertIsInstance(A, B)
- [SL317] Change assertEqual(type(A), B) by optimal assert like
assertIsInstance(A, B)
- [SL318] Change assertEqual(A, None) or assertEqual(None, A) by optimal assert like
assertIsNone(A)
- [SL319] Validate that logs are not translated
- [SL327] Prevent use of deprecated contextlib.nested
- [SL343] Check for common double word typos

176
LICENSE
View File

@ -1,176 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

72
README.rst
View File

@ -1,66 +1,10 @@
========================
Team and repository tags
========================
This project is no longer maintained.
.. image:: https://governance.openstack.org/tc/badges/searchlight.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
:alt: Searchlight is an official OpenStack project as indicated by
the "project:official" badge
.. NOTE(rosmaita): the alt text above will have to be updated when
additional tags are asserted for Searchlight. (The SVG in the
governance repo is updated automatically.)
The contents of this repository are still available in the Git
source code management system. To see the contents of this
repository before it reached its end of life, please check out the
previous commit with "git checkout HEAD^1".
.. Change things from this point on
========
Welcome!
========
The Searchlight project provides indexing and search capabilities across
OpenStack resources. Its goal is to achieve high performance and flexible
querying combined with near real-time indexing. It uses Elasticsearch, a
real-time distributed indexing and search engine built on Apache Lucene, but
adds OpenStack authentication and Role Based Access Control to provide
appropriate protection of data.
Documentations
==============
* Installation instruction and user guides:
https://docs.openstack.org/searchlight/latest
* Searchlight wiki:
https://wiki.openstack.org/wiki/Searchlight
* Release notes: https://docs.openstack.org/releasenotes/searchlight/
* Specs: https://specs.openstack.org/openstack/searchlight-specs/
Code
====
Searchlight code is available in the following repositories:
* Searchlight API and Listener:
https://opendev.org/openstack/searchlight
* Searchlight Python client:
https://opendev.org/openstack/python-searchlightclient
* Searchlight Horizon UI:
https://opendev.org/openstack/searchlight-ui
Bugs
====
Please report bugs at https://storyboard.openstack.org/#!/project_group/searchlight
License
=======
Apache Licence 2.0
Other Resources
===============
Use the following resources to learn more:
* Storyboard project: https://storyboard.openstack.org/#!/project_group/searchlight
* Send mail to openstack-discuss@lists.openstack.org with [Searchlight]
tag for help and hacking of Searchlight
* IRC channel: #openstack-searchlight
For any further questions, please email
openstack-discuss@lists.openstack.org or join #openstack-dev on
Freenode.

209
api-ref/source/conf.py
View File

@ -1,209 +0,0 @@
# -*- coding: utf-8 -*-
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# searchlight api-ref build config file, copied from:
# nova documentation build configuration file, created by
# sphinx-quickstart on Sat May 1 15:17:47 2010.
#
# This file is execfile()d with the current directory set to
# its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import sys
html_theme = 'openstackdocs'
html_theme_options = {
"sidebar_mode": "toc",
}
extensions = [
'os_api_ref',
'openstackdocstheme'
]
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/searchlight'
openstackdocs_bug_project = 'searchlight'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Search Service API Reference'
copyright = u'2015-present, OpenStack Foundation'
# for a list of supported languages.
#
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# The reST default role (used for this markup: `text`) to use
# for all documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'native'
# -- Options for man page output ----------------------------------------------
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_use_modindex = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'searchlightdoc'
# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'Searchlight.tex', u'OpenStack Search Service API Documentation',
u'OpenStack Foundation', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
# latex_preamble = ''
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_use_modindex = True

55
api-ref/source/http-codes.yaml
View File

@ -1,55 +0,0 @@
200:
default: |
The response contains an entity corresponding to the requested resource.
201:
default: |
The request has been fullfilled and a new resource created.
202:
default: |
The request has been accepted for processing, but the processing has not
been completed.
204:
default: |
The request has been processed successfully.
400:
default: |
The server cannot (or will not) process the request due to a client error.
informal: |
Your bad ... something is wrong with your request.
401:
default: |
You have either forgotten to provide credentials, or the credentials you
provided are malformed or expired.
403:
default: |
You do not have sufficient permissions to perform the requested action.
404:
default: |
The resource you have requested cannot be found.
409:
default: |
The request you have made cannot be processed because it conflicts with
the current state of the resource.
410:
default: |
The requested resource is no longer available at the server and no
forwarding address is known.
413:
default: |
The payload you have submitted is too large given the configuration of the
server.
415:
default: |
The server is refusing to service the request because the entity of the
request is in a format not supported by the requested resource for the
requested method.
500:
default: |
The server encountered an unexpected condition which prevented it from
fulfilling the request.
informal: |
Our bad ... something unfortunate happened on the server.
503:
default: |
The server is currently unable to handle the request due to a temporary
overloading or maintenance of the server.

25
api-ref/source/index.rst
View File

@ -1,25 +0,0 @@
..
Copyright 2016 OpenStack Foundation
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
:tocdepth: 3
==================
Search Service API
==================
.. rest_expand_all::
.. include:: searchlight-v1.inc

6
api-ref/source/samples/create-search-admin-request.json
View File

@ -1,6 +0,0 @@
{
"query": {
"match_all": {}
},
"all_projects": true
}

11
api-ref/source/samples/create-search-aggregation-request.json
View File

@ -1,11 +0,0 @@
{
"query": {
"match_all": {}
},
"type": ["OS::Glance::Image"],
"limit": 0,
"aggregations": {
"name": {"terms": {"field": "name"}},
"container_format": {"terms": {"field": "container_format"}}
}
}

64
api-ref/source/samples/create-search-aggregation-response.json
View File

@ -1,64 +0,0 @@
{
"_shards": {
"successful": 1,
"failed": 0,
"total": 1
},
"aggregations": {
"container_format": {
"buckets": [
{
"doc_count": 101,
"key": "bare"
},
{
"doc_count": 1,
"key": "aki"
},
{
"doc_count": 1,
"key": "ami"
},
{
"doc_count": 1,
"key": "ari"
}
],
"doc_count_error_upper_bound": 0,
"sum_other_doc_count": 0
},
"name": {
"buckets": [
{
"doc_count": 100,
"key": "image"
},
{
"doc_count": 3,
"key": "0.3.4"
},
{
"doc_count": 3,
"key": "cirros"
},
{
"doc_count": 3,
"key": "uec"
},
{
"doc_count": 3,
"key": "x86_64"
}
],
"doc_count_error_upper_bound": 0,
"sum_other_doc_count": 0
}
},
"hits": {
"hits": [],
"max_score": 0.0,
"total": 104
},
"took": 5,
"timed_out": false
}

5
api-ref/source/samples/create-search-all-request.json
View File

@ -1,5 +0,0 @@
{
"query": {
"match_all": {}
}
}

61
api-ref/source/samples/create-search-all-response.json
View File

@ -1,61 +0,0 @@
{
"_shards": {
"failed": 0,
"successful": 2,
"total": 2
},
"hits": {
"hits": [
{
"_id": "76580e9d-f83d-49d8-b428-1fb90c5d8e95",
"_index": "searchlight",
"_type": "OS::Glance::Image",
"_score": 1.0,
"_source": {
"id": "76580e9d-f83d-49d8-b428-1fb90c5d8e95",
"members": [],
"name": "cirros-0.3.2-x86_64-uec",
"owner": "d95b27da6e9f4acc9a8031918e443e04",
"visibility": "public",
"...": "..."
}
},
{
"_id": "OS::Software::DBMS",
"_index": "searchlight",
"_type": "OS::Glance::Metadef",
"_score": 1.0,
"_source": {
"description": "A database is an ...",
"display_name": "Database Software",
"namespace": "OS::Software::DBMS",
"objects": [
{
"description": "PostgreSQL, often simply 'Postgres' ...",
"name": "PostgreSQL",
"properties": [
{
"default": "5432",
"description": "Specifies the TCP/IP port...",
"property": "sw_database_postgresql_listen_port",
"...": "..."
},
{ "...": "..." }
]
}
],
"tags": [
{
"name": "Database"
}
]
}
},
{ "...": "..." }
],
"max_score": 1.0,
"total": 8
},
"timed_out": false,
"took": 1
}

25
api-ref/source/samples/create-search-complex-boolean-request.json
View File

@ -1,25 +0,0 @@
{
"type": "OS::Glance::Image",
"query": {
"bool" : {
"must" : [
{ "term" : { "status" : "active" } },
{ "term" : { "visibility" : "public" } }
],
"must_not" : [
{ "range" : { "min_ram" : { "gt" : 4096 } } },
{ "terms" : { "disk_format" : ["aki", "ari"] } }
],
"should" : [
{ "match" : { "name" : "cirros" } },
{ "match" : { "tag" : "cirros" } }
],
"minimum_should_match" : 1
}
},
"highlight": {
"fields": {
"*":{}
}
}
}

93
api-ref/source/samples/create-search-complex-boolean-response.json
View File

@ -1,93 +0,0 @@
{
"hits": {
"hits": [
{
"_type": "OS::Glance::Image",
"_source": {
"status": "active",
"created_at": "2016-08-25T17:32:41Z",
"project_id": "98c05407d80c405aa6efa01b279385ce",
"name": "cirros-0.3.4-x86_64-uec",
"tags": [],
"image_type": "image",
"checksum": "eb9139e4942121f22bbc2afc0400b2a4",
"min_ram": 0,
"ramdisk_id": "f310fb51-29dc-47bf-8cbd-3ea1170fb4e3",
"disk_format": "ami",
"updated_at": "2016-08-25T17:32:42Z",
"visibility": "public",
"kernel_id": "34ddf1d2-b588-4a9a-a3d3-344768c04bfd",
"protected": false,
"members": [],
"container_format": "ami",
"min_disk": 0,
"owner": "98c05407d80c405aa6efa01b279385ce",
"virtual_size": null,
"id": "23fa3971-3ed8-435a-a3c6-8addea5153aa",
"size": 25165824
},
"_score": 3.3642778,
"_index": "searchlight-2016_08_25_18_48_30",
"highlight": {
"status": [
"<em>active</em>"
],
"name": [
"<em>cirros</em>-0.3.4-x86_64-uec"
],
"visibility": [
"<em>public</em>"
]
},
"_id": "23fa3971-3ed8-435a-a3c6-8addea5153aa"
},
{
"_type": "OS::Glance::Image",
"_source": {
"status": "active",
"created_at": "2016-08-25T17:32:34Z",
"project_id": "98c05407d80c405aa6efa01b279385ce",
"name": "cirros-0.3.4-x86_64-disk",
"tags": [],
"image_type": "image",
"checksum": "ee1eca47dc88f4879d8a229cc70a07c6",
"min_ram": 0,
"disk_format": "qcow2",
"updated_at": "2016-08-25T17:32:35Z",
"visibility": "public",
"owner": "98c05407d80c405aa6efa01b279385ce",
"protected": false,
"members": [],
"container_format": "bare",
"min_disk": 0,
"virtual_size": null,
"id": "f34de38c-7a5c-4b00-8015-70a7a63480e8",
"size": 13287936
},
"_score": 3.3642778,
"_index": "searchlight-2016_08_25_18_48_30",
"highlight": {
"status": [
"<em>active</em>"
],
"name": [
"<em>cirros</em>-0.3.4-x86_64-disk"
],
"visibility": [
"<em>public</em>"
]
},
"_id": "f34de38c-7a5c-4b00-8015-70a7a63480e8"
}
],
"total": 2,
"max_score": 3.3642778
},
"_shards": {
"successful": 1,
"failed": 0,
"total": 1
},
"took": 1,
"timed_out": false
}

9
api-ref/source/samples/create-search-free-text-request.json
View File

@ -1,9 +0,0 @@
{
"type": "OS::Glance::Image",
"query": {
"multi_match": {
"query":"cirros",
"fields": ["_all"]
}
}
}

45
api-ref/source/samples/create-search-free-text-response.json
View File

@ -1,45 +0,0 @@
{
"_shards": {
"failed": 0,
"successful": 2,
"total": 2
},
"hits": {
"hits": [
{
"_id": "76580e9d-f83d-49d8-b428-1fb90c5d8e95",
"_index": "searchlight",
"_type": "OS::Glance::Image",
"_score": 1.0,
"_source": {
"id": "76580e9d-f83d-49d8-b428-1fb90c5d8e95",
"members": [],
"name": "cirros-0.3.2-x86_64-uec",
"owner": "d95b27da6e9f4acc9a8031918e443e04",
"visibility": "public",
"...": "..."
}
},
{
"_id": "15c2501d-07bd-4eb1-b15f-77ef739e5419",
"_index": "searchlight",
"_type": "OS::Glance::Image",
"_score": 1.0,
"_source": {
"id": "15c2501d-07bd-4eb1-b15f-77ef739e5419",
"description": "Extra special cirros image",
"members": [],
"name": "Simply Sensational",
"owner": "d95b27da6e9f4acc9a8031918e443e04",
"visibility": "public",
"...": "..."
}
},
{ "...": "..." }
],
"max_score": 1.0,
"total": 8
},
"timed_out": false,
"took": 1
}

6
api-ref/source/samples/create-search-multiple-type-request.json
View File

@ -1,6 +0,0 @@
{
"query": {
"match_all": {}
},
"type": ["OS::Glance::Image", "OS::Glance::Metadef"]
}

8
api-ref/source/samples/create-search-phrase-field-request.json
View File

@ -1,8 +0,0 @@
{
"type": "OS::Glance::Image",
"query": {
"match_phrase": {
"description": "Preconfigured with a schmaltz to optimize the foobar"
}
}
}

45
api-ref/source/samples/create-search-phrase-field-response.json
View File

@ -1,45 +0,0 @@
{
"hits": {
"hits": [
{
"_score": 12.945373,
"_type": "OS::Glance::Image",
"_id": "7a99b58d-0b70-4138-8086-ab0cc4bd1ba3",
"_source": {
"container_format": "bare",
"min_ram": 0,
"updated_at": "2016-08-25T17:54:02Z",
"cim_pasd_processorarchitecture": "Power",
"owner": "158776c9face41a7a3026d6c1cae686a",
"id": "7a99b58d-0b70-4138-8086-ab0cc4bd1ba3",
"size": 5969,
"image_type": "image",
"disk_format": "raw",
"project_id": "158776c9face41a7a3026d6c1cae686a",
"status": "active",
"description": "Preconfigured with a schmaltz to optimize the foobar",
"tags": [],
"hw_cpu_policy": "shared",
"visibility": "public",
"members": [],
"min_disk": 0,
"virtual_size": null,
"name": "My Awesome Image",
"checksum": null,
"created_at": "2016-08-25T17:54:02Z",
"protected": false
},
"_index": "searchlight-2016_08_25_18_48_30"
}
],
"total": 1,
"max_score": 12.945373
},
"_shards": {
"successful": 1,
"failed": 0,
"total": 1
},
"took": 4,
"timed_out": false
}

6
api-ref/source/samples/create-search-single-type-request.json
View File

@ -1,6 +0,0 @@
{
"query": {
"match_all": {}
},
"type": "OS::Glance::Image"
}

44
api-ref/source/samples/create-search-single-type-response.json
View File

@ -1,44 +0,0 @@
{
"_shards": {
"failed": 0,
"successful": 2,
"total": 2
},
"hits": {
"hits": [
{
"_id": "76580e9d-f83d-49d8-b428-1fb90c5d8e95",
"_index": "searchlight",
"_type": "OS::Glance::Image",
"_score": 1.0,
"_source": {
"id": "76580e9d-f83d-49d8-b428-1fb90c5d8e95",
"members": [],
"name": "cirros-0.3.2-x86_64-uec",
"owner": "d95b27da6e9f4acc9a8031918e443e04",
"visibility": "public",
"...": "..."
}
},
{
"_id": "a701f610-b162-45ac-a5a0-69e08aba8687",
"_index": "searchlight",
"_type": "OS::Glance::Image",
"_score": 1.0,
"_source": {
"id": "a701f610-b162-45ac-a5a0-69e08aba8687",
"members": [],
"name": "Docker container image",
"owner": "d95b27da6e9f4acc9a8031918e443e04",
"visibility": "public",
"...": "..."
}
},
{ "...": "..." }
],
"max_score": 1.0,
"total": 8
},
"timed_out": false,
"took": 1
}

78
api-ref/source/samples/list-facets-all-response-exclude-options.json
View File

@ -1,78 +0,0 @@
{
"OS::Glance::Image": {
"doc_count": 50,
"facets": [
{
"name": "status",
"type": "string"
},
{
"name": "created_at",
"type": "date"
},
{
"name": "virtual_size",
"type": "long"
},
{
"name": "name",
"type": "string",
"facet_field": "name.raw"
},
{ "...": "..." }
]
},
"OS::Glance::Metadef": {
"doc_count": 25,
"facets": [
{
"name": "objects.description",
"type": "string"
},
{
"name": "objects.properties.description",
"type": "string"
},
{ "...": "..." }
]
},
"OS::Nova::Server": {
"doc_count": 100,
"facets": [
{
"name": "status",
"options": [
{
"doc_count": 1,
"key": "ACTIVE"
}
],
"type": "string"
},
{
"name": "OS-EXT-SRV-ATTR:host",
"type": "string"
},
{
"name": "name",
"type": "string",
"facet_field": "name.raw"
},
{
"name": "image.id",
"type": "string"
},
{
"name": "OS-EXT-AZ:availability_zone",
"options": [
{
"doc_count": 1,
"key": "nova"
}
],
"type": "string"
},
{ "...": "..." }
]
}
}

90
api-ref/source/samples/list-facets-all-response.json
View File

@ -1,90 +0,0 @@
{
"OS::Glance::Image": {
"doc_count": 50,
"facets": [
{
"name": "status",
"type": "string",
"options": [
{
"key": "queued",
"doc_count": 47
},
{
"key": "active",
"doc_count": 3
}
]
},
{
"name": "created_at",
"type": "date"
},
{
"name": "virtual_size",
"type": "long"
},
{
"name": "name",
"type": "string",
"facet_field": "name.raw"
},
{ "...": "..." }
]
},
"OS::Glance::Metadef": {
"doc_count": 25,
"facets": [
{
"name": "objects.description",
"nested": true,
"type": "string"
},
{
"name": "objects.properties.description",
"nested": true,
"type": "string"
},
{ "...": "..." }
]
},
"OS::Nova::Server": {
"doc_count": 100,
"facets": [
{
"name": "status",
"options": [
{
"doc_count": 1,
"key": "ACTIVE"
}
],
"type": "string"
},
{
"name": "OS-EXT-SRV-ATTR:host",
"type": "string"
},
{
"name": "name",
"type": "string",
"facet_field": "name.raw"
},
{
"name": "image.id",
"type": "string"
},
{
"name": "OS-EXT-AZ:availability_zone",
"options": [
{
"doc_count": 1,
"key": "nova"
}
],
"type": "string"
},
{ "...": "..." }
]
}
}

11
api-ref/source/samples/list-facets-include-fields-response.json
View File

@ -1,11 +0,0 @@
{
"OS::Nova::Server": {
"doc_count": 7
},
"OS::Neutron::Net": {
"doc_count": 19
},
"OS::Glance::Image": {
"doc_count": 68
}
}

27
api-ref/source/samples/list-facets-type-response.json
View File

@ -1,27 +0,0 @@
{
"OS::Nova::Server": {
"doc_count": 100,
"facets": [
{
"name": "status",
"options": [
{
"doc_count": 1,
"key": "ACTIVE"
}
],
"type": "string"
},
{
"name": "OS-EXT-SRV-ATTR:host",
"type": "string"
},
{
"name": "name",
"type": "string",
"facet_field": "name.raw"
},
{ "...": "..." }
]
}
}

14
api-ref/source/samples/list-plugins-response.json
View File

@ -1,14 +0,0 @@
{
"plugins": [
{
"type": "OS::Glance::Image",
"alias-indexing": "searchlight-listener",
"alias-searching": "searchlight-search"
},
{
"type": "OS::Glance::Metadef",
"alias-indexing": "searchlight-listener",
"alias-searching": "searchlight-search"
}
]
}

170
api-ref/source/search-parameters.yaml
View File

@ -1,170 +0,0 @@
# template for entries
#name:
# description: |
# yada yada yada
# in: {header, path, query, body}
# required: {true, false}
# type: {JSON datatype: number, string, boolean, array, object, null}
#
# Note: entries must be in alphabetical order within each section
# variables in header
Content-type-json:
description: |
Mime type of the request body. Must be ``application/json``.
in: header
required: true
type: string
# variables in path
# variables in query
include-in-query:
description: |
Disable showing the facet fields. Display count only.
The default value is ``true``.
in: query
required: false
type: boolean
options-in-query:
description: |
Disable aggregating facet fields. Provides a performance
improvement. The default value is ``false``.
in: query
required: false
type: boolean
type-in-query:
description: |
The resource type whose facets you'd like to see listed.
in: query
required: false
type: string
# variables in body
all-projects:
description: |
Indicates that an administator wants to include all resources for
all projects in the search. The default is ``false``.
in: body
required: false
type: boolean
es-aggregate-obj:
description: |
A JSON object containing the aggregation results. It contains the following
fields:
- ``buckets`` - An array of aggregated results (defaults to the top ten
terms). There is a bucket for each term. Each element of the array
contains the following fields:
- ``doc_count`` - Number of times this term appears.
- ``key`` - The value of this term.
- ``doc_count_error_upper_bound`` - The upper bound on the error when
compiling the document count, needed since the count is approximate.
- ``sum_other_doc_count`` - Since the number of elements in the bucket
array may be capped (default is ten), the number of all other document
counts not included in buckets.
in: body
required: true
type: object
es-hits-obj:
description: |
A JSON object containing the search results. It contains the following
fields:
- ``hits`` - An array of search results (defaults to the first 25
documents). Each element of the array contains the following fields:
- ``_id`` - Uniquely identifies the resource within its OpenStack context
(for instance, Glance images use their Image ID)
- ``_index`` - The service to which the resource belongs (for example,
searchlight)
- ``_score`` - The relevance of a given hit. By default, this is the
field upon which results are sorted
- ``_source`` - The document originally indexed, containing all data
associated with the OpenStack resource. This field is a map,
where each key is a field whose value may be a scalar value, a list,
a nested object, or a list of nested objects.
- ``_type`` - The OpenStack resource type of the document (for example,
"OS::Neutron::Net", "OS::Glance::Image")
- ``_parent`` - *(optional)* When the resource type has a child
relationship to another resource type, the id of the specific parent
resource will appear here.
- ``_routing`` - *(optional)* Included when an Elasticsearch routing
for the document is explicitly specified.
- ``max_score`` - The highest ``_score`` of any document that matches the
query
- ``total`` - The total number of documents matching the search criteria
in: body
required: true
type: object
es-query:
description: |
A JSON object containing the requested query, expressed in the
`Elasticsearch Query DSL <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html>`_.
in: body
required: true
type: object
es-shards-obj:
description: |
A JSON object containing the following fields:
- ``failed`` - Number of shards in which the search could not be performed
- ``successful`` - Number of shards in which the search was successful
- ``total`` - The total number of shards involved in processing the query
in: body
required: true
type: object
es-timed-out-field:
description: |
Indicates whether the search timed out or not.
in: body
required: true
type: boolean
es-took-field:
description: |
The time in milliseconds it took for Elasticsearch to execute the search.
in: body
required: true
type: number
facet-list:
description: |
A JSON object pairing resource type names with a list of facets
supported for that resource type. Each facet object in the list
contains the following fields:
- name - the name of the facet
- type - the datatype of the facet
- facet_field - (optional, may be available for some string fields)
may be used to do an exact term match
in: body
required: true
type: object
multi_match-in-body:
description: |
A JSON object containing a ``query`` field whose value is an Elasticsearch
query string.
in: body
required: true
type: string or array of strings
plugin-list:
description: |
List of plugins. Each element of the list contains the following fields:
- ``alias-indexing`` - the alias this plugin uses to refer to the
Elasticsearch index in which documents are created
- ``alias-searching`` - the alias this plugin uses to refer to the
Elasticsearch index used for querying documents created by this plugin
- ``type`` - the document type associated with this plugin
in: body
required: true
type: array
type-in-body:
description: |
The name of the resource type or types to which the search should be
restricted.
in: body
required: true
type: string or array of strings

699
api-ref/source/searchlight-v1.inc
View File

@ -1,699 +0,0 @@
.. -*- rst -*-
Search
******
Provides indexing and search capabilities across OpenStack resources.
General information
~~~~~~~~~~~~~~~~~~~
The OpenStack Searchlight project provides a Search API that presents an
interface for querying about the various resources available in an OpenStack
cloud. Searchlight creates an index (using open source Elasticsearch
technology) and keeps it updated. Additionally, Searchlight's Search API
requires authentication and respects the Role Based Access Control defined by
each OpenStack service. This gives end users access to the powerful searching
facilities provided by Elasticsearch, but operators can rest assured that end
users won't have access to information they wouldn't be able to find in the
APIs exposed by each of the OpenStack services.