diff options
| -rw-r--r-- | README.rst | 15 | ||||
| -rw-r--r-- | doc/source/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/releases.rst | 2 | ||||
| -rw-r--r-- | doc/source/shell.rst | 8 | ||||
| -rw-r--r-- | doc/source/using-api.rst | 9 | ||||
| -rw-r--r-- | keystoneclient/client.py | 2 | ||||
| -rw-r--r-- | keystoneclient/v2_0/client.py | 2 | ||||
| -rw-r--r-- | setup.py | 2 |
8 files changed, 25 insertions, 25 deletions
@@ -1,10 +1,9 @@ -Python bindings to the OpenStack Keystone API -============================================= +Python bindings to the OpenStack Identity API (Keystone) +======================================================== -This is a client for the OpenStack Keystone API. There's a Python API (the -``keystoneclient`` module), and a command-line script (``keystone``). The -Keystone 2.0 API is still a moving target, so this module will remain in -"Beta" status until the API is finalized and fully implemented. +This is a client for the OpenStack Identity API, implemented by Keystone. +There's a Python API (the ``keystoneclient`` module), and a command-line script +(``keystone``). Development takes place via the usual OpenStack processes as outlined in the `OpenStack wiki`_. The master repository is on GitHub__. @@ -27,7 +26,7 @@ Python API By way of a quick-start:: - # use v2.0 auth with http://example.com:5000/v2.0") + # use v2.0 auth with http://example.com:5000/v2.0 >>> from keystoneclient.v2_0 import client >>> keystone = client.Client(username=USERNAME, password=PASSWORD, tenant_name=TENANT, auth_url=AUTH_URL) >>> keystone.tenants.list() @@ -39,7 +38,7 @@ Command-line API ---------------- Installing this package gets you a shell command, ``keystone``, that you -can use to interact with Keystone's Identity API. +can use to interact with OpenStack's Identity API. You'll need to provide your OpenStack tenant, username and password. You can do this with the ``--os-tenant-name``, ``--os-username`` and ``--os-password`` diff --git a/doc/source/index.rst b/doc/source/index.rst index 51bc647..faffc4f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,7 +1,7 @@ -Python bindings to the OpenStack Keystone API -================================================== +Python bindings to the OpenStack Identity API (Keystone) +======================================================== -This is a client for OpenStack Keystone API. There's :doc:`a Python API +This is a client for OpenStack Identity API. There's :doc:`a Python API <using-api>` (the :mod:`keystoneclient` module), and a :doc:`command-line script <shell>` (installed as :program:`keystone`). @@ -20,8 +20,8 @@ Contributing ============ Code is hosted `on GitHub`_. Submit bugs to the Keystone project on -`Launchpad`_. Submit code to the openstack/python-keystoneclient project using -`Gerrit`_. +`Launchpad`_. Submit code to the ``openstack/python-keystoneclient`` project +using `Gerrit`_. .. _on GitHub: https://github.com/openstack/python-keystoneclient .. _Launchpad: https://launchpad.net/python-keystoneclient diff --git a/doc/source/releases.rst b/doc/source/releases.rst index 2f1ed42..bb3f1a0 100644 --- a/doc/source/releases.rst +++ b/doc/source/releases.rst @@ -25,7 +25,7 @@ Release notes ====================== * released with OpenStack Essex and Diablo compatibility * forked from http://github.com/rackspace/python-novaclient -* refactored to support Keystone API (auth, tokens, services, roles, tenants, +* refactored to support Identity API (auth, tokens, services, roles, tenants, users, etc.) * removed legacy arguments of --username, --password, etc in migration to support a cross-openstack unified CLI convention defined at diff --git a/doc/source/shell.rst b/doc/source/shell.rst index e4baf4b..02d158c 100644 --- a/doc/source/shell.rst +++ b/doc/source/shell.rst @@ -5,14 +5,14 @@ The :program:`keystone` shell utility .. highlight:: bash -The :program:`keystone` shell utility interacts with OpenStack Keystone API -from the command line. It supports the entirety of the OpenStack Keystone API. +The :program:`keystone` shell utility interacts with OpenStack Identity API +from the command line. It supports the entirety of the OpenStack Identity API. To communicate with the API, you will need to be authenticated - and the :program:`keystone` provides multiple options for this. While bootstrapping keystone the authentication is accomplished with a -shared secret token and the location of the keystone API endpoint. The +shared secret token and the location of the Identity API endpoint. The shared secret token is configured in keystone.conf as "admin_token". You can specify those values on the command line with :option:`--os-token` @@ -24,7 +24,7 @@ and :option:`--os-endpoint`, or set them in environment variables: .. envvar:: OS_SERVICE_ENDPOINT - Your keystone API endpoint + Your Identity API endpoint The command line options will override any environment variables set. diff --git a/doc/source/using-api.rst b/doc/source/using-api.rst index 809093e..b5d630c 100644 --- a/doc/source/using-api.rst +++ b/doc/source/using-api.rst @@ -4,7 +4,8 @@ The client API Introduction ============ -The main concepts in the Keystone API are: + +The main concepts in the Identity API are: * tenants * users @@ -12,11 +13,11 @@ The main concepts in the Keystone API are: * services * endpoints -The Keystone API lets you query and make changes through managers. For example, +The Identity API lets you query and make changes through managers. For example, to manipulate tenants, you interact with a -``keystoneclient.v2_0.tenants.TenantManger`` object. +``keystoneclient.v2_0.tenants.TenantManager`` object. -You obtain access to managers through via atributes of the +You obtain access to managers through via attributes of the ``keystoneclient.v2_0.client.Client`` object. For example, the ``tenants`` attribute of the ``Client`` class is a tenant manager:: diff --git a/keystoneclient/client.py b/keystoneclient/client.py index c61f891..5870eae 100644 --- a/keystoneclient/client.py +++ b/keystoneclient/client.py @@ -70,7 +70,7 @@ class HTTPClient(httplib2.Http): _logger.addHandler(ch) def authenticate(self): - """ Authenticate against the keystone API. + """ Authenticate against the Identity API. Not implemented here because auth protocols should be API version-specific. diff --git a/keystoneclient/v2_0/client.py b/keystoneclient/v2_0/client.py index 02fd59b..14aa373 100644 --- a/keystoneclient/v2_0/client.py +++ b/keystoneclient/v2_0/client.py @@ -88,7 +88,7 @@ class Client(client.HTTPClient): return hasattr(self, 'service_catalog') def authenticate(self): - """ Authenticate against the Keystone API. + """ Authenticate against the Identity API. Uses the data provided at instantiation to authenticate against the Keystone server. This may use either a username and password @@ -15,7 +15,7 @@ tests_require = setup.parse_requirements(['tools/test-requires']) setuptools.setup( name="python-keystoneclient", version=setup.get_post_version('keystoneclient'), - description="Client library for OpenStack Keystone API", + description="Client library for OpenStack Identity API (Keystone)", long_description=read('README.rst'), url='https://github.com/openstack/python-keystoneclient', license='Apache', |