Commands
========
-Command specifications for kamaki.cli
+List of commands
+----------------
+
+The commands described bellow are grouped by service. The examples showcase a sample set of group commands. The kamaki interactive shell (check `Usage section <usage.html#interactive-shell>`_ for details) is chosen as the execution environment:
+
+astakos (Identity Manager)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+ authenticate: Authenticate a user
+
+Showcase: get user information, provided the token was set
+
+.. code-block:: console
+ :emphasize-lines: 1,4
+
+ * Enter astakos context *
+ [kamaki]:astakos
+
+ * 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
+ groups :
+ default
+ has_credits : False
+ has_signed_terms : True
+ uniq : myaccount@grnet.gr
+ username : 4215th3b357num9323v32
+
+flavor (Compute/Cyclades)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+ info: Get flavor details
+ list: List flavors
+
+Showcase: show details for flavor with id 43
+
+.. code-block:: console
+ :emphasize-lines: 1,4
+
+ * Enter flavor context *
+ [kamaki]: flavor
+
+ * Get details about flavor with id 43 *
+ [flavor]: info 43
+ SNF:disk_template: drbd
+ cpu : 4
+ disk : 10
+ id : 43
+ name : C4R2048D10
+ ram : 2048
+
+image (Compute/Cyclades + Glance)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+ addmember : Add a member to an image
+ addproperty: Add an image property
+ delete : Delete image
+ delmember : Remove a member from an image
+ delproperty: Delete an image property
+ info : Get image details
+ list : List images
+ members : Get image members
+ meta : Get image metadata
+ properties : Get image properties
+ public : List public images
+ register : (Re)Register an image
+ setmembers : Set the members of an image
+ setproperty: Update an image property
+ shared : List shared images
+
+Showcase: Pick an image and list the properties
+
+.. code-block:: console
+ :emphasize-lines: 1,4,18
+
+ * Enter image context *
+ [kamaki]:image
+
+ * 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)
+
+ * Get properties of image with id b2dffe52-64a4-48c3-8a4c-8214cc3165cf *
+ [image]:properties b2dffe52-64a4-48c3-8a4c-8214cc3165cf
+ description : Debian 6.0.6 (Squeeze) Base System
+ gui : No GUI
+ kernel : 2.6.32
+ os : debian
+ osfamily : linux
+ root_partition: 1
+ sortorder : 1
+ users : root
+
+server (Compute/Cyclades)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+ addmeta : Add server metadata
+ addr : List a server's nic address
+ console : Get a VNC console
+ create : Create a server
+ delete : Delete a server
+ delmeta : Delete server metadata
+ firewall: Set the server's firewall profile
+ info : Get server details
+ list : List servers
+ meta : Get a server's metadata
+ reboot : Reboot a server
+ rename : Update a server's name
+ setmeta : Update server's metadata
+ shutdown: Shutdown a server
+ start : Start a server
+ stats : Get server statistics
+ wait : Wait for server to finish
+
+Showcase: Create a server.
+
+.. code-block:: console
+ :emphasize-lines: 1,4,21,35,44,62
+
+ * Enter server context *
+ [kamaki]:server
+
+ * See server-create help *
+ [server]:create -h
+ usage: create <name> <flavor id> <image id>
+ [--personality PERSONALITY] [-h] [--config CONFIG]
+
+ Create a server
+
+ optional arguments:
+ -v, --verbose More info at response
+ --personality PERSONALITY
+ add a personality file
+ -d, --debug Include debug output
+ -h, --help Show help message
+ -i, --include Include protocol headers in the output
+ --config CONFIG Path to configuration file
+ -s, --silent Do not output anything
+
+ * 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)
+
+ * See details of flavor with id 1 *
+ [server]:/flavor info 1
+ SNF:disk_template: drbd
+ cpu : 1
+ disk : 20
+ id : 1
+ name : C1R1024D20
+ ram : 1024
+
+ * Create a debian server named 'My Small Debian Server'
+ [server]:create 'My Small Debian Server' 1 b2dffe52-64a4-48c3-8a4c-8214cc3165cf
+ adminPass: L8gu2wbZ94
+ created : 2012-11-23T16:56:04.190813+00:00
+ flavorRef: 1
+ hostId :
+ id : 11687
+ imageRef : b2dffe52-64a4-48c3-8a4c-8214cc3165cf
+ metadata :
+ values:
+ os : debian
+ users: root
+ name : My Small Debian Server
+ progress : 0
+ status : BUILD
+ suspended: False
+ updated : 2012-11-23T16:56:04.761962+00:00
+
+ * wait for server to build (optional) *
+ [server]:wait 11687
+ Server 11687 still in BUILD mode ||||||||||||||||| | 80% - 3s
+ 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
+
+network (Compute/Cyclades)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+ connect : Connect a server to a network
+ create : Create a network
+ delete : Delete a network
+ disconnect: Disconnect a nic of a server to a network
+ info : Get network details
+ list : List networks
+ rename : Update network name
+
+Showcase: Connect a network to a VM
+
+.. code-block:: console
+ :emphasize-lines: 1,4,9,24,27,44
+
+ * Enter network context *
+ [kamaki]:network
+
+ * List user-owned VMs *
+ [network]:/server list
+ 11687 (My Small Debian Server)
+ 11688 (An Ubuntu server)
+
+ * Try network-connect (to get help) *
+ [network]:connect
+ Syntax error
+ usage: connect <server id> <network id> [-s] [-h] [-i] [--config CONFIG]
+
+ Connect a server to a network
+
+ Syntax: connect <server id> <network id>
+ --config : Path to configuration file
+ -d,--debug : Include debug output
+ -h,--help : Show help message
+ -i,--include: Include protocol headers in the output
+ -s,--silent : Do not output anything
+ -v,--verbose: More info at response
+
+ * Connect VM with id 11687 to network with id 1409
+ [network]: connect 11687 1409
+
+ * Get details on network with id 1409
+ [network]:info 1409
+ attachments:
+ nic-11687-1
+ cidr : 192.168.1.0/24
+ cidr6 : None
+ created : 2012-11-23T17:17:20.560098+00:00
+ dhcp : True
+ gateway : None
+ gateway6 : None
+ id : 1409
+ name : my network
+ public : False
+ status : ACTIVE
+ type : PRIVATE_MAC_FILTERED
+ updated : 2012-11-23T17:18:25.095225+00:00
+
+ * Get connectivity details on VM with id 11687 *
+ [network]:/server addr 11687
+ id: nic-11687-1
+ ipv4 : 192.168.1.1
+ ipv6 : None
+ mac_address: aa:0f:c2:0b:0e:85
+ network_id : 1409
+ firewallProfile: DISABLED
+ id: nic-11687-0
+ ipv4 : 83.212.106.111
+ ipv6 : 2001:648:2ffc:1116:a80c:f2ff:fe12:a9e
+ mac_address : aa:0c:f2:12:0a:9e
+ network_id : 1369
+
+.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
+
+store (Storage/Pithos+)
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+ append : Append local file to remote
+ 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
+
+Showcase: Upload and download a file.
+
+.. code-block:: console
+ :emphasize-lines: 1,7,11,16,21,29,33,37,41,44,51,55,60,64
+
+ * Create a random binarry file at current OS path *
+ [kamaki]:!dd bs=4M if=/dev/zero of=rndm_local.file count=5
+ 5+0 records in
+ 5+0 records out
+ 20971520 bytes (21 MB) copied, 0.016162 s, 1.3 GB/s
+
+ * Enter store context *
+ [kamaki]:store
+
+
+ * Check local file *
+ [store]:!ls -lh rndm_local.file
+ -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file
+
+
+ * Create two containers *
+ [store]:create mycont1
+ [store]:create mycont2
+
+
+ * List accessible containers *
+ [store]:list
+ 1. mycont1 (0B, 0 objects)
+ 2. mycont2 (0B, 0 objects)
+ 3. pithos (0B, 0 objects)
+ 4. trash (0B, 0 objects)
+
+
+ * Upload local file to 1st container *
+ [store]:upload rndm_local.file mycont1
+
+
+ * Check if file has been uploaded *
+ [store]:list mycont1
+ 1. 20M rndm_local.file
+
+ * Create directory mydir on second container *
+ [store]:mkdir mycont2:mydir
+
+
+ * Move file from 1st to 2nd container (and in the directory) *
+ [store]:move mycont1:rndm_local.file mycont2:mydir/rndm_local.file
+
+ * Check contents of both containers *
+ [store]:list mycont1
+ [store]:list mycont2
+ 1. D mydir/
+ 2. 20M mydir/rndm_local.file
+
+
+ * Copy file from 2nd to 1st container, with a new name *
+ [store]:copy mycont2:mydir/rndm_local.file mycont1:rndm_remote.file
+
+
+ * Check pasted file *
+ [store]:list mycont1
+ 1. 20M rndm_remote.file
+
+
+ * Download pasted file to local file system *
+ [store]:download mycont1:rndm_remote.file rndm_remote.file
+
+
+ * Check if file is downloaded and if it is the same to original *
+ [store]:!ls -lh *.file
+ -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file
+ -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:42 rndm_remote.file
+ [store]:!diff rndm_local.file rndm_remote.file
+
+.. Note:: In kamaki shell, ! is used to execute OS shell commands (bash in the above)
+
+
+Command specifications
+----------------------
cyclades_cli
-------------
+^^^^^^^^^^^^
.. automodule:: kamaki.cli.commands.cyclades_cli
:members:
pithos_cli
-----------
+^^^^^^^^^^
.. automodule:: kamaki.cli.commands.pithos_cli
:members:
:undoc-members:
image_cli
----------
+^^^^^^^^^
.. automodule:: kamaki.cli.commands.image_cli
:members:
astakos_cli
------------
+^^^^^^^^^^^
.. automodule:: kamaki.cli.commands.astakos_cli
:members:
:undoc-members:
config_cli
-----------
+^^^^^^^^^^
.. automodule:: kamaki.cli.commands.config_cli
:members:
:undoc-members:
history_cli
------------
+^^^^^^^^^^^
.. automodule:: kamaki.cli.commands.history_cli
:members:
$ kamaki server list
-Commands
---------
-
-Client commands are grouped by service (see example 3.1.1 on how to list available groups). Commands behavior is as uniform as possible, but there are still differences between groups due to the special nature of each service and server-side implementation.
-
-Typically, commands consist of a group name (e.g. store for storage commands) one or more terms (e.g. list for listing) and the command specific parameters (e.g. the name of the container), if any.
-
-.. code-block:: console
- :emphasize-lines: 1
-
- Example 3.1.1: List stored files in container mycontainer.
-
- $ kamaki store list mycontainer
-
-Example 2.3.2 showcases a command without parameters (the group is "server", the command is "list").
-
-The "server" command group is also referred in the following example.
-
-.. code-block:: console
- :emphasize-lines: 1
-
- Example 3.1.2 Show information about a user-managed VM with id 42
-
- $ kamaki server info 42
-
-Client commands can feature an arbitrary number of terms:
-
-.. code-block:: text
-
- kamaki <group> <cmd term 1> <cmd term 2> ... <cmd term N> [arguments]
-
-Although there are no multi-termed client commands until version 0.6.1 , the feature is supported and might be used in feature extensions.
-
-The following pattern applies to all client commands up to version 0.6.1:
-
-.. code-block:: text
-
- kamaki <group> <command> [arguments]
-
-The commands supported in version 0.6.1 are described bellow, grouped by service. The examples showcase a sample set of group commands. The kamaki interactive shell has been chosen as the execution environment:
-
-astakos (Identity Manager)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: text
-
- authenticate: Authenticate a user
-
-Showcase: get user information, provided the token was set
-
-.. code-block:: console
- :emphasize-lines: 1,4
-
- * Enter astakos context *
- [kamaki]:astakos
-
- * 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
- groups :
- default
- has_credits : False
- has_signed_terms : True
- uniq : myaccount@grnet.gr
- username : 4215th3b357num9323v32
-
-flavor (Compute/Cyclades)
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: text
-
- info: Get flavor details
- list: List flavors
-
-Showcase: show details for flavor with id 43
-
-.. code-block:: console
- :emphasize-lines: 1,4
-
- * Enter flavor context *
- [kamaki]: flavor
-
- * Get details about flavor with id 43 *
- [flavor]: info 43
- SNF:disk_template: drbd
- cpu : 4
- disk : 10
- id : 43
- name : C4R2048D10
- ram : 2048
-
-image (Compute/Cyclades + Glance)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: text
-
- addmember : Add a member to an image
- addproperty: Add an image property
- delete : Delete image
- delmember : Remove a member from an image
- delproperty: Delete an image property
- info : Get image details
- list : List images
- members : Get image members
- meta : Get image metadata
- properties : Get image properties
- public : List public images
- register : (Re)Register an image
- setmembers : Set the members of an image
- setproperty: Update an image property
- shared : List shared images
-
-Showcase: Pick an image and list the properties
-
-.. code-block:: console
- :emphasize-lines: 1,4,18
-
- * Enter image context *
- [kamaki]:image
-
- * 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)
-
- * Get properties of image with id b2dffe52-64a4-48c3-8a4c-8214cc3165cf *
- [image]:properties b2dffe52-64a4-48c3-8a4c-8214cc3165cf
- description : Debian 6.0.6 (Squeeze) Base System
- gui : No GUI
- kernel : 2.6.32
- os : debian
- osfamily : linux
- root_partition: 1
- sortorder : 1
- users : root
-
-server (Compute/Cyclades)
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: text
-
- addmeta : Add server metadata
- addr : List a server's nic address
- console : Get a VNC console
- create : Create a server
- delete : Delete a server
- delmeta : Delete server metadata
- firewall: Set the server's firewall profile
- info : Get server details
- list : List servers
- meta : Get a server's metadata
- reboot : Reboot a server
- rename : Update a server's name
- setmeta : Update server's metadata
- shutdown: Shutdown a server
- start : Start a server
- stats : Get server statistics
- wait : Wait for server to finish
-
-Showcase: Create a server.
-
-.. code-block:: console
- :emphasize-lines: 1,4,21,35,44,62
-
- * Enter server context *
- [kamaki]:server
-
- * See server-create help *
- [server]:create -h
- usage: create <name> <flavor id> <image id>
- [--personality PERSONALITY] [-h] [--config CONFIG]
-
- Create a server
-
- optional arguments:
- -v, --verbose More info at response
- --personality PERSONALITY
- add a personality file
- -d, --debug Include debug output
- -h, --help Show help message
- -i, --include Include protocol headers in the output
- --config CONFIG Path to configuration file
- -s, --silent Do not output anything
-
- * 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)
-
- * See details of flavor with id 1 *
- [server]:/flavor info 1
- SNF:disk_template: drbd
- cpu : 1
- disk : 20
- id : 1
- name : C1R1024D20
- ram : 1024
-
- * Create a debian server named 'My Small Debian Server'
- [server]:create 'My Small Debian Server' 1 b2dffe52-64a4-48c3-8a4c-8214cc3165cf
- adminPass: L8gu2wbZ94
- created : 2012-11-23T16:56:04.190813+00:00
- flavorRef: 1
- hostId :
- id : 11687
- imageRef : b2dffe52-64a4-48c3-8a4c-8214cc3165cf
- metadata :
- values:
- os : debian
- users: root
- name : My Small Debian Server
- progress : 0
- status : BUILD
- suspended: False
- updated : 2012-11-23T16:56:04.761962+00:00
-
- * wait for server to build (optional) *
- [server]:wait 11687
- Server 11687 still in BUILD mode ||||||||||||||||| | 80% - 3s
- 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
-
-network (Compute/Cyclades)
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: text
-
- connect : Connect a server to a network
- create : Create a network
- delete : Delete a network
- disconnect: Disconnect a nic of a server to a network
- info : Get network details
- list : List networks
- rename : Update network name
-
-Showcase: Connect a network to a VM
-
-.. code-block:: console
- :emphasize-lines: 1,4,9,24,27,44
-
- * Enter network context *
- [kamaki]:network
-
- * List user-owned VMs *
- [network]:/server list
- 11687 (My Small Debian Server)
- 11688 (An Ubuntu server)
-
- * Try network-connect (to get help) *
- [network]:connect
- Syntax error
- usage: connect <server id> <network id> [-s] [-h] [-i] [--config CONFIG]
-
- Connect a server to a network
-
- Syntax: connect <server id> <network id>
- --config : Path to configuration file
- -d,--debug : Include debug output
- -h,--help : Show help message
- -i,--include: Include protocol headers in the output
- -s,--silent : Do not output anything
- -v,--verbose: More info at response
-
- * Connect VM with id 11687 to network with id 1409
- [network]: connect 11687 1409
-
- * Get details on network with id 1409
- [network]:info 1409
- attachments:
- nic-11687-1
- cidr : 192.168.1.0/24
- cidr6 : None
- created : 2012-11-23T17:17:20.560098+00:00
- dhcp : True
- gateway : None
- gateway6 : None
- id : 1409
- name : my network
- public : False
- status : ACTIVE
- type : PRIVATE_MAC_FILTERED
- updated : 2012-11-23T17:18:25.095225+00:00
-
- * Get connectivity details on VM with id 11687 *
- [network]:/server addr 11687
- id: nic-11687-1
- ipv4 : 192.168.1.1
- ipv6 : None
- mac_address: aa:0f:c2:0b:0e:85
- network_id : 1409
- firewallProfile: DISABLED
- id: nic-11687-0
- ipv4 : 83.212.106.111
- ipv6 : 2001:648:2ffc:1116:a80c:f2ff:fe12:a9e
- mac_address : aa:0c:f2:12:0a:9e
- network_id : 1369
-
-.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
-
-store (Storage/Pithos+)
-^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: text
-
- append : Append local file to remote
- 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
-
-Showcase: Upload and download a file.
-
-.. code-block:: console
- :emphasize-lines: 1,7,11,16,21,29,33,37,41,44,51,55,60,64
-
- * Create a random binarry file at current OS path *
- [kamaki]:!dd bs=4M if=/dev/zero of=rndm_local.file count=5
- 5+0 records in
- 5+0 records out
- 20971520 bytes (21 MB) copied, 0.016162 s, 1.3 GB/s
-
- * Enter store context *
- [kamaki]:store
-
-
- * Check local file *
- [store]:!ls -lh rndm_local.file
- -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file
-
-
- * Create two containers *
- [store]:create mycont1
- [store]:create mycont2
-
-
- * List accessible containers *
- [store]:list
- 1. mycont1 (0B, 0 objects)
- 2. mycont2 (0B, 0 objects)
- 3. pithos (0B, 0 objects)
- 4. trash (0B, 0 objects)
-
-
- * Upload local file to 1st container *
- [store]:upload rndm_local.file mycont1
-
-
- * Check if file has been uploaded *
- [store]:list mycont1
- 1. 20M rndm_local.file
-
- * Create director mydir on second container *
- [store]:mkdir mycont2:mydir
-
-
- * Move file from 1st to 2nd container (and in the directory) *
- [store]:move mycont1:rndm_local.file mycont2:mydir/rndm_local.file
-
- * Check the container of both containers *
- [store]:list mycont1
- [store]:list mycont2
- 1. D mydir/
- 2. 20M mydir/rndm_local.file
-
-
- * Copy file from 2nd to 1st container, with a new name *
- [store]:copy mycont2:mydir/rndm_local.file mycont1:rndm_remote.file
-
-
- * Check pasted file *
- [store]:list mycont1
- 1. 20M rndm_remote.file
-
-
- * Download pasted file to local file system *
- [store]:download mycont1:rndm_remote.file rndm_remote.file
-
-
- * Check if file is downloaded and if it is the same to original *
- [store]:!ls -lh *.file
- -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:36 rndm_local.file
- -rw-rw-r-- 1 ******** ******** 20M Nov 26 15:42 rndm_remote.file
- [store]:!diff rndm_local.file rndm_remote.file
-
-.. Note:: In kamaki shell, ! is used to execute OS shell commands (bash in the above)
-
One-command interface
---------------------
.. code-block:: console
:emphasize-lines: 1
- Example 4.1.1: kamaki help shows available parameters and command groups
+ Example 3.1.1: kamaki help shows available parameters and command groups
$ kamaki -h
.. code-block:: console
:emphasize-lines: 1
- Example 4.1.2: Cyclades help contains all first-level commands of Cyclades command group
+ Example 3.1.2: Cyclades help contains all first-level commands of Cyclades command group
$ kamaki cyclades -h
.. code-block:: console
:emphasize-lines: 1
- Example 4.1.3: Help for command "server list" with syntax, description and available user options
+ Example 3.1.3: Help for command "server list" with syntax, description and available user options
$ kamaki server list -h
.. code-block:: console
:emphasize-lines: 1
- Example 4.2.1: Available history options
+ Example 3.2.1: Available history options
$ kamaki history -h
.. code-block:: console
:emphasize-lines: 1
- Example 4.2.2: Clean up everything, run a kamaki command, show full and filtered history
+ Example 3.2.2: Clean up everything, run a kamaki command, show full and filtered history
$ kamaki history clean
.. code-block:: console
:emphasize-lines: 1
- Example 4.4.1: Print username for token us3rt0k3n== using grep
+ Example 3.4.1: Print username for token us3rt0k3n== using grep
$ kamaki astakos authenticate -o token=us3rt0k3n== | grep uniq
The -o argument can be used to override temporarily various (set or unset) options. In one command, all -o options are forgotten just after the command had been completed, and the previous settings are restored (the configuration file is not modified).
-The astakos-authenticate command in example 4.4.1 run against an explicitly provided token, which temporarily overrode the token provided in the configuration file.
+The astakos-authenticate command in example 3.4.1 run against an explicitly provided token, which temporarily overrode the token provided in the configuration file.
Interactive shell
-----------------
Command Contexts
^^^^^^^^^^^^^^^^
-The kamaki interactive shell implements the notion of command contexts. Each command group is also a context where the users can **enter** by typing the group name. If the context switch is successful, the kamaki shell prompt changes to present the new context ("store" in example 5.1.1).
+The kamaki interactive shell implements the notion of command contexts. Each command group is also a context where the users can **enter** by typing the group name. If the context switch is successful, the kamaki shell prompt changes to present the new context ("store" in example 4.1.1).
.. code-block:: console
:emphasize-lines: 1
- Example 5.1.1: Enter store commands context / group
+ Example 4.1.1: Enter store commands context / group
$ kamaki
.. code-block:: console
:emphasize-lines: 1
- Example 5.1.2: Exit store context and then exit kamaki
+ Example 4.1.2: Exit store context and then exit kamaki
[store]: exit
[kamaki]: exit
.. code-block:: console
:emphasize-lines: 1
- Example 5.1.3: Execute list command in different contexts
+ Example 4.1.3: Execute list command in different contexts
$ kamaki
[kamaki]:config
[server]: exit
[kamaki]:
-Users have the option to avoid switching between contexts: all commands can run from the **top context**. As a result, examples 5.1.3 and 5.1.4 are equivalent.
+Users have the option to avoid switching between contexts: all commands can run from the **top context**. As a result, examples 4.1.3 and 4.1.4 are equivalent.
.. code-block:: console
:emphasize-lines: 1
- Example 5.1.4: Execute different "list" commands from top context
+ Example 4.1.4: Execute different "list" commands from top context
[kamaki]:config list
.. code-block:: console
:emphasize-lines: 1
- Example 5.2.1: Get available commands, pick a context and get help there as well
+ Example 4.2.1: Get available commands, pick a context and get help there as well
[kamaki]:help
.. code-block:: console
:emphasize-lines: 1
- Example 5.2.2: Get command-level help for config and config-set
+ Example 4.2.2: Get command-level help for config and config-set
[kamaki]:config --help
--config CONFIG Path to configuration file
-s, --silent Do not output anything
-There are many ways of producing a help message, as shown in example 5.2.3
+There are many ways of producing a help message, as shown in example 4.2.3
.. code-block:: console
:emphasize-lines: 1
- Example 5.2.3: Equivalent calls of command-level help for config-set
+ Example 4.2.3: Equivalent calls of command-level help for config-set
[config]:set -h
* access a command "anothercontext cmd1 cmd2 ... cmdN"
[context]:/anothercontext cmd1 cmd2 ... cmdN
-An example (5.3.1) that showcases how top-level access improves user experience is the creation of a VM. A VM is created with the command server-create. This command is called with three parameters:
+An example (4.3.1) that showcases how top-level access improves user experience is the creation of a VM. A VM is created with the command server-create. This command is called with three parameters:
* the name of the new VM
* the flavor id
.. code-block:: console
:emphasize-lines: 1
- Example 5.3.1: Create a VM from server context
+ Example 4.3.1: Create a VM from server context
[server]:create -h
create <name> <flavor id> <image id> ...
[server]:create 'my debian' 43 6aa6eafd-dccb-67fe2bdde87e
...
-An other example (5.3.2) showcases how to acquire and modify configuration settings from a different context. In this scenario, the user token expires at server side while the user is working. When that happens, the system responds with an *(401) UNAUTHORIZED* message. The user can acquires a new token (with a browser) which has to be set to kamaki.
+An other example (4.3.2) showcases how to acquire and modify configuration settings from a different context. In this scenario, the user token expires at server side while the user is working. When that happens, the system responds with an *(401) UNAUTHORIZED* message. The user can acquires a new token (with a browser) which has to be set to kamaki.
.. code-block:: console
:emphasize-lines: 1
- Example 5.3.2: Set a new token from store context
+ Example 4.3.2: Set a new token from store context
[store]:list
.. code-block:: console
:emphasize-lines: 1,3,10,17,26
- Example 5.3.3: Equivalent astakos-authenticate calls after a store-list 401 failure
+ Example 4.3.3: Equivalent astakos-authenticate calls after a store-list 401 failure
* without kamaki interactive shell *
$ kamaki store list
.. Note:: config updates in kamaki shell persist even after the session is over. All setting changes affects the physical kamaki config file (automatically created, if not set manually)
-In example 5.4.1 the user is going to work with only one storage container. The store commands use the container:path syntax, but if the user could set a container as a default, the container name could be omitted in most cases. This is possible by setting a store.container setting.
+In example 4.4.1 the user is going to work with only one storage container. The store commands use the container:path syntax, but if the user could set a container as a default, the container name could be omitted in most cases. This is possible by setting a store.container setting.
.. code-block:: console
:emphasize-lines: 1
- Example 5.4.1: Set default storage container
+ Example 4.4.1: Set default storage container
[store]:list
1. D mydir/
2. 20M mydir/rndm_local.file
-After a while, the user needs to work with multiple containers, therefore a default container is not longer needed. The store.container setting can be deleted, as shown in example 5.4.2 .
+After a while, the user needs to work with multiple containers, therefore a default container is not longer needed. The store.container setting can be deleted, as shown in example 4.4.2 .
.. code-block:: console
:emphasize-lines: 1
- Example 5.4.2: Delete a setting option
+ Example 4.4.2: Delete a setting option
[store]:/config delete store.container
.. code-block:: console
:emphasize-lines: 1
- Example 5.7.1: Run unix-style shell commands from kamaki shell
+ Example 4.7.1: Run unix-style shell commands from kamaki shell
[kamaki]:!ls -al
-rw-rw-r-- 1 saxtouri saxtouri 8063 Jun 28 14:48 logo-copy.png
-Kamaki shell commits command strings to the outside shell and prints the results, without interacting with it. After a command is finished, kamaki shell returns to its initial state, which involves the current directory, as show in example 5.7.2 .
+Kamaki shell commits command strings to the outside shell and prints the results, without interacting with it. After a command is finished, kamaki shell returns to its initial state, which involves the current directory, as show in example 4.7.2 .
.. code-block:: console
:emphasize-lines: 1
- Example 5.7.2: Attempt (and fail) to change working directory
+ Example 4.7.2: Attempt (and fail) to change working directory
[kamaki]:!pwd
projects / kamaki / commitdiff