RETIRED, OpenStack Search (Searchlight) Client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenStack Release Bot 75bb786669 Add Python3 wallaby unit tests 2 years ago
doc Switch to newer openstackdocstheme and reno versions 2 years ago
releasenotes/notes [ussuri][goal] Drop python 2.7 support and testing 2 years ago
searchlightclient Remove six 2 years ago
tools Stop to use the __future__ module. 2 years ago
.gitignore Switch to stestr 4 years ago
.gitreview OpenDev Migration Patch 3 years ago
.stestr.conf Switch to stestr 4 years ago
.zuul.yaml Add Python3 wallaby unit tests 2 years ago
CONTRIBUTING.rst Update storyboard links 3 years ago
LICENSE Init searchlightclient base 7 years ago
README.rst [ussuri][goal] Drop python 2.7 support and testing 2 years ago
lower-constraints.txt [goal] Migrate testing to ubuntu focal 2 years ago
requirements.txt [goal] Migrate testing to ubuntu focal 2 years ago
setup.cfg Remove translation sections from setup.cfg 2 years ago
setup.py Cleanup py27 support 2 years ago
test-requirements.txt Fix hacking min version to 3.0.1 2 years ago
tox.ini Remove pypy job 2 years ago

README.rst

Team and repository tags

image

python-searchlightclient

OpenStack Indexing and Search API Client Library

This is a client library for Searchlight built on the Searchlight API. It provides a Python API (the searchlightclient module) and a command-line tool (searchlight).

The project is hosted on Storyboard, where bugs can be filed. The code is hosted on OpenStack git repository. Patches must be submitted using Gerrit, not git repo pull requests.

python-searchlightclient is licensed under the Apache License like the rest of OpenStack.

Contents:

Install the client from PyPI

The program python-searchlightclient package is published on PyPI and so can be installed using the pip tool, which will manage installing all python dependencies:

$ pip install python-searchlightclient

Note

The packages on PyPI may lag behind the git repo in functionality.

Setup the client from source

  • Clone repository for python-searchlightclient:

    $ git clone https://opendev.org/openstack/python-searchlightclient.git
    $ cd python-searchlightclient
  • Setup a virtualenv

Note

This is an optional step, but will allow Searchlightclient's dependencies to be installed in a contained environment that can be easily deleted if you choose to start over or uninstall Searchlightclient.

$ tox -evenv --notest

Activate the virtual environment whenever you want to work in it. All further commands in this section should be run with the venv active:

$ source .tox/venv/bin/activate

Note

When ALL steps are complete, deactivate the virtualenv: $ deactivate

  • Install Searchlightclient and its dependencies:

    (venv) $ python setup.py develop

Command-line API

Set Keystone environment variables to execute CLI commands against searchlight.

  • To execute CLI commands:

    $ export OS_USERNAME=<user>
    $ export OS_PASSWORD=<password>
    $ export OS_TENANT_NAME=<project>
    $ export OS_AUTH_URL='http://localhost:5000/v2.0/'

Note

With devstack you just need to $ source openrc <user> <project>. And you can work with a local installation by passing --os-token <TOKEN> and --os-url http://localhost:9393. You can also set up a Openstackclient config file to work with the CLI.

$ openstack
(openstack) search resource type list
+--------------------------+--------------------------+
| Name                     | Type                     |
+--------------------------+--------------------------+
| OS::Designate::RecordSet | OS::Designate::RecordSet |
| OS::Designate::Zone      | OS::Designate::Zone      |
| OS::Glance::Image        | OS::Glance::Image        |
| OS::Glance::Metadef      | OS::Glance::Metadef      |
| OS::Nova::Server         | OS::Nova::Server         |
+--------------------------+--------------------------+

Here are the full list of subcommands, Use -h to see options:

Subcommand Description
search facet list List Searchlight Facet
search resource type list List Searchlight Resource Type (Plugin)
search query Search Searchlight resource

Python API

To use with keystone as the authentication system:

>>> from keystoneclient.auth.identity import generic
>>> from keystoneclient import session
>>> from searchlightclient import client
>>> auth = generic.Password(auth_url=OS_AUTH_URL, username=OS_USERNAME, password=OS_PASSWORD, tenant_name=OS_TENANT_NAME)
>>> keystone_session = session.Session(auth=auth)
>>> sc = client.Client('1', session=keystone_session)
>>> sc.resource_types.list()
[...]

Testing

There are multiple test targets that can be run to validate the code.

  • tox -e pep8 - style guidelines enforcement
  • tox -e py36 - traditional unit testing with python 3.6
  • tox -e py37 - traditional unit testing with python 3.7