c9100ed742
Change-Id: I00797d38d6ad9b1a7b198767a0cbbb2f619c3b43 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
62 lines
2.3 KiB
ReStructuredText
62 lines
2.3 KiB
ReStructuredText
Python Bindings for the OpenStack Images API
|
|
============================================
|
|
|
|
This is a client for the OpenStack Images API. There's :doc:`a Python API <ref/index>` (the :mod:`glanceclient` module) and a :doc:`command-line script<man/glance>` (installed as :program:`glance`).
|
|
|
|
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 glanceclient import Client
|
|
>>> glance = Client('1', endpoint=OS_IMAGE_ENDPOINT, token=OS_AUTH_TOKEN)
|
|
>>> image = glance.images.create(name="My Test Image")
|
|
>>> print image.status
|
|
'queued'
|
|
>>> image.update(data=open('/tmp/myimage.iso', 'rb'))
|
|
>>> print image.status
|
|
'active'
|
|
>>> image.update(properties=dict(my_custom_property='value'))
|
|
>>> with open('/tmp/copyimage.iso', 'wb') as f:
|
|
for chunk in image.data():
|
|
f.write(chunk)
|
|
>>> image.delete()
|
|
|
|
Python API Reference
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
ref/index
|
|
ref/v1/index
|
|
ref/v2/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
How to use the v2 API <apiv2>
|
|
|
|
Command-line Tool Reference
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
man/glance
|
|
|
|
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
|
|
export OS_PASSWORD=pass
|
|
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::
|
|
|
|
export OS_IMAGE_URL=http://glance.example.org:9292/
|
|
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
|
|
|
|
Once you've configured your authentication parameters, you can run ``glance help`` to see a complete listing of available commands.
|
|
|
|
See also :doc:`/man/glance`.
|