[dev] [jira] [Commented] (LIBCLOUD-272) Implement CLI tools for libcloud

["Mahendra M (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LIBCLOUD-272?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13542884#comment-13542884 ] 

Mahendra M commented on LIBCLOUD-272:
-------------------------------------

Sorry for the late reply. I was thinking on this and considering options.

I will have a look at libcloud.rest.
I feel the cli implementation should be part of libcloud main project itself.. for the following reasons
* cli really does not have a life outside of libcloud. I don't see features in cli which are ahead of libcloud.
* would be good if cli and libcloud releases go hand in hand. Feature additions to libcloud must reflect in cli, unified test cases etc. A change in a cloud provider driver must not impact cli.
* having both together will force developers/contributors to take care of maintaining consistency and ensure that both of them are not out-of-sync.
* People installing libcloud will get the CLI version immediately. Something similar to Boto.

Points favouring a sub-project
* cli is actually an implementation of libcloud (as in it is not a library per-se)

                
> Implement CLI tools for libcloud
> --------------------------------
>
>                 Key: LIBCLOUD-272
>                 URL: https://issues.apache.org/jira/browse/LIBCLOUD-272
>             Project: Libcloud
>          Issue Type: New Feature
>          Components: Core, Storage
>            Reporter: Mahendra M
>
> This ticket is for implementing a CLI framework for libcloud. Libcloud does a good job of abstracting cloud operations. If this functionality can be made available via command line tools, it will be an added advantage for libcloud usage. Some other cloud libraries provide such functionality (Like Boto).
> Design goals are to provide
> * Command line tools for all of libcloud's functionality
> * Command line options to control auth information
> * Ability to use config files (/etc/libcloud.conf, ~/.libcloud.conf) etc. These options can be over-written via command line arguments
> * Support for logging (controlled via config files).
> * Provide different commands for each functionality
>   * cloud_compute
>   * cloud_dns
>   * cloud_storage
>   * cloud_lb (load balancing)
> * A hierarchical command structure within each command
>   $ cloud_storage providers - list storage providers
>   $ cloud_storage container <list>/<create>/<delete>
>   $ cloud_storage object <list>/<put>/<get>/...
> * Provide simpler to remember aliases for sub-commands
>   $ cloud_storage container list/ls
> Implementation
> * For providing most of the functionality mentioned in design goals, the python cement library was used. (http://builtoncement.com/). This provides an excellent framework for solving our design goals. 
> It is tested for Python 2.6, 2.7, 3.1, and 3.2. However, I am not sure of it's support for Python 2.5.
> * As of now only the cloud_storage command is implemented.
> Config file structure
> [base]
> storage_provider=s3_us_west
> username=*******
> access_key=********
> [log]
> level=NONE
> file=/tmp/cli1.log
> to_console=False
> rotate=False
> max_bytes=512000
> max_file=5
> cloud_storage command
> $ cloud_storage providers - Lists the available storage providers
> Container operations
> $ cloud_storage container <list|ls> - Lists available containers
> $ cloud_storage container create <container_name>
> $ cloud_storage container delete -r -f -v <container_name>
>   By default container is not deleted if it is not empty
>   If -r is provided, all objects are recursively deleted after being prompted for each object
>   If -f is provided, all objects are recursively deleted without user prompt
>   If -rfv is mentioned, each deleted object is mentioned in the output
> Object operations
> List objects in a container
> $ cloud_storage object <list|ls> -v <container_name>
>   List all objects in the container
>   If -v is mentioned, object size is also listed out
> Delete an object
> $ cloud_storage object <delete|rm|del|remove> -f <container_name> <object_name>
>   Deletes the object in the container after prompting user for confirmation
>   If -f is specified, user is not prompted
> Upload an object from a local file or Unix pipe
> $ cloud_storage object <put|upload|store|create> <container_name> <object_name> <local_file>
> $ cat /path/to/file | cloud_storage object put <container_name> <object_name> 
> $ cat /path/to/file | cloud_storage object put <container_name> <object_name> -
> Download an object ot a local file or unix pipe
> $ cloud_storage object <get|download|stream> <container_name> <object_name> <local_file>
> $ cloud_storage object get <container_name> <object_name> > /path/to/file
> $ cloud_storage object get <container_name> <object_name> - > /path/to/file
> Other changes
> -------------
> * Minor bug fix in S3
> * setup.py was modified to install the cloud_storage command

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira