Fixed typo error OS_IMAGE_URL
OS_IMAGE_URL is not coorect, replaced it with HEAT_URL and did according changes. Change-Id: I0c06dfe6c013a358a46eab2ce4e9b7a44d98672d
This commit is contained in:
parent
84ac309a7a
commit
39ca592c55
|
@ -7,13 +7,21 @@ This is a client for OpenStack Heat API. There's a Python API
|
|||
|
||||
Python API
|
||||
==========
|
||||
In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so::
|
||||
|
||||
>>> from heatclient import Client
|
||||
>>> heat = Client('1', endpoint=OS_IMAGE_ENDPOINT, token=OS_AUTH_TOKEN)
|
||||
In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to::
|
||||
|
||||
>>> tenant_id = 'b363706f891f48019483f8bd6503c54b'
|
||||
>>> heat_url = 'http://heat.example.org:8004/v1/%s' % tenant_id
|
||||
>>> auth_token = '3bcc3d3a03f44e3d8377f9247b0ad155'
|
||||
|
||||
Once you have done so, you can use the API like so::
|
||||
|
||||
>>> from heatclient.client import Client
|
||||
>>> heat = Client('1', endpoint=heat_url, token=auth_token)
|
||||
|
||||
Command-line Tool
|
||||
=================
|
||||
|
||||
In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables::
|
||||
|
||||
export OS_USERNAME=user
|
||||
|
@ -21,9 +29,9 @@ In order to use the CLI, you must provide your OpenStack username, password, ten
|
|||
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
|
||||
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
|
||||
|
||||
The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using ``--os-image-url`` and ``--os-auth-token``. You can alternatively set these environment variables::
|
||||
The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using ``--heat-url`` and ``--os-auth-token``. You can alternatively set these environment variables::
|
||||
|
||||
export OS_IMAGE_URL=http://heat.example.org:8004/
|
||||
export HEAT_URL=http://heat.example.org:8004/v1/b363706f891f48019483f8bd6503c54b
|
||||
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
|
||||
|
||||
Once you've configured your authentication parameters, you can run ``heat help`` to see a complete listing of available commands.
|
||||
|
|
Loading…
Reference in New Issue