Team and repository tags

python-cyborgclient is a python bindings to the OpenStack Cyborg API. There's a command-line interface via the OpenStack client plugin. The client implements the OpenStack Cyborg v2 API.

See the OpenStack CLI Reference for information on how to use the OpenStack client with the accelerator plugin. You may also want to look at the OpenStack API documentation.

The project is hosted on Launchpad, where bugs can be filed. The code is hosted on OpenStack. Patches must be submitted using Gerrit.

This code is a fork of Jacobian's python-cloudservers. If you need API support for the Rackspace API solely or the BSD license, you should use that repository. python-cyborgclient is licensed under the Apache License like the rest of OpenStack.

License: Apache License, Version 2.0
PyPi - package installation
Online Documentation
Blueprints - feature specifications
Bugs - issue tracking
Source
Specs
How to Contribute

Contents:

Command-line API

Installing this package gets you a plugin for the openstack command-line tool that you can use to interact with the OpenStack Cyborg API.

You'll need to provide your OpenStack username and password. You can do this with the --os-username, --os-password and --os-project-name params, but it's easier to just set them as environment variables:

export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_PROJECT_NAME=myproject

You will also need to define the authentication url with --os-auth-url. If you are using Keystone, you need to set the OS_AUTH_URL to the keystone endpoint:

export OS_AUTH_URL=http://controller:5000/v3

Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.

You'll find complete documentation on the accelerator commands by running openstack accelerator --help

Python API

The Python API is provided through the OpenStack SDK.

See release notes and more at https://docs.openstack.org/python-cyborgclient/latest/.