summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-03-08 15:58:17 +0000
committerGerrit Code Review <review@openstack.org>2016-03-08 15:58:17 +0000
commit72c67e4d421a4d334454a4356c02258b6f1c5366 (patch)
tree9eb9b2a4590f7fe5855daa3bac7c8013d7b93d02
parent9a9b32c53f20b902b2d88864c368b67c8694f504 (diff)
parent538a396652161141da942ef622656ea7a01d2794 (diff)
Merge "Update README"0.2.1
-rw-r--r--README.rst41
1 files changed, 36 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index df9ec79..9ef99fd 100644
--- a/README.rst
+++ b/README.rst
@@ -22,10 +22,21 @@ OpenStack.
22.. contents:: Contents: 22.. contents:: Contents:
23 :local: 23 :local:
24 24
25Command-line API 25Install the client from PyPI
26---------------- 26----------------------------
27The :program:`python-searchlightclient` package is published on `PyPI`_ and
28so can be installed using the pip tool, which will manage installing all
29python dependencies::
27 30
28To execute CLI commands to standalone searchlight set with keystone. 31 $ pip install python-searchlightclient
32
33.. note::
34 The packages on PyPI may lag behind the git repo in functionality.
35
36.. _PyPI: https://pypi.python.org/pypi/python-searchlightclient/
37
38Setup the client from source
39----------------------------
29 40
30* Clone repository for python-searchlightclient:: 41* Clone repository for python-searchlightclient::
31 42
@@ -57,6 +68,11 @@ All further commands in this section should be run with the venv active:
57 68
58 (venv) $ python setup.py develop 69 (venv) $ python setup.py develop
59 70
71Command-line API
72----------------
73
74Set Keystone environment variables to execute CLI commands against searchlight.
75
60* To execute CLI commands:: 76* To execute CLI commands::
61 77
62 $ export OS_USERNAME=<user> 78 $ export OS_USERNAME=<user>
@@ -65,12 +81,17 @@ All further commands in this section should be run with the venv active:
65 $ export OS_AUTH_URL='http://localhost:5000/v2.0/' 81 $ export OS_AUTH_URL='http://localhost:5000/v2.0/'
66 82
67.. note:: 83.. note::
68 With devstack you just need to $ source openrc <user> <project> 84 With devstack you just need to $ source openrc <user> <project>. And you can
85 work with a local installation by passing --os-token <TOKEN> and --os-url
86 http://localhost:9393. You can also set up a `Openstackclient`_ config file
87 to work with the CLI.
88
89.. _Openstackclient: http://docs.openstack.org/developer/python-openstackclient/configuration.html#clouds-yaml
69 90
70:: 91::
71 92
72 $ openstack 93 $ openstack
73 (openstack) search resource-type list 94 (openstack) search resource type list
74 +--------------------------+--------------------------+ 95 +--------------------------+--------------------------+
75 | Name | Type | 96 | Name | Type |
76 +--------------------------+--------------------------+ 97 +--------------------------+--------------------------+
@@ -81,6 +102,16 @@ All further commands in this section should be run with the venv active:
81 | OS::Nova::Server | OS::Nova::Server | 102 | OS::Nova::Server | OS::Nova::Server |
82 +--------------------------+--------------------------+ 103 +--------------------------+--------------------------+
83 104
105Here are the full list of subcommands, Use -h to see options:
106
107 ============================= =======================================
108 Subcommand Description
109 ============================= =======================================
110 search facet list List Searchlight Facet
111 search resource type list List Searchlight Resource Type (Plugin)
112 search query Search Searchlight resource
113 ============================= =======================================
114
84Python API 115Python API
85---------- 116----------
86 117