Synnefo » ./kamaki

All kamaki commands should adopt a naming scheme that will look like this:

kamaki <object> <action> [positional arguments] [non-positional arguments]

e.g.,

kamaki server info <server id>
kamaki file download <remote file path> [local path] --container=pithos

The positional arguments will always be identification information for the object(s). In other words, the positional arguments will always answer the question "which object(s)". On the above examples, the server id answer the question "which server", and the positional arguments of the "file download" command answer the question "which (remote and local) files".

All objects may have the following actions:

kamaki <object>
   info <ids>        Information on the object (metadata, details, etc.)
   list              List all (or some, according to some filter) objects
   create            Create a new object (all parameters are given with non-positional arguments)
   delete <ids>      Delete the object
   modify <ids>      Change some properties of the object, using non-positional arguments
   various actions   Actions specific to each object (e.g., server start, file move, ip detach)

Some examples to clarify:

kamaki server info <server id>                        Get details for a server
kamaki quotas list                                    List all user quotas
kamaki container create --name=<container name>       Create a new container (--name is mandatory)
kamaki delete network <network id>                    Delete a network
kamaki image modify <image id> --property OS=Linux    Change the value of the image property "OS" for a specific image
kamaki file copy --source-account=other-person --container=pithos my.file --target-account=me my.file.copy

Effects: The scheme will produce a number of new 1st level commands and vast changes in documentation (not estimated).

Total objects in kamaki (hidden objects are enclosed in [brackets]:

user
quotas
resources
projects
[commission]
[service]
[endpoints]
server
flavor
image
ip
port
network
subnet
image
[computeimage]
file
sharers
container
shanshot
volume