bf641ae368
Added openstack plugin for Kingbird client that supports execution of Kingbird commands with openstack client. Change-Id: Ia164b4f5c9dbe388fe3d1cada38c3bc0af32c1e6
84 lines
2.6 KiB
ReStructuredText
84 lines
2.6 KiB
ReStructuredText
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
|
|
============
|
|
* Free software: Apache license
|
|
* `PyPi`_ - package installation
|
|
* `Launchpad project`_ - release management
|
|
* `Blueprints`_ - feature specifications
|
|
* `Bugs`_ - issue tracking
|
|
* `Source`_
|
|
* `How to Contribute`_
|
|
* `Documentation`_
|
|
|
|
.. _PyPi: https://pypi.python.org/pypi/python-kingbirdclient
|
|
.. _Launchpad project: https://launchpad.net/python-kingbirdclient
|
|
.. _Bugs: https://bugs.launchpad.net/python-kingbirdclient
|
|
.. _Blueprints: https://blueprints.launchpad.net/python-kingbirdclient
|
|
.. _Source: http://git.openstack.org/cgit/openstack/python-kingbirdclient
|
|
.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
|
|
.. _Documentation: http://docs.openstack.org/developer/python-kingbirdclient
|