RETIRED, python utility to manage a tripleo based cloud

Go to file

Dan Prince 9244349742 Use Mistral for baremetal registration Updates the baremetal registration workflows to use Mistral instead of python. Co-Authored-By: Dougal Matthews <dougal@redhat.com> Co-Authored-By: Ryan Brady <rbrady@redhat.com> Change-Id: Ide8b7753829170f503ef962b4ad4fde388cbb0ba Depends-On: Ifc6bdd273a8e129ea7c4269d00add64e72cd371b Depends-On: I910f50a377bcbc2c23b527953e9df7eee9c938a4		2016-07-08 15:43:18 +01:00
doc/source	Merge "[Trivial] Remove executable privilege of doc/source/conf.py"	2016-05-27 18:35:09 +00:00
tripleoclient	Use Mistral for baremetal registration	2016-07-08 15:43:18 +01:00
.coveragerc	Merge "Change ignore-errors to ignore_errors"	2015-09-25 20:53:52 +00:00
.gitignore	Initial commit	2015-03-17 09:33:52 -04:00
.gitreview	Update .gitreview to point to review.openstack.org	2015-09-08 10:10:44 -04:00
.mailmap	Initial commit	2015-03-17 09:33:52 -04:00
.testr.conf	Initial commit	2015-03-17 09:33:52 -04:00
babel.cfg	Initial commit	2015-03-17 09:33:52 -04:00
CONTRIBUTING.rst	Cleanup some strangling references to rdomanager-oscplugin	2015-09-17 15:54:14 +00:00
LICENSE	Initial commit	2015-03-17 09:33:52 -04:00
README.rst	Cleanup some strangling references to rdomanager-oscplugin	2015-09-17 15:54:14 +00:00
requirements.txt	Use Mistral for baremetal registration	2016-07-08 15:43:18 +01:00
setup.cfg	Implement 'openstack overcloud execute'	2016-06-20 10:26:51 -04:00
setup.py	Updated from global requirements	2015-12-23 00:37:32 +00:00
test-requirements.txt	Updated from global requirements	2016-06-29 22:13:23 +00:00
tox.ini	Merge "Revert "Pass environment variables of proxy to tox""	2016-02-10 21:50:02 +00:00

README.rst

tripleoclient

OpenStackClient reference plugin module

The OSC plugin system is designed so that the plugin need only be properly installed for OSC to find and use it. It utilizes the setuptools entry points mechanism to advertise to OSC the plugin module and supported commands.

tripleoclient is an OpenStackClient (OSC) plugin implementation that implements commands useful for TripleO and the install and management of both an undercloud and an overcloud.

Discovery

OSC discovers extensions by enumerating the entry points found under openstack.cli.extension and initializing the given client module.

[entry_points]
openstack.cli.extension =
    oscplugin = oscplugin.plugin

The client module must implement the following interface functions:

API_NAME - A string containing the plugin API name; this is the name of the entry point declaring the plugin client module (oscplugin = ... in the example above) and the group name for the plugin commands (openstack.oscplugin.v1 = in the example below)
API_VERSION_OPTION (optional) - If set, the name of the API version attribute; this must be a valid Python identifier and match the destination set in build_option_parser().
API_VERSIONS - A dict mapping a version string to the client class
build_option_parser(parser) - Hook to add global options to the parser
make_client(instance) - Hook to create the client object

OSC enumerates the loaded plugins and loads commands from the entry points defined for the API version:

openstack.oscplugin.v1 =
    plugin_list = oscplugin.v1.plugin:ListPlugin
    plugin_show = oscplugin.v1.plugin:ShowPlugin

Note that OSC defines the group name as openstack.<api-name>.v<version> so the version should not contain the leading 'v' character.

This second step is identical to that performed for all but the Identity client in OSC itself. Identity is special due to the authentication requirements. This limits the ability to add additional auth modules to OSC.

Client

The current implementation of the tripleoclient Client class is an empty placeholder. This client object is not equired but OSC's ClientManager will maintain it as required and is the interface point for other plugins to access anything implemented by this plugin.