Plugins

The OpenStackClient 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.

OpenStackClient promises to provide first class support for the following
OpenStack services: Compute, Identity, Image, Object Storage, Block Storage
and Network (core objects). These services are considered essential
to any OpenStack deployment.

Other OpenStack services, such as Orchestration or Telemetry may create an
OpenStackClient plugin. The source code will not be hosted by
OpenStackClient.

The following is a list of projects that are an OpenStackClient plugin.

aodhclient

gnocchiclient

python-barbicanclient

python-congressclient

python-designateclient

python-heatclient

python-ironicclient

python-ironic-inspector-client

python-karborclient

python-mistralclient

python-muranoclient

python-neutronclient***

python-octaviaclient

python-rsdclient

python-saharaclient

python-searchlightclient

python-senlinclient

python-tripleoclient**

python-troveclient

python-watcherclient

python-zaqarclient

python-zunclient

** Note that some clients are not listed in global-requirements.

*** Project contains advanced network services.

The following is a list of projects that are not an OpenStackClient plugin.

Plugins are discovered by enumerating the entry points
found under openstack.cli.extension and initializing the specified
client module.

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

The client module must define the following top-level variables:

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).
OSC reserves the following API names: compute, identity,
image, network, object_store and volume.

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

The client module must implement the following interface functions:

build_option_parser(parser) - Hook to add global options to the parser

make_client(instance) - Hook to create the client object

OSC enumerates the plugin commands from the entry points in the usual manner
defined for the API version:

Note that OSC defines the group name as openstack.
so the version should not contain the leading ‘v’ character.

fromosc_libimportutilsDEFAULT_API_VERSION='1'# Required by the OSC plugin interfaceAPI_NAME='oscplugin'API_VERSION_OPTION='os_oscplugin_api_version'API_VERSIONS={'1':'oscplugin.v1.client.Client',}# Required by the OSC plugin interfacedefmake_client(instance):"""Returns a client to the ClientManager Called to instantiate the requested client version. instance has any available auth info that may be required to prepare the client. :param ClientManager instance: The ClientManager that owns the new client """plugin_client=utils.get_client_class(API_NAME,instance._api_version[API_NAME],API_VERSIONS)client=plugin_client()returnclient# Required by the OSC plugin interfacedefbuild_option_parser(parser):"""Hook to add global options Called from openstackclient.shell.OpenStackShell.__init__() after the builtin parser has been initialized. This is where a plugin can add global options such as an API version setting. :param argparse.ArgumentParser parser: The parser object that has been initialized by OpenStackShell. """parser.add_argument('--os-oscplugin-api-version',metavar='<oscplugin-api-version>',help='OSC Plugin API version, default='+DEFAULT_API_VERSION+' (Env: OS_OSCPLUGIN_API_VERSION)')returnparser

OSC provides the following interfaces that may be used to implement
the plugin commands:

# osc-lib interfaces available to plugins:fromosc_lib.cliimportparseractionsfromosc_lib.commandimportcommandfromosc_libimportexceptionsfromosc_libimportlogsfromosc_libimportutilsclassDeleteMypluginobject(command.Command):"""Delete mypluginobject"""...deftake_action(self,parsed_args):# Client manager interfaces are available to plugins.# This includes the OSC clients created.client_manager=self.app.client_manager...return

OSC provides the following interfaces that may be used to implement
unit tests for the plugin commands:

OSC should be included in the plugin’s test-requirements.txt if
the plugin can be installed as a library with the CLI being an
optional feature (available when OSC is also installed).

OSC should not appear in requirements.txt unless the plugin project
wants OSC and all of its dependencies installed with it. This is
specifically not a good idea for plugins that are also libraries
installed with OpenStack services.

Add openstackclient-plugin-jobs to the list of job templates for your project.
These jobs ensures that all plugin libraries are co-installable with
python-openstackclient and checks for conflicts across all OpenStackClient
plugins, such as duplicated commands, missing entry points, or other overlaps.

Add your project to the required-projects list in the .zuul.yaml file
in the openstack/openstackclient repo.