Fix deprecated terms in documentation
[kamaki] / docs / man / kamaki.rst
index bcf3104..a3566fb 100644 (file)
@@ -36,6 +36,10 @@ history
 
     Access kamaki user history, which is stored in ~/.kamaki.history file.
 
+user
+
+    Get information from Astakos API
+
 server
 
     Manage compute API virtual machines.
@@ -50,11 +54,20 @@ network
 
 image 
 
-    Manage compute API and Plankton images.
+    Manage images on Plankton (and Compute).
+
+file
+
+    Manage Pithos+ API.
 
-store
 
-    Manage store API.
+Hidden command groups
+---------------------
+
+livetest
+
+    LIve tests that check kamaki against running services. To enable:
+    kamaki config set livetest.cli livetest
 
 
 Options
@@ -85,30 +98,39 @@ history commands
 
 Command user history, as stored in ~/.kamaki.history
 
-* all       show user history
+* show      show intersession history
 * clean     clean up history
+* run       run/show previously executed command(s)
+
+
+user commands
+*************
+
+* authenticate      Authenticate a user, show user information
 
 
 server commands
 ***************
 
-* list       list servers
-* info       get server details
-* create     create server
-* rename     update server name
-* delete     delete server
-* reboot     reboot server
-* start      start server
-* shutdown   shutdown server
-* console    get a VNC console
-* firewall   set the firewall profile
-* addr       list server addresses
-* meta       get server metadata
-* addmeta    add server metadata
-* setmeta    update server metadata
-* delmeta    delete server metadata
-* stats      get server statistics
-* wait       wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
+* addr      List the addresses of all network interfaces on a server (VM)
+* console   Get a VNC console to access an existing server (VM)
+* create    Create a server (aka Virtual Machine)
+* delete    Delete a server (VM)
+* firewall  Set the server (VM) firewall profile for public networks
+    * set   Set the firewall profile
+    * get   Get the firewall profile
+* info      Detailed information on a Virtual Machine
+* list      List Virtual Machines accessible by user
+* metadata  Manage a server metadata
+    * list      List server metadata
+    * set       Add or update server metadata
+    * delete    Delete a piece of server metadata
+* reboot    Reboot a server (VM)
+* rename    Set/update a server (VM) name
+* shutdown  Shutdown an active server (VM)
+* start     Start an existing server (VM)
+* stats     Get server (VM) statistics
+* wait      Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
 
 
 flavor commands
@@ -118,79 +140,103 @@ flavor commands
 * info       get flavor details
 
 
-image commands and options
-**************************
-
-* list        list images
-* info        get image details
-* public      list public images
-* shared      list shared images
-* delete      delete image
-* register    register an image
-* reregister  re-register an image (preserve and update properties)
-* meta        get image metadata
-* members     get image members
-* addmember   add a member to an image
-* delmember   remove a member from an image
-* setmembers  set the members of an image
-* properties  get image properties
-* setproperty update an image property
-* addproperty add an image property
-* delproperty delete an image property
+image commands
+**************
+
+* list           List images accessible by user
+* meta           Get image metadata
+* register       (Re)Register an image
+* unregister     Unregister an image (does not delete the image file)
+* shared         List shared images
+    * compute        Compute Image API commands
+    * list       List images
+    * delete     Delete image
+    * info       Get image details
+    * properties Manage properties related to OS installation in an image
+        * add    Add a property to an image
+        * delete Delete a property from an image
+        * get    Get an image property
+        * list   List all image properties
+        * set    Add / update a set of properties for an image
+* members        Manage members (users who can modify an image)
+    * add        Add a member to an image
+    * delete     Remove a member from an image
+    * list       List members of an image
+    * set        Set the members of an image
+
 
 network commands
 ****************
 
-* list       list networks
-* create     create a network
-* info       get network details
-* rename     update network name
-* delete     delete a network
-* connect    connect a server to a network
-* disconnect disconnect a server from a network
+* connect       Connect a server to a network
+* create        Create an (unconnected) network
+* delete        Delete a network
+* disconnect    Disconnect a nic that connects a server to a network
+* info          Detailed information on a network
+* list          List networks
+* rename        Set the name of a network
 
 
-store commands
+file commands
 **************
 
-* append    Append local file to (existing) remote object
-* cat       Print a file to console
-* copy      Copy an object
-* create    Create a container or a directory object
-* delete    Delete a container [or an object]
-* delgroup  Delete a user group on an account
-* delmeta   Delete an existing metadatum of account [, container [or object]]
-* delpermissions    Delete all sharing permissions
-* download  Download a file
-* group     Get user groups details for account
-* hashmap   Get the hashmap of an object
-* info      Get information for account [, container [or object]]
-* list      List containers, object trees or objects in a directory
-* manifest  Create a remote file with uploaded parts by manifestation
-* meta      Get custom meta-content for account [, container [or object]]
-* mkdir     Create a directory
-* move      Copy an object
-* overwrite Overwrite part (from start to end) of a remote file
-* permissions   Get object read/write permissions
-* publish   Publish an object
-* purge     Purge a container
-* quota     Get quota for account [or container]
-* setgroup  Create/update a new user group on account
-* setmeta   Set a new metadatum for account [, container [or object]]
-* setpermissions    Set sharing permissions
-* setquota  Set new quota (in KB) for account [or container]
-* setversioning Set new versioning (auto, none) for account [or container]
-* sharers   List the accounts that share objects with default account
-* truncate  Truncate remote file up to a size
-* unpublish Unpublish an object
-* upload    Upload a file
-* versioning    Get  versioning for account [or container ]
-* versions  Get the version list of an object
-
+* append         Append local file to remote file
+* cat            Print a file to console
+* copy           Copy an object
+* containerlimit Container size limit commands
+    * set        Set container data limit
+    * get        Get container data limit
+* create         Create a container
+* delete         Delete a container [or an object]
+* download       Download a file or directory
+* group          Manage access groups and group members
+    * delete     Delete a user group
+    * list       List groups and group members
+    * set        Set a user group
+* hashmap        Get the hashmap of an object
+* info           Get information for account [, container [or object]]
+* list           List containers, object trees or objects in a directory
+* manifest       Create a remote file with uploaded parts by manifestation
+* metadata       Metadata are attached on objects (key:value pairs)
+    * delete     Delete metadata with given key
+    * get        Get metadatum
+    * set        Set a piece of metadata
+* mkdir          Create a directory
+* move           Copy an object
+* overwrite      Overwrite part (from start to end) of a remote file
+* permissions    Manage user and group accessibility for objects
+    * delete     Delete all permissions set on object
+    * get        Get read and write permissions of an object
+    * set        Set permissions for an object
+* publish        Publish an object
+* purge          Purge a container
+* quota          Get  quota for account
+* sharers        List the accounts that share objects with default account
+* touch          Create an empty object (file)
+* truncate       Truncate remote file up to a size
+* unpublish      Unpublish an object
+* upload         Upload a file or directory
+* versioning     Manage the versioning scheme of current pithos user account
+    * get        Get  versioning for account or container
+    * set        Set versioning mode (auto, none) for account or container
+    * versions   Get the version list of an object
+
+
+test commands (hidden)
+**********************
+
+* all         test all clients
+* args        test how arguments are treated by kamaki
+* astakos     test Astakos client
+* cyclades    test Cyclades client
+* error       Create an error message with optional message
+* image       test Image client
+* pithos      test Pithos client
+* prints      user-test print methods for lists and dicts
 
 
 Author
 ------
 
-GRNET development team <synnefo-devel@googlegroups.com>.
+Synnefo development team <synnefo-devel@googlegroups.com>.