RETIRED, python utility to manage a tripleo based cloud

Go to file

Dougal Matthews cff7ee3359 Fix the deploy tests The ManillaPassword parameter was added without the tests being updated. This caused a number of failures. This change also sorts the parameters to make them easier to visiaully inspect and adds an assert to check the symetric difference between the parmater keys - making it easier to see what the extra parameter is when there is one. Change-Id: I75542ca1bb457ef55405235cbc481b6811a112a8		2015-08-07 08:40:26 +01:00
doc/source	Rename the "all" commands to "bulk"	2015-05-21 11:17:17 +02:00
rdomanager_oscplugin	Fix the deploy tests	2015-08-07 08:40:26 +01:00
.coveragerc	Initial commit	2015-03-17 09:33:52 -04:00
.gitignore	Initial commit	2015-03-17 09:33:52 -04:00
.gitreview	Initial commit	2015-03-17 09:33:52 -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	Initial commit	2015-03-17 09:33:52 -04:00
jenkins-config.yml	Changing the way jenkins is being called	2015-04-29 13:50:48 +01: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	Initial commit	2015-03-17 09:33:52 -04:00
requirements.txt	Use a released version of ironic_discoverd	2015-07-13 16:31:45 +01:00
setup.cfg	Move postconfig to deploy command	2015-06-22 09:32:36 -04:00
setup.py	Initial commit	2015-03-17 09:33:52 -04:00
test-requirements.txt	Restrict the Mock version for Python 2.6 compatability	2015-07-10 11:30:49 +01:00
tox.ini	Add man-type documentation pages for rdo-manager commands	2015-04-28 22:10:23 -04:00

README.rst

rdomanager-oscplugin

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.

rdomanager-oscplugin is an OpenStackClient (OSC) plugin implementation that implements commands useful for RDO manager 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 rdomanager_oscplugin 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.