Jump to: navigation, search

Difference between revisions of "Solum/CLI"

(Created page with "Solum Command Line Interface == Blueprints == * https://blueprints.launchpad.net/solum/+spec/solum-cli * https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli == Mi...")
 
Line 4: Line 4:
 
* https://blueprints.launchpad.net/solum/+spec/solum-cli
 
* https://blueprints.launchpad.net/solum/+spec/solum-cli
 
* https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli
 
* https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli
 +
* ML CLI discussions: http://lists.openstack.org/pipermail/openstack-dev/2013-November/018505.html
  
 
== Minimal CLI Options ==
 
== Minimal CLI Options ==
# Argparse (https://review.openstack.org/66065)
+
=== Argparse (WIP pull request - https://review.openstack.org/66065) ===
# Cliff
+
==== Pros ====
# OSC
+
* Fast-track to completing an M1 CLI
 +
* Relatively simple Python standard argparse library-based code
 +
* No external (potentially changing) code dependencies
 +
* Modeled after Trove architecture recommendations
 +
 
 +
==== Cons ====
 +
* May be the largest porting effort to the eventual OpenStack client of any options
 +
* No authentication handling built in (likely need to make a dependency on the python keystone client - https://github.com/openstack/python-keystoneclient)
 +
 
 +
=== Cliff (no pull request) ===
 +
https://cliff.readthedocs.org/en/latest/
 +
Cliff Demo App: https://github.com/dreamhost/cliff/tree/master/demoapp
 +
 
 +
[Not very familiar with this library, can someone else provide benefits?]
 +
 
 +
=== OSC (WIP pull request/hack - https://review.openstack.org/#/c/64703/) ===
 +
Note: dtroyer is PTL
 +
 
 +
==== Pros ====
 +
* Considered by many to be the best path for integration into the future OpenStack CLI architecture
 +
* Integrates authentication already
 +
* dtroyer agreed to implement two Solum plugin features to provide an example
 +
 
 +
==== Cons ====
 +
* Not complete - some APIs may change, especially around authentication
 +
* The plugin documentation is not complete
 +
* No other project has implemented the OSC plugin yet (core OpenStack projects add their features directly into the OSC without plugins)
 +
* There are discussions about potential OSC architectural changes within OpenStack; want to verify that we will not be chasing large code changes

Revision as of 19:23, 13 January 2014

Solum Command Line Interface

Blueprints

Minimal CLI Options

Argparse (WIP pull request - https://review.openstack.org/66065)

Pros

  • Fast-track to completing an M1 CLI
  • Relatively simple Python standard argparse library-based code
  • No external (potentially changing) code dependencies
  • Modeled after Trove architecture recommendations

Cons

Cliff (no pull request)

https://cliff.readthedocs.org/en/latest/ Cliff Demo App: https://github.com/dreamhost/cliff/tree/master/demoapp

[Not very familiar with this library, can someone else provide benefits?]

OSC (WIP pull request/hack - https://review.openstack.org/#/c/64703/)

Note: dtroyer is PTL

Pros

  • Considered by many to be the best path for integration into the future OpenStack CLI architecture
  • Integrates authentication already
  • dtroyer agreed to implement two Solum plugin features to provide an example

Cons

  • Not complete - some APIs may change, especially around authentication
  • The plugin documentation is not complete
  • No other project has implemented the OSC plugin yet (core OpenStack projects add their features directly into the OSC without plugins)
  • There are discussions about potential OSC architectural changes within OpenStack; want to verify that we will not be chasing large code changes