openstack/python-cyborgclient
Code Issues Proposed changes
Client library for Cyborg API
46 Commits 11 Branches 37 Tags 1.6 MiB
Python 100%
a788cf6c5d
Go to file
Andreas Jaeger a788cf6c5d Remove unused osc_plugin environment 
This environment is not used and broken, none of the files exist.
Remove it, this is not needed.

Change-Id: Icf053b6104192d8adc883a9cfb9b922ba0089880
2020-05-12 20:18:39 +02:00
cyborgclient Update hacking for Python3 2020-03-31 10:46:06 +02:00
doc/source Bump the openstackdocstheme extension to 1.20 2019-09-16 13:53:36 +08:00
releasenotes Update master for stable/stein 2020-04-27 20:28:56 +08:00
.coveragerc Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.gitignore Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:10 +00:00
.mailmap Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.stestr.conf Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
.zuul.yaml Add Python3 victoria unit tests 2020-04-11 18:49:36 +00:00
CONTRIBUTING.rst Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
HACKING.rst Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
LICENSE Initialize cyborgclient repository 2018-04-12 16:09:57 +00:00
README.rst Update api-ref location 2019-07-25 18:10:37 +02:00
requirements.txt Update docs building 2020-04-26 19:24:57 +08:00
setup.cfg Update docs building 2020-04-26 19:24:57 +08:00
setup.py Cleanup py27 support 2020-04-05 07:24:28 +02:00
test-requirements.txt Update docs building 2020-04-26 19:24:57 +08:00
tox.ini Remove unused osc_plugin environment 2020-05-12 20:18:39 +02:00

README.rst

Team and repository tags

image

python-cyborgclient

Latest Version

python-cyborgclient is a python bindings to the OpenStack Cyborg API. There's a Python API (the cyborgclient module), and a command-line script (cyborg). Each implements 100% of the OpenStack Cyborg API.

See the OpenStack CLI Reference for information on how to use the cyborg command-line tool. 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.

Contents:

Command-line API

Installing this package gets you a shell command, cyborg, that you can use to interact with any Rackspace compatible API (including OpenStack).

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

export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_TENANT_NAME=myproject

You will also need to define the authentication url with --os-auth-url and the version of the API with --os-accelerator-api-version. Or set them as environment variables as well, OS_ACCELERATOR_API_VERSION=1. 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
export OS_ACCELERATOR_API_VERSION=1

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 shell by running cyborg help

Python API

There's also a complete Python API, but it has not yet been documented.

Quick-start using keystone:

# pass auth plugin and session to Client init.
# service_parameters contains servive_name, service_type, interface and
# region name.
>>> from cyborgclient.v1 import client
>>> nt = client.Client(auth=auth,session=_SESSION,**service_parameters)
>>> nt.accelerators.list()
[...]

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