openstack
/
python-tripleoclient
Code Issues Proposed changes
RETIRED, python utility to manage a tripleo based cloud
803 Commits 3 Branches 30 Tags 71 MiB
Go to file
Sagi Shnaidman f58c836658 Remove RH1 OVB jobs from configuration 
Remove OVB RH1 jobs from configuration for this repo
Related-Bug: #1744763

Change-Id: Ie28daf8e3b4f6609ca855a1c29a7549490419a1d
 		2018-01-22 20:41:03 +00:00
doc/source Fix doc page for overcloud deploy 2016-08-22 13:47:17 +02:00
releasenotes/notes Add --skip-deploy-identifier 2017-08-04 07:57:26 -04:00
tools Add Constraints support 2017-02-07 04:17:11 +00:00
tripleoclient Add --skip-deploy-identifier 2017-08-04 07:57:26 -04:00
zuul.d Remove RH1 OVB jobs from configuration 2018-01-22 20:41:03 +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 Use qemu-img in bindep 2017-11-29 02:05:30 +00:00
requirements.txt Updated from global requirements 2016-11-02 20:09:51 +00:00
setup.cfg Remove "baremetal show capabilities" command 2017-01-27 07:55:04 +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 Add Constraints support 2017-02-07 04:17:11 +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.