openstack/python-novaclient
Code Issues Proposed changes

Merge "Cleanup various inaccuracies in the README.rst"

Browse Source
This commit is contained in:
Jenkins 2015-06-09 21:36:11 +00:00 committed by Gerrit Code Review
commit 0c724c9975
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.rst
View File

@ -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 and the version of the API with ``--os-compute-api-version``. Or set them as
an environment variables as well:: 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 export OS_COMPUTE_API_VERSION=2
If you are using Keystone, you need to set the OS_AUTH_URL to the keystone 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 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 import client
>>> from novaclient.v2 import client >>> nt = client.Client(VERSION, USER, PASSWORD, TENANT, AUTH_URL)
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute")
>>> nt.flavors.list() >>> nt.flavors.list()
[...] [...]
>>> nt.servers.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 * tox -e functional - live functional testing against an existing
openstack 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) 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 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 devstack installation with a demo and an admin user/tenant - or clouds named