diff options
| author | melanie witt <melwitt@yahoo-inc.com> | 2015-06-09 06:31:54 +0000 |
|---|---|---|
| committer | melanie witt <melwitt@yahoo-inc.com> | 2015-06-09 06:40:45 +0000 |
| commit | efe988d29ab13e645277e69d26779777f952de15 (patch) | |
| tree | d908031a83f89f93bd18500d60a080b33afca2c7 /README.rst | |
| parent | 773eea811df7be3dcb73dc2ae16354b172f442c6 (diff) | |
| download | python-novaclient-efe988d29ab13e645277e69d26779777f952de15.tar.gz | |
Cleanup various inaccuracies in the README.rst
There was a mention of v1.1, a version-specific import, omission of
the required version argument creating a Client object, an irrelevant
comment, use of service_type implying the ability to use novaclient
with services other than nova (we have deprecated use of the volume
endpoint, for example), and a misspelling.
Change-Id: I91b2aa4001295e152883134326f40f887a55cc50
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 13 |
1 files changed, 6 insertions, 7 deletions
@@ -45,7 +45,7 @@ You will also need to define the authentication url with ``--os-auth-url`` and the version of the API with ``--os-compute-api-version``. Or set them as an environment variables as well:: - export OS_AUTH_URL=http://example.com:8774/v1.1/ + export OS_AUTH_URL=http://example.com:8774/v2/ export OS_COMPUTE_API_VERSION=2 If you are using Keystone, you need to set the OS_AUTH_URL to the keystone @@ -63,14 +63,13 @@ You'll find complete documentation on the shell by running Python API ---------- -There's also a complete Python API, but it has not yet been documented. +There's also a complete Python API, with documentation linked below. -To use with nova, with keystone as the authentication system:: +To use with keystone as the authentication system:: - # use v2.0 auth with http://example.com:5000/v2.0/") - >>> from novaclient.v2 import client - >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute") + >>> from novaclient import client + >>> nt = client.Client(VERSION, USER, PASSWORD, TENANT, AUTH_URL) >>> nt.flavors.list() [...] >>> nt.servers.list() @@ -94,7 +93,7 @@ There are multiple test targets that can be run to validate the code. * tox -e functional - live functional testing against an existing openstack -Functional testing assumes the existance of a `clouds.yaml` file as supported +Functional testing assumes the existence of a `clouds.yaml` file as supported by `os-client-config` (http://docs.openstack.org/developer/os-client-config) It assumes the existence of a cloud named `devstack` that behaves like a normal devstack installation with a demo and an admin user/tenant - or clouds named |