kamaki.rst 6.76 KB
Newer Older
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
1
2
3
4
5
6
7
8
:orphan:

kamaki tool manual page
=======================

Synopsis
--------

Stavros Sachtouris's avatar
Stavros Sachtouris committed
9
**kamaki** [*group*] [*command*] [...] [*options*]
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
10
11
12
13
14
15


Description
-----------

:program:`kamaki` is a simple, yet intuitive, command-line tool for managing 
Stavros Sachtouris's avatar
Stavros Sachtouris committed
16
clouds. It can be used in three forms: as an interactive shell, as a command line tool or as a clients API for other applications.
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
17

Stavros Sachtouris's avatar
Stavros Sachtouris committed
18
19
20
21
22
23
24
25
26
27
28
29
To run kamaki as an interactive shell, type

    kamaki

To run kamaki as tool type

    kamaki <group> <command> [...] [options]

The kamaki clients API can be imported in python applications as kamaki.clients


List of available command groups:
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
30
31
32
33
34

config

    Edit configuration options. Config options are stored in ~/.kamakirc file.

Stavros Sachtouris's avatar
Stavros Sachtouris committed
35
36
37
38
history

    Access kamaki user history, which is stored in ~/.kamaki.history file.

39
user
Stavros Sachtouris's avatar
Stavros Sachtouris committed
40

41
    Get information from Astakos API
Stavros Sachtouris's avatar
Stavros Sachtouris committed
42

Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
43
44
45
46
47
48
49
50
51
52
53
54
server

    Manage compute API virtual machines.

flavor

    Manage compute API flavors.

network

    Manage compute API networks.

Stavros Sachtouris's avatar
Stavros Sachtouris committed
55
image 
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
56

57
    Manage images on Plankton (and Compute).
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
58

59
file
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
60

61
    Manage Pithos+ API.
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
62
63


Stavros Sachtouris's avatar
Stavros Sachtouris committed
64
65
66
Hidden command groups
---------------------

Stavros Sachtouris's avatar
Stavros Sachtouris committed
67
livetest
Stavros Sachtouris's avatar
Stavros Sachtouris committed
68

Stavros Sachtouris's avatar
Stavros Sachtouris committed
69
    LIve tests that check kamaki against running services. To enable:
70
    kamaki config set livetest.cli livetest
Stavros Sachtouris's avatar
Stavros Sachtouris committed
71
72


Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
73
74
75
Options
-------

76
77
78
79
80
81
.. code-block:: console

    --help, -h              Show help message and exit.
    -v                      Use verbose output.
    -d                      Use debug output.
    -o KEY=VAL              Override a config value (can be used multiple times)
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95


Commands
--------

config commands
***************

* list       list configuration options
* get        get a configuration option
* set        set a configuration option
* del        delete a configuration option


Stavros Sachtouris's avatar
Stavros Sachtouris committed
96
97
98
history commands
****************

99
Command user history, as stored in ~/.kamaki.history
Stavros Sachtouris's avatar
Stavros Sachtouris committed
100

Stavros Sachtouris's avatar
Stavros Sachtouris committed
101
* show      show intersession history
Stavros Sachtouris's avatar
Stavros Sachtouris committed
102
* clean     clean up history
Stavros Sachtouris's avatar
Stavros Sachtouris committed
103
* run       run/show previously executed command(s)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
104

Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
105

106
107
user commands
*************
Stavros Sachtouris's avatar
Stavros Sachtouris committed
108
109
110
111

* authenticate      Authenticate a user, show user information


Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
112
113
114
server commands
***************

Stavros Sachtouris's avatar
Stavros Sachtouris committed
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
* 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)
* delmeta   Delete server (VM) metadata
* firewall  Set the server (VM) firewall profile on VMs public network
* info      Detailed information on a Virtual Machine
* list      List Virtual Machines accessible by user
* meta      Get a server's metadatum
* reboot    Reboot a server (VM)
* rename    Set/update a server (VM) name
* setmeta   set server (VM) metadata
* 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]
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
131
132
133
134
135
136
137
138
139


flavor commands
***************

* list       list flavors
* info       get flavor details


140
141
image commands
**************
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
142

Stavros Sachtouris's avatar
Stavros Sachtouris committed
143
144
145
146
147
148
149
150
151
* addmember     Add a member to an image
* addproperty   Add an OS-related property to an image
* delete        Delete an image (image file remains intact)
* delmember     Remove a member from an image
* delproperty   Delete a property of an image
* info          Get detailed information on an image
* members       Get image members
* meta          Get image metadata
* properties    Get properties related to OS installation in an image
152
* list          List images accessible by user
Stavros Sachtouris's avatar
Stavros Sachtouris committed
153
154
155
156
* register      (Re)Register an image
* setmembers    Set the members of an image
* setproperty   Update an existing property in an image
* shared        List images shared by a member
157
158
159
160
161
162
163
* compute       Compute Image API commands
    * list          List images
    * delete        Delete image
    * info          Get image details
    * properties    Get image properties
    * delproperty   Delete an image property
    * setproperty   Update an image property
Stavros Sachtouris's avatar
Stavros Sachtouris committed
164

Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
165
166
167
168

network commands
****************

Stavros Sachtouris's avatar
Stavros Sachtouris committed
169
170
171
172
173
174
175
* 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
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
176
177


178
file commands
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
179
180
**************

181
182
183
184
185
186
187
188
* append                Append local file to (existing) remote object
* cat                   Print remote file contents to console
* copy                  Copy an object from container to (another) container
* create                Create a container
* delete                Delete a container [or an object]
* delgroup              Delete a user group
* delmeta               Delete metadata from account, container or object
* delpermissions        Delete all permissions set on object
189
* download              Download remote object(s) as local file(s)
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
* group                 Get groups and group members
* hashmap               Get the hash-map of an object
* info                  Get detailed info for account, containers or objects
* list                  List containers, object trees or objects in a directory
* manifest              Create a remote file of uploaded parts by manifestation
* meta                  Get metadata for account, containers or objects
* mkdir                 Create a directory
* move                  Copy an object
* overwrite             Overwrite part (from start to end) of a remote file
* permissions           Get read and write permissions of an object
* publish               Publish the object and print the public url
* purge                 Delete a container and release related data blocks
* quota                 Get quota (in KB) for account or container
* setgroup              Set a user group
* setmeta               Set a piece of metadata for account, container or object
* setpermissions        Set permissions for an object
206
207
* containerlimit set    Set new limit for container
* containerlimit get    Get container limit
208
209
210
211
212
* setversioning         Set versioning mode (auto, none) for account or container
* sharers               List the accounts that share objects with current user
* touch                 Create an empty object (file)
* truncate              Truncate remote file up to a size
* unpublish             Unpublish an object
213
* upload                Upload a file or directory
214
215
* versioning            Get  versioning for account or container
* versions              Get the list of object versions
Stavros Sachtouris's avatar
Stavros Sachtouris committed
216
217
218
219
220
221


test commands (hidden)
**********************

* all         test all clients
222
* args        test how arguments are treated by kamaki
Stavros Sachtouris's avatar
Stavros Sachtouris committed
223
224
225
226
227
228
* 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
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
229
230
231
232
233


Author
------

234
GRNET development team <synnefo-devel@googlegroups.com>.
Kostas Papadimitriou's avatar
Kostas Papadimitriou committed
235