projects / kamaki / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix typo in cli.commands.astakos_cli.py
[kamaki] / docs / commands.rst
diff --git a/docs/commands.rst b/docs/commands.rst
index 1048fdc..2d18146 100644 (file)
--- a/docs/commands.rst
+++ b/docs/commands.rst
@@ -24,15 +24,14 @@ In the following, the token has been set in a previous step (see `setup section
 
     * Authenticate user *
     [astakos]:authenticate
 
     * Authenticate user *
     [astakos]:authenticate
-    auth_token        :  s0m3t0k3nth@t1sr3m0v3d==
     auth_token_created:  2012-11-13T14:12:40.917034
     auth_token_expires:  2012-12-13T14:12:40.917035
     auth_token_created:  2012-11-13T14:12:40.917034
     auth_token_expires:  2012-12-13T14:12:40.917035
-    groups            : 
-                      default
-    has_credits       :  False
-    has_signed_terms  :  True
-    uniq              :  myaccount@grnet.gr
-    username          :  4215th3b357num9323v32
+    email             :  
+                       myaccount@grnet.gr
+                       myotheraccount@grnet.gr
+    name              :  My Real Name
+    username          :  usually@an.email.org
+    uuid              :  ab1cde23-45fg-6h7i-8j9k-10l1m11no2pq
 
 flavor (Compute/Cyclades)
 -------------------------
 
 flavor (Compute/Cyclades)
 -------------------------
@@ -92,17 +91,17 @@ Showcase: Pick an image and list the properties
 
     * list all available images *
     [image]:list
 
     * list all available images *
     [image]:list
-    1395fdfb-51b4-419f-bb02-f7d632860611 (Ubuntu Desktop LTS)
-    1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)
-    18a82962-43eb-4b32-8e28-8f8880af89d7 (Kubuntu LTS)
-    6aa6eafd-dccb-422d-a904-67fe2bdde87e (Debian Desktop)
-    6b5681e4-7502-46ae-b1e9-9fd837932095 (maelstrom)
-    78262ee7-949e-4d70-af3a-85360c3de57a (Windows Server 2012)
-    86bc2414-0fb3-4898-a637-240292243302 (Fedora)
-    926ab1c5-2d85-49d4-aebe-0fce712789b9 (Windows Server 2008)
-    b2dffe52-64a4-48c3-8a4c-8214cc3165cf (Debian Base)
-    baf2321c-57a0-4a69-825d-49f49cea163a (CentOS)
-    c1d27b46-d875-4f5c-b7f1-f39b5af62905 (Kubuntu)
+    1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
+    1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
+    18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
+    6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
+    6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
+    78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
+    86bc2414-0fb3-4898-a637-240292243302 Fedora
+    926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
+    b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
+    baf2321c-57a0-4a69-825d-49f49cea163a CentOS
+    c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
 
     * Get properties of image with id b2dffe52-64a4-48c3-8a4c-8214cc3165cf *
     [image]:properties b2dffe52-64a4-48c3-8a4c-8214cc3165cf
 
     * Get properties of image with id b2dffe52-64a4-48c3-8a4c-8214cc3165cf *
     [image]:properties b2dffe52-64a4-48c3-8a4c-8214cc3165cf
@@ -166,17 +165,17 @@ Showcase: Create a server
 
     * List all available images *
     [server]:/image list
 
     * List all available images *
     [server]:/image list
-    1395fdfb-51b4-419f-bb02-f7d632860611 (Ubuntu Desktop LTS)
-    1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)
-    18a82962-43eb-4b32-8e28-8f8880af89d7 (Kubuntu LTS)
-    6aa6eafd-dccb-422d-a904-67fe2bdde87e (Debian Desktop)
-    6b5681e4-7502-46ae-b1e9-9fd837932095 (maelstrom)
-    78262ee7-949e-4d70-af3a-85360c3de57a (Windows Server 2012)
-    86bc2414-0fb3-4898-a637-240292243302 (Fedora)
-    926ab1c5-2d85-49d4-aebe-0fce712789b9 (Windows Server 2008)
-    b2dffe52-64a4-48c3-8a4c-8214cc3165cf (Debian Base)
-    baf2321c-57a0-4a69-825d-49f49cea163a (CentOS)
-    c1d27b46-d875-4f5c-b7f1-f39b5af62905 (Kubuntu)
+    1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
+    1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
+    18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
+    6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
+    6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
+    78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
+    86bc2414-0fb3-4898-a637-240292243302 Fedora
+    926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
+    b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
+    baf2321c-57a0-4a69-825d-49f49cea163a CentOS
+    c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
 
     * See details of flavor with id 1 *
     [server]:/flavor info 1
 
     * See details of flavor with id 1 *
     [server]:/flavor info 1
@@ -207,7 +206,7 @@ Showcase: Create a server
 
     * wait for server to build (optional) *
     [server]:wait 11687
 
     * wait for server to build (optional) *
     [server]:wait 11687
-    Server 11687 still in BUILD mode |||||||||||||||||    | 80% - 3s
+    Server 11687 still in BUILD mode |||||||||||||||||    | 80%
     Server 11687 is now in ACTIVE mode
 
 .. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
     Server 11687 is now in ACTIVE mode
 
 .. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
@@ -298,13 +297,13 @@ store (Storage/Pithos+)
     append        :  Append local file to remote
     cat           :  Print a file to console
     copy          :  Copy an object
     append        :  Append local file to remote
     cat           :  Print a file to console
     copy          :  Copy an object
-    create        :  Create a container or a directory object
+    create        :  Create a container
     delete        :  Delete a container [or an 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]]
+    delgroup      :  Delete a user group
+    delmeta       :  Delete an existing metadatum for an account [, container [or object]]
     delpermissions:  Delete all sharing permissions
     download      :  Download a file
     delpermissions:  Delete all sharing permissions
     download      :  Download a file
-    group         :  Get user groups details for account
+    group         :  Get user groups details
     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
     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
@@ -317,12 +316,13 @@ store (Storage/Pithos+)
     publish       :  Publish an object
     purge         :  Purge a container
     quota         :  Get  quota for account [or container]
     publish       :  Publish an object
     purge         :  Purge a container
     quota         :  Get  quota for account [or container]
-    setgroup      :  Create/update a new user group on account
+    setgroup      :  Create/update a new user group
     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
     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
+    touch         :  Create an empty object (file)
     truncate      :  Truncate remote file up to a size
     unpublish     :  Unpublish an object
     upload        :  Upload a file
     truncate      :  Truncate remote file up to a size
     unpublish     :  Unpublish an object
     upload        :  Upload a file
@@ -405,3 +405,7 @@ Showcase: Upload and download a file
     [store]:!diff rndm_local.file rndm_remote.file
 
 .. Note:: In kamaki shell, ! is used to execute OS shell commands (bash in the above)
     [store]:!diff rndm_local.file rndm_remote.file
 
 .. Note:: In kamaki shell, ! is used to execute OS shell commands (bash in the above)
+
+.. warning:: The container:object/path syntax does not function if the container and / or the object path contain one or more : characters. To use containers and objects with : use the --container and --dst-container arguments, e.g. to copy test.py object from grnet:dev container to grnet:deploy ::
+
+        $ kamaki store copy --container=grnet:dev test.py --dst-container=grnet:deploy
Kamaki