openstack/python-glanceclient
Code Issues Proposed changes
Files
f7cdc3eefe1d34bca2efb08d21c401cc9d9a457d
python-glanceclient/doc/source/index.rst
Louis Taylor 49f38a4242 Add release notes for 0.14.0 - 0.14.2 
These were not written at the time of release, so this catches up with
the latest version.

For reference:

    $ git log --oneline --no-merges 0.13.0..0.14.0
    33dcea8 Support for Metadata Definitions Catalog API
    16077d9 Catch new urllib3 exception: ProtocolError
    6dda6f3 Fix error when logging http response with python 3
    d6498b6 Ensure server's SSL cert is validated
    9a53c1f Enable osprofiler interface in glanceclient shell
    69361a1 Hide stderr noise in test output
    1dfce53 Remove deprecated commands from shell
    867e4ca Normalize glanceclient requested service url
    4494853 Fix glance-client to work with IPv6 controllers
    f15dc6b Add support for Keystone v3
    7736349 Update theme for docs
    e79031b Add a tox job for generating docs
    68c1d1f Don't stream non-binary requests
    f75a810 Use a correctly formatted example location in help
    dbb242b Replace old httpclient with requests
    1db17aa Enable F841
    797d101 Resolving the performance issue for image listing of v2 API
    e305dad Add profiling support to glanceclinet
    9b9f3be Use immutable arg rather mutable arg
    1c46c76 Add CONTRIBUTING.rst

    $ git log --oneline --no-merges 0.14.0..0.14.1                                                                                                                                                                                                                                                                                                                                                                                      f980fc5 Update how tokens are redacted
    ba19a53 Handle UnicodeDecodeError in log_http_response
    4d6b94a Print traceback to stderr if --debug is set
    61e4eba Updated from global requirements
    97b1506 Fix v2 requests to non-bleeding edge servers
    9fbc313 Work toward Python 3.4 support and testing
    d97f03e Import missing gettextutils._ in shell.py
    4631b76 Fix indentation in tox.ini
    cda8c4d Downgrade log message for http request failures
    8770586 CLI image-update gives a wrong help on '--tags' param

    $ git log --oneline --no-merges 0.14.1..0.14.2
    052904b Don't replace the https handler in the poolmanager
    5f4966d Remove network_utils
    2b567cf Skip non-base properties in patch method
    7ef1b7c Adds support for Glance Tasks calls
    1511c86 Fix the ordering of assertEqual arguments
    ab07caf Stop using intersphinx
    929a72e Default to system CA bundle if no CA certificate is provided

Change-Id: Ie4195fa9ad7f5f45c387fda4b1db4fbce7a3f98c
2014-11-25 15:53:29 +00:00

10 KiB
Raw Blame History

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 also /man/glance.

Release Notes

0.14.2

  • Add support for Glance Tasks calls (task create, list all and show)
  • 1362179: Default to system CA bundle if no CA certificate is provided
  • 1350251, 1347150, 1362766: Don't replace the https handler in the poolmanager
  • 1371559: Skip non-base properties in patch method

0.14.1

  • Print traceback to stderr if --debug is set
  • Downgrade log message for http request failures
  • Fix CLI image-update giving the wrong help on '--tags' parameter
  • 1367326: Fix requests to non-bleeding edge servers using the v2 API
  • 1329301: Update how tokens are redacted
  • 1369756: Fix decoding errors when logging response headers

0.14.0

  • Add support for metadata definitions catalog API
  • Enable osprofiler profiling support to glanceclient and its shell. This adds the --profile <HMAC_KEY> argument.
  • Add support for Keystone v3
  • Replace old httpclient with requests
  • Fix performance issue for image listing of v2 API
  • 1364893: Catch a new urllib3 exception: ProtocolError
  • 1359880: Fix error when logging http response with python 3
  • 1357430: Ensure server's SSL cert is validated to help guard against man-in-the-middle attack
  • 1314218: Remove deprecated commands from shell
  • 1348030: Fix glance-client on IPv6 controllers
  • 1341777: Don't stream non-binary requests

0.13.0

  • Add command line support for image multi-locations
  • Py3K support completed
  • Fixed several issues related to UX
  • Progress bar support for V2

0.12.0

  • Add command line support for V2 image create, update, and upload
  • Enable querying for images by tag
  • 1230032, 1231524: Fix several issues with handling redirects
  • 1206095: Use openstack-images-v2.1-json-patch for update method

0.11.0

  • 1212463: Allow single-wildcard SSL common name matching
  • 1208618: Support absolute redirects for endpoint urls
  • 1190606: Properly handle integer-like image ids
  • Support removing properties from images in the v2 library

0.10.0

  • 1192229: Security Update! Fix SSL certificate CNAME checking to handle ip addresses correctly
  • Add an optional progress bar for image downloads
  • Additional v2 api functionality, including image creation and uploads
  • Allow v1 admin clients to list all users' images, and to list the images of specific tenants.
  • Add a --checksum option to the v2 CLI for selecting images by checksum
  • Added support for image creation and uploads to the v2 library
  • Added support for updating and deleting v2 image tags to the v2 library and CLI
  • Added support for managing image memberships to the v2 library and CLI
  • Added a cli man page.
  • 1184566: Fix support for unix pipes when uploading images in the v1 CLI
  • 1157864: Fix an issue where glanceclient would fail with eventlet.

0.9.0

  • Implement 'visibility', 'owner' and 'member_status' filters for v2 CLI and library
  • Relax prettytable dependency to v0.7.X
  • 1118799: Implement filter on 'is_public' attribute in v1 API
  • 1157905, 1130390: Improve handling of SIGINT (CTRL-C)

0.8.0

  • Implement image-delete for Image API v2
  • Update warlock dependency to >= 0.7.0 and < 1
  • 1061150: Support non-ASCII characters
  • 1102944: The port option is configurable when using HTTPS
  • 1093380: Support image names in place of IDs for CLI commands
  • 1094917: Better representation of errors through CLI

0.7.0

  • Add --store option to image-create command
  • Deprecate --ca-file in favor of --os-cacert
  • 1082957: Add --sort-key and --sort-dir CLI options to image-list command
  • 1081542: Change default image-list CLI sort to order by image name ascending
  • 1079692: Verify SSL certification hostnames when using HTTPS
  • 1080739: Use --os-region-name in service catalog lookup

0.6.0

  • Multiple image ID can be passed to glance image-delete
  • glance --version and glanceclient.__version__ expose the current library version
  • Use --human-readable with image-list and image-show to display image sizes in human-friendly formats
  • Use OpenSSL for HTTPS connections
  • 1056220: Always use 'Transfer-Encoding: chunked' when transferring image data
  • 1052846: Padded endpoints enabled (e.g. glance.example.com/padding/v1)
  • 1050345: glance image-create and glance image-update now work on Windows

0.5.1

  • 1045824: Always send Content-Length when updating image with image data
  • 1046607: Handle 300 Multiple Choices nicely in the CLI
  • 1035931: Properly display URI in legacy 'show' command
  • 1048698: Catch proper httplib InvalidURL exception

0.5.0

  • Add 'image-download' command to CLI
  • Relax dependency on warlock to anything less than v2

0.4.2

  • 1037233: Fix v1 image list where limit kwarg is less than page_size

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

0.4.0

  • Send client SSL certificate to server for self-identification
  • Properly validate server SSL certificates
  • Images API v2 image data download