Python client for Kingbird
Go to file
Jyothi Saroja bf641ae368 Openstack plugin for Kingbird client
Added openstack plugin for Kingbird client that supports execution
of Kingbird commands with openstack client.

Change-Id: Ia164b4f5c9dbe388fe3d1cada38c3bc0af32c1e6
2017-09-04 16:25:17 +05:30
doc/source Add common layer for the client 2016-09-08 10:57:01 +02:00
kingbirdclient Openstack plugin for Kingbird client 2017-09-04 16:25:17 +05:30
releasenotes Enable release notes translation 2016-10-06 20:50:29 +02:00
tools Implement Resource_sync commands for KB 2017-03-06 16:22:34 +00:00
.coveragerc Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
.gitignore Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
.gitreview Added .gitreview 2016-07-07 08:33:25 +00:00
.mailmap Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
.testr.conf Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
CONTRIBUTING.rst Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
HACKING.rst Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
LICENSE Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
MANIFEST.in Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
README.rst Openstack plugin for Kingbird client 2017-09-04 16:25:17 +05:30
babel.cfg Initial kingbirdclient commit 2016-07-07 14:09:12 +02:00
requirements.txt Updated from global requirements 2017-03-08 12:56:45 +00:00
run_tests.sh Add common layer for the client 2016-09-08 10:57:01 +02:00
setup.cfg Add entry points for kb client 2016-11-22 13:41:47 +05:30
setup.py Updated from global requirements 2017-03-08 12:56:45 +00:00
test-requirements.txt Updated from global requirements 2017-03-13 19:41:14 +00:00
tox.ini Implement Resource_sync commands for KB 2017-03-06 16:22:34 +00:00

README.rst

Kingbird

Centralised service for multi-region OpenStack deployments.

Kingbird is an centralized OpenStack service that provides resource operation and management across multiple OpenStack instances in a multi-region OpenStack deployment. This service is part of the OPNFV Multisite project that intends to address the use cases related to distributed cloud environments. Kingbird provides features like centralized quota management, centralized view for distributed virtual resources, global view for tenant level IP/MAC address space management, synchronisation of ssh keys, images, flavors, etc. across regions.

python-kingbirdclient

Python client for Kingbird

This is a client library for Kingbird built on the Kingbird API. It provides a Python API (the kingbirdclient module) and a command-line tool (kingbird).

Installation

First of all, clone the repo and go to the repo directory:

$ git clone https://github.com/openstack/python-kingbirdclient.git $ cd python-kingbirdclient

Then just run:

$ pip install -e .

or

$ pip install -r requirements.txt $ python setup.py install

Running Kingbird client

If Kingbird authentication is enabled, provide the information about OpenStack auth to environment variables. Type:

$ export OS_PROJECT_DOMAIN_ID=default $ export OS_REGION_NAME=RegionOne $ export OS_USER_DOMAIN_ID=default $ export OS_PROJECT_NAME=<project_name> $ export OS_IDENTITY_API_VERSION=<identity_version> $ export OS_PASSWORD=<password> $ export OS_AUTH_TYPE=password $ export OS_AUTH_URL=http://<Keystone_host>/identity $ export OS_USERNAME=<user_name> $ export OS_TENANT_NAME=<tenant_name> $ export OS_VOLUME_API_VERSION=<volume_version>

To make sure Kingbird client works, type:

$ kingbird quota defaults

You can see the list of available commands typing:

$ kingbird --help

Useful Links