Implement a new set of karbor commands as python-openstackclient plugins.
Launchpad Blueprint: https://blueprints.launchpad.net/python-karborclient/+spec/karbor-support-python-openstackclient
python-openstackclient is becoming the default command line client for many OpenStack projects. Karbor would benefit from implementing all of its client commands as a single python-openstackclient plugin implemented in the python-karborclient repository.
The intent of this spec is to identify the commands to be implemented and establish conventions for command and argument names. This spec is not intended to be a full and correct specification of command and argument names. The details can be left to the code reviews for the commands themselves.
The following conventions will be adopted for command names:
As the OpenStackClient
convention, the command name shall always take
the following form:
openstack [<global-options>] <object-1> <action> [<object-2>] \
[command-arguments]
As a example:
The following karbor
commands about plan will be implemented for openstack
initially suggesting these command names:
karbor plan-create <name> <provider_id> <resources>
openstack data protection plan create <name> <provider_id> <resources>
karbor plan-delete <plan>
openstack data protection plan delete <plan>
karbor plan-list
openstack data protection plan list
karbor plan-show <plan>
openstack data protection plan show <plan>
karbor plan-update <name> <resources> <status>
openstack data protection plan update <name> <resources> <status>
None
None
None
None
None
A new directory named osc will be created under /karborclient/osc
for the OpenStackClient
plugin and the commands mentioned above.
None
None
None
None
chenying
CLI commands as stated above. Unit tests
None
python-openstackclient osc-lib
Unit tests will be located in: /karborclient/tests/unit/osc/
OpenStack Client adoption list will be updated to include python-karborclient.
None
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.