diff --git a/doc/source/specs/karbor-support-in-python-openstackclient.rst b/doc/source/specs/karbor-support-in-python-openstackclient.rst new file mode 100644 index 0000000..330e37b --- /dev/null +++ b/doc/source/specs/karbor-support-in-python-openstackclient.rst @@ -0,0 +1,166 @@ +.. + This work is licensed under a Creative Commons Attribution 3.0 Unported + License. + + http://creativecommons.org/licenses/by/3.0/legalcode + +======================================== +Karbor support in python-openstackclient +======================================== + +Implement a new set of karbor commands as python-openstackclient plugins. + +Launchpad Blueprint: +https://blueprints.launchpad.net/python-karborclient/+spec/karbor-support-python-openstackclient + + +Problem Description +=================== + +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. + +Proposed Change +=============== + +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: + +.. code-block:: bash + + openstack [] [] \ + [command-arguments] + + +As a example: +The following ``karbor`` commands about plan will be implemented for ``openstack`` +initially suggesting these command names: + +.. code-block:: bash + + karbor plan-create + openstack dataprotection plan create + + karbor plan-delete + openstack dataprotection plan delete + + karbor plan-list + openstack dataprotection plan list + + karbor plan-show + openstack dataprotection backup plan + + karbor plan-update + openstack dataprotection plan update + + +Configuration +------------- + +None + +Database +-------- + +None + +Public API +---------- + +None + +Public API Security +------------------- + +None + +Python API +---------- + +None + +CLI (python-karborclient) +------------------------ + +A new directory named osc will be created under /karborclient/osc +for the ``OpenStackClient`` plugin and the commands mentioned above. + +Internal API +------------ + +None + +Guest Agent +----------- + +None + +Alternatives +------------ + +None + +Dashboard Impact (UX) +===================== + +None + +Implementation +============== + +Assignee(s) +----------- + +Primary assignee: + chenying + + +Milestones +---------- + + +Work Items +---------- + +CLI commands as stated above. +Unit tests + +Upgrade Implications +==================== + +None + +Dependencies +============ + +python-openstackclient +osc-lib + +Testing +======= + +Unit tests will be located in: /karborclient/tests/unit/osc/ + +Documentation Impact +==================== + +OpenStack Client adoption list will be updated to include python-karborclient. + +References +========== + +http://docs.openstack.org/developer/python-openstackclient/commands.html + +Appendix +======== + +None