openstack
/
python-tripleoclient
Code Issues Proposed changes
RETIRED, python utility to manage a tripleo based cloud
693 Commits 3 Branches 30 Tags 71 MiB
Go to file
Dougal Matthews bf4daeab8a Migrate to using osc-lib 
This new library provides the common logic used by openstack
clients. Replacing the imports from openstackclient and cliff.

Depends-On-External: https://review.rdoproject.org/r/#/c/2088/
Depends-On: I095209c241876c6ab48595962e07144fc5cc34a6
Closes-Bug: #1620964
Change-Id: I103a13ff6c0af94b82f5e48652380adfbf331d34
(cherry picked from commit 133e8cf91a)
 		2016-09-16 00:34:57 +00:00
doc/source Fix doc page for overcloud deploy 2016-08-22 13:47:17 +02:00
tripleoclient Migrate to using osc-lib 2016-09-16 00:34:57 +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 for stable/newton 2016-09-13 02:04:05 +00:00
.mailmap Initial commit 2015-03-17 09:33:52 -04:00
.testr.conf 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
babel.cfg Initial commit 2015-03-17 09:33:52 -04:00
bindep.txt Add libffi-dev to bindep.txt 2016-09-12 12:53:33 +00:00
requirements.txt Migrate to using osc-lib 2016-09-16 00:34:57 +00:00
setup.cfg Add `overcloud parameters set` to set Heat params in a plan 2016-09-15 02:26:35 +00:00
setup.py Updated from global requirements 2015-12-23 00:37:32 +00:00
test-requirements.txt Migrate to using osc-lib 2016-09-16 00:34:57 +00:00
tox.ini Initial support for bindep 2016-08-11 20:04:55 -04: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.