RETIRED, python utility to manage a tripleo based cloud

Go to file

Ben Nemec 017cb65bea Don't download fedora-user as part of --all build fedora-user is an optional image that is only used for testing the deployed overcloud. We shouldn't force everyone to download it as part of the --all build when in many cases it won't be needed. The option to download it is left in the client though so it can still be easily retrieved when necessary. Change-Id: I3ea6ad911a6ee411f19379060da127ef0a6e75e3		2015-10-14 16:17:19 +00:00
doc/source	Remove Tuskar support	2015-09-28 07:50:48 +00:00
tripleoclient	Don't download fedora-user as part of --all build	2015-10-14 16:17:19 +00: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
MANIFEST.in	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	Update requirements	2015-10-07 14:46:56 +02:00
setup.cfg	Cleanup some strangling references to rdomanager-oscplugin	2015-09-17 15:54:14 +00:00
setup.py	Initial commit	2015-03-17 09:33:52 -04:00
test-requirements.txt	Update requirements	2015-10-07 14:46:56 +02:00
tox.ini	Add debug environment to tox	2015-10-01 11:11:46 +03: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.