diff --git a/README.rst b/README.rst index b2eb2689..59f1ebf6 100644 --- a/README.rst +++ b/README.rst @@ -1,40 +1,8 @@ -Python bindings to the OpenStack Image API +Python bindings to the OpenStack Images API ============================================= -This is a client library for Glance built on the OpenStack Images API. It provides a Python API (the ``glanceclient`` module) and a command-line tool (``glance``). This library fully supports the the v1 Images API, with support for the v2 API in progress. +This is a client library for Glance built on the OpenStack Images API. It provides a Python API (the ``glanceclient`` module) and a command-line tool (``glance``). This library fully supports the v1 Images API, while support for the v2 API is in progress. Development takes place via the usual OpenStack processes as outlined in the `OpenStack wiki `_. The master repository is on `GitHub `_. -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' - >>> with open('/tmp/copyimage.iso', 'wb') as f: - for chunk in image.data: - f.write(chunk) - >>> image.delete() - - -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 release notes and more at ``_. diff --git a/doc/source/index.rst b/doc/source/index.rst index b06aa4e9..c7eee04c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,17 +1,60 @@ -Python bindings to the OpenStack Images 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:: -This is a client for OpenStack Images API. Contents: + >>> 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' + >>> with open('/tmp/copyimage.iso', 'wb') as f: + for chunk in image.data: + f.write(chunk) + >>> image.delete() -.. toctree:: - :maxdepth: 1 - api/autoindex +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:: -Indices and tables -================== + export OS_USERNAME=user + export OS_PASSWORD=pass + export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b + export OS_AUTH_URL=http://auth.example.com:5000/v2.0 -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +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. + + +Release Notes +============= + +0.4.2 +----- +* 1037233_: Fix v1 image list where limit kwarg is less than page_size + +.. _1037233: https://bugs.launchpad.net/python-glanceclient/+bug/1037233 + +0.4.1 +----- +* Default to system CA cert if one is not provided while using SSL +* 1036315_: Allow 'deleted' to be provided in v1 API image update +* 1036299_: Fix case where boolean values were treated as strings in v1 API +* 1036297_: Fix case where int values were treated as strings in v1 API + +.. _1036315: https://bugs.launchpad.net/python-glanceclient/+bug/1036315 +.. _1036299: https://bugs.launchpad.net/python-glanceclient/+bug/1036299 +.. _1036297: https://bugs.launchpad.net/python-glanceclient/+bug/1036297 + +0.4.0 +----- +* Send client SSL certificate to server for self-identification +* Properly validate server SSL certificates +* Images API v2 image data download