Revision e78f2082

b/debian/control
9 9

  
10 10
Package: kamaki
11 11
Architecture: all
12
Depends: ${python:Depends}, ${misc:Depends}, python-setuptools, python-objpool(>= 0.2), python-progress(>= 1.1), python-astakosclient(<= 0.14.8.1)
12
Depends: ${python:Depends}, ${misc:Depends}, python-setuptools, python-objpool(>= 0.2), python-progress(>= 1.1), python-astakosclient(>= 0.14.10)
13 13
Description: command-line tool for managing clouds
14 14
 Simple, yet intuitive, command-line tool for managing clouds.
15 15
 It is an initial implementation of the OpenStack Compute API,
b/debian/kamaki.1
1
.TH "KAMAKI" "1" "April 17, 2013" "0.7" "Kamaki"
1
.TH "KAMAKI" "1" "December 16, 2013" "0.12" "Kamaki"
2 2
.SH NAME
3 3
kamaki \- Command-line tool for managing clouds
4 4
.
......
28 28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 30
..
31
.\" Man page generated from reStructuredText.
31
.\" Man page generated from reStructeredText.
32 32
.
33 33
.SH SYNOPSIS
34 34
.sp
35
\fBkamaki\fP [\fIgroup\fP] [\fIcommand\fP] [...] [\fIoptions\fP]
35
\fBkamaki\fP [\fIgroup\fP] [\fIcommand\fP] [...] [\fIoptions\fP] [\fIarguments\fP]
36
\fBkamaki\-shell\fP [\fIgroup\fP] [\fIcommand\fP] [...] [\fIarguments\fP]
36 37
.SH DESCRIPTION
37 38
.sp
38 39
\fBkamaki\fP is a simple, yet intuitive, command\-line tool for managing
39
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.
40
clouds. It can be used in three forms: as an interactive shell
41
(\fIkamaki\-shell\fP), as a command line tool (\fIkamaki\fP) or as a clients API for
42
other applications (\fIkamaki.clients\fP).
40 43
.sp
41
To run kamaki as an interactive shell, type
44
To run \fIkamaki\fP as an interactive shell, type
42 45
.INDENT 0.0
43 46
.INDENT 3.5
44
kamaki
47
kamaki\-shell
45 48
.UNINDENT
46 49
.UNINDENT
47 50
.sp
48
To run kamaki as tool type
51
To run \fIkamaki\fP as tool type
49 52
.INDENT 0.0
50 53
.INDENT 3.5
51 54
kamaki <group> <command> [...] [options]
52 55
.UNINDENT
53 56
.UNINDENT
54 57
.sp
55
The kamaki clients API can be imported in python applications as kamaki.clients
58
The kamaki clients API can be imported in python applications as
59
\fIkamaki.clients\fP
56 60
.sp
57 61
List of available command groups:
58
.sp
59
config
60
.INDENT 0.0
61
.INDENT 3.5
62
Edit configuration options. Config options are stored in ~/.kamakirc file.
63
.UNINDENT
64
.UNINDENT
65
.sp
66
history
67
.INDENT 0.0
68
.INDENT 3.5
69
Access kamaki user history, which is stored in ~/.kamaki.history file.
70
.UNINDENT
71
.UNINDENT
72
.sp
73
user
74
.INDENT 0.0
75
.INDENT 3.5
76
Get information from Astakos API
77
.UNINDENT
78
.UNINDENT
79
.sp
80
server
81
.INDENT 0.0
82
.INDENT 3.5
83
Manage compute API virtual machines.
84
.UNINDENT
85
.UNINDENT
86
.sp
87
flavor
88
.INDENT 0.0
89
.INDENT 3.5
90
Manage compute API flavors.
91
.UNINDENT
92
.UNINDENT
93
.sp
94
network
95
.INDENT 0.0
96
.INDENT 3.5
97
Manage compute API networks.
98
.UNINDENT
99
.UNINDENT
100
.sp
101
image
102
.INDENT 0.0
103
.INDENT 3.5
104
Manage images on Plankton (and Compute).
105
.UNINDENT
106
.UNINDENT
107
.sp
108
file
109 62
.INDENT 0.0
110
.INDENT 3.5
111
Manage Pithos+ API.
112
.UNINDENT
63
.TP
64
.B user
65
Astakos/Identity API commands
66
.TP
67
.B project
68
Astakos project API commands
69
.TP
70
.B quota
71
Astakos/Account API commands for quotas
72
.TP
73
.B resource
74
Astakos/Account API commands for resources
75
.TP
76
.B file
77
Pithos+/Storage object level API commands
78
.TP
79
.B container
80
Pithos+/Storage container level API commands
81
.TP
82
.B group
83
Pithos+/Storage user groups
84
.TP
85
.B sharer
86
Pithos+/Storage sharer accounts
87
.TP
88
.B server
89
Cyclades/Compute API server commands
90
.TP
91
.B flavor
92
Cyclades/Compute API flavor commands
93
.TP
94
.B image
95
Cyclades/Plankton API image commands
96
.TP
97
.B imagecompute
98
Cyclades/Compute API image commands
99
.TP
100
.B network
101
Networking API network commands
102
.TP
103
.B subnet
104
Networking API network commands
105
.TP
106
.B ip
107
Networking API floatingip commands
108
.TP
109
.B port
110
Networking API network Commands
111
.TP
112
.B config
113
Kamaki option and cloud configuration
114
.TP
115
.B history
116
Kamaki command history
113 117
.UNINDENT
114 118
.SH HIDDEN COMMAND GROUPS
115
.sp
116
livetest
117 119
.INDENT 0.0
118
.INDENT 3.5
119
LIve tests that check kamaki against running services. To enable:
120
.TP
121
.B livetest
122
Live tests that check kamaki against running services. To enable:
120 123
kamaki config set livetest.cli livetest
121
.UNINDENT
124
.TP
125
.B service
126
Astakos API service commands
127
.TP
128
.B endpoint
129
Astakos API endpoints commands
130
.TP
131
.B commission
132
Astakos API commission commands
122 133
.UNINDENT
123 134
.SH OPTIONS
124
.INDENT 0.0
125
.INDENT 3.5
126 135
.sp
127 136
.nf
128 137
.ft C
129 138
\-\-help, \-h              Show help message and exit.
130 139
\-v                      Use verbose output.
131 140
\-d                      Use debug output.
132
\-o KEY=VAL              Override a config value (can be used multiple times)
141
\-o KEY=VAL              Override a config value (can be repeated)
142
\-\-cloud CLOUD           Choose a cloud to connect to
133 143
.ft P
134 144
.fi
135
.UNINDENT
136
.UNINDENT
137 145
.SH COMMANDS
138
.SS config commands
146
.SS user
139 147
.INDENT 0.0
140 148
.IP \(bu 2
141
list       list configuration options
149
authenticate  Authenticate a user, show user information
142 150
.IP \(bu 2
143
get        get a configuration option
151
info          Get info for (current) session user
144 152
.IP \(bu 2
145
set        set a configuration option
153
uuid2name     Get user name(s) from uuid(s)
146 154
.IP \(bu 2
147
del        delete a configuration option
148
.UNINDENT
149
.SS history commands
150
.sp
151
Command user history, as stored in ~/.kamaki.history
152
.INDENT 0.0
155
authenticate  Authenticate a user and get all authentication information
153 156
.IP \(bu 2
154
show      show intersession history
157
list          List (cached) session users
155 158
.IP \(bu 2
156
clean     clean up history
159
add           Authenticate a user by token and add to kamaki session (cache)
157 160
.IP \(bu 2
158
run       run/show previously executed command(s)
161
name2uuid     Get user uuid(s) from name(s)
162
.IP \(bu 2
163
select        Select a user from the (cached) list as the current session user
164
.IP \(bu 2
165
delete        Delete a user (token) from the (cached) list of session users
159 166
.UNINDENT
160
.SS user commands
167
.SS project
161 168
.INDENT 0.0
162 169
.IP \(bu 2
163
authenticate      Authenticate a user, show user information
170
info          Get details for a project
171
.IP \(bu 2
172
unsuspend     Resume a suspended project (special privileges needed)
173
.IP \(bu 2
174
suspend       Suspend a project (special privileges needed)
175
.IP \(bu 2
176
list          List all projects
177
.IP \(bu 2
178
create        Apply for a new project
179
.IP \(bu 2
180
modify        Modify a project
181
.IP \(bu 2
182
terminate     Terminate a project (special privileges needed)
183
.IP \(bu 2
184
application   Application management commands
185
.IP \(bu 2
186
membership    Project membership management commands
187
.IP \(bu 2
188
reinstate     Reinstate a terminated project (special privileges needed)
164 189
.UNINDENT
165
.SS server commands
190
.SS quota
166 191
.INDENT 0.0
167 192
.IP \(bu 2
168
addr      List the addresses of all network interfaces on a server (VM)
193
list          Get user quotas
169 194
.IP \(bu 2
170
console   Get a VNC console to access an existing server (VM)
171
.IP \(bu 2
172
create    Create a server (aka Virtual Machine)
195
info          Get quota for a service (cyclades, pithos, astakos)
196
.UNINDENT
197
.SS resource
198
.INDENT 0.0
173 199
.IP \(bu 2
174
delete    Delete a server (VM)
200
list          List user resources
201
.UNINDENT
202
.SS file
203
.INDENT 0.0
175 204
.IP \(bu 2
176
delmeta   Delete server (VM) metadata
205
info      Get information/details about a file
177 206
.IP \(bu 2
178
firewall  Set the server (VM) firewall profile on VMs public network
207
truncate  Truncate remote file up to size
179 208
.IP \(bu 2
180
info      Detailed information on a Virtual Machine
209
mkdir     Create a directory ( create \-\-content\-type=\(aqapplcation/directory\(aq )
181 210
.IP \(bu 2
182
list      List Virtual Machines accessible by user
211
create    Create an empty file
183 212
.IP \(bu 2
184
meta      Get a server\(aqs metadatum
213
move      Move objects, even between different accounts or containers
185 214
.IP \(bu 2
186
reboot    Reboot a server (VM)
215
list      List all objects in a container or a directory object
187 216
.IP \(bu 2
188
rename    Set/update a server (VM) name
217
upload    Upload a file
189 218
.IP \(bu 2
190
setmeta   set server (VM) metadata
219
cat       Fetch remote file contents
191 220
.IP \(bu 2
192
shutdown  Shutdown an active server (VM)
221
modify    Modify the attributes of a file or directory object
193 222
.IP \(bu 2
194
start     Start an existing server (VM)
223
append    Append local file to (existing) remote object
195 224
.IP \(bu 2
196
stats     Get server (VM) statistics
225
download  Download a remove file or directory object to local file system
197 226
.IP \(bu 2
198
wait      Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
199
.UNINDENT
200
.SS flavor commands
201
.INDENT 0.0
227
copy      Copy objects, even between different accounts or containers
202 228
.IP \(bu 2
203
list       list flavors
229
overwrite Overwrite part of a remote file
204 230
.IP \(bu 2
205
info       get flavor details
231
delete    Delete a file or directory object
206 232
.UNINDENT
207
.SS image commands
233
.SS container
208 234
.INDENT 0.0
209 235
.IP \(bu 2
210
addmember     Add a member to an image
211
.IP \(bu 2
212
addproperty   Add an OS\-related property to an image
236
info      Get information about a container
213 237
.IP \(bu 2
214
delete        Delete an image (image file remains intact)
238
modify    Modify the properties of a container
215 239
.IP \(bu 2
216
delmember     Remove a member from an image
240
create    Create a new container
217 241
.IP \(bu 2
218
delproperty   Delete a property of an image
242
list      List all containers, or their contents
219 243
.IP \(bu 2
220
info          Get detailed information on an image
244
empty     Empty a container
221 245
.IP \(bu 2
222
members       Get image members
246
delete    Delete a container
247
.UNINDENT
248
.SS group
249
.INDENT 0.0
223 250
.IP \(bu 2
224
meta          Get image metadata
251
create    Create a group of users
225 252
.IP \(bu 2
226
properties    Get properties related to OS installation in an image
253
list      List all groups and group members
227 254
.IP \(bu 2
228
list          List images accessible by user
255
delete    Delete a user group
256
.UNINDENT
257
.SS sharer
258
.INDENT 0.0
229 259
.IP \(bu 2
230
register      (Re)Register an image
260
info      Details on a Pithos+ sharer account (default: current account)
231 261
.IP \(bu 2
232
setmembers    Set the members of an image
262
list      List accounts who share file objects with current user
263
.UNINDENT
264
.SS server
265
.INDENT 0.0
233 266
.IP \(bu 2
234
setproperty   Update an existing property in an image
267
info      Detailed information on a Virtual Machine
235 268
.IP \(bu 2
236
shared        List images shared by a member
269
modify    Modify attributes of a virtual server
237 270
.IP \(bu 2
238
.INDENT 2.0
239
.TP
240
.B compute       Compute Image API commands
241
.INDENT 7.0
271
create    Create a server (aka Virtual Machine)
242 272
.IP \(bu 2
243
list          List images
273
list      List virtual servers accessible by user
244 274
.IP \(bu 2
245
delete        Delete image
275
reboot    Reboot a virtual server
246 276
.IP \(bu 2
247
info          Get image details
277
start     Start an existing virtual server
248 278
.IP \(bu 2
249
properties    Get image properties
279
shutdown  Shutdown an active virtual server
250 280
.IP \(bu 2
251
delproperty   Delete an image property
281
delete    Delete a virtual server
252 282
.IP \(bu 2
253
setproperty   Update an image property
254
.UNINDENT
255
.UNINDENT
283
wait      Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
256 284
.UNINDENT
257
.SS network commands
285
.SS flavor
258 286
.INDENT 0.0
259 287
.IP \(bu 2
260
connect       Connect a server to a network
288
list       list flavors
261 289
.IP \(bu 2
262
create        Create an (unconnected) network
290
info       get flavor details
291
.UNINDENT
292
.SS image
293
.INDENT 0.0
263 294
.IP \(bu 2
264
delete        Delete a network
295
info          Get image metadata
265 296
.IP \(bu 2
266
disconnect    Disconnect a nic that connects a server to a network
297
list          List images accessible by user
267 298
.IP \(bu 2
268
info          Detailed information on a network
299
register      (Re)Register an image file to an Image service
269 300
.IP \(bu 2
270
list          List networks
301
modify        Add / update metadata and properties for an image
271 302
.IP \(bu 2
272
rename        Set the name of a network
303
unregister    Unregister an image (does not delete the image file)
273 304
.UNINDENT
274
.SS file commands
305
.SS imagecompute
275 306
.INDENT 0.0
276 307
.IP \(bu 2
277
append                Append local file to (existing) remote object
308
info      Get detailed information on an image
278 309
.IP \(bu 2
279
cat                   Print remote file contents to console
310
list      List images
280 311
.IP \(bu 2
281
copy                  Copy an object from container to (another) container
312
modify    Modify image properties (metadata)
282 313
.IP \(bu 2
283
create                Create a container
314
delete    Delete an image (WARNING: image file is also removed)
315
.UNINDENT
316
.SS network
317
.INDENT 0.0
284 318
.IP \(bu 2
285
delete                Delete a container [or an object]
319
info: Get details about a network
286 320
.IP \(bu 2
287
delgroup              Delete a user group
321
disconnect: Disconnect a network from a device
288 322
.IP \(bu 2
289
delmeta               Delete metadata from account, container or object
323
modify: Modify network attributes
290 324
.IP \(bu 2
291
delpermissions        Delete all permissions set on object
325
create: Create a new network
292 326
.IP \(bu 2
293
download              Download remote object(s) as local file(s)
327
list: List networks
294 328
.IP \(bu 2
295
group                 Get groups and group members
329
connect: Connect a network with a device (server or router)
296 330
.IP \(bu 2
297
hashmap               Get the hash\-map of an object
331
delete: Delete a network
332
.UNINDENT
333
.SS subnet
334
.INDENT 0.0
298 335
.IP \(bu 2
299
info                  Get detailed info for account, containers or objects
336
info      Get details about a subnet
300 337
.IP \(bu 2
301
list                  List containers, object trees or objects in a directory
338
list      List subnets
302 339
.IP \(bu 2
303
manifest              Create a remote file of uploaded parts by manifestation
340
create    Create a new subnet
304 341
.IP \(bu 2
305
meta                  Get metadata for account, containers or objects
342
modify    Modify the attributes of a subnet
343
.UNINDENT
344
.SS ip
345
.INDENT 0.0
306 346
.IP \(bu 2
307
mkdir                 Create a directory
347
info      Details for an IP
308 348
.IP \(bu 2
309
move                  Copy an object
349
list      List reserved floating IPs
310 350
.IP \(bu 2
311
overwrite             Overwrite part (from start to end) of a remote file
351
attach    Attach a floating IP to a server
312 352
.IP \(bu 2
313
permissions           Get read and write permissions of an object
353
pools     List pools of floating IPs
314 354
.IP \(bu 2
315
publish               Publish the object and print the public url
355
release   Release a floating IP
316 356
.IP \(bu 2
317
purge                 Delete a container and release related data blocks
357
detach    Detach a floating IP from a server
318 358
.IP \(bu 2
319
quota                 Get quota (in KB) for account or container
359
reserve   Reserve a floating IP
360
.UNINDENT
361
.SS port
362
.INDENT 0.0
320 363
.IP \(bu 2
321
setgroup              Set a user group
364
info      Get details about a port
322 365
.IP \(bu 2
323
setmeta               Set a piece of metadata for account, container or object
366
list      List all ports
324 367
.IP \(bu 2
325
setpermissions        Set permissions for an object
368
create    Create a new port (== connect server to network)
326 369
.IP \(bu 2
327
containerlimit set    Set new limit for container
370
modify    Modify the attributes of a port
328 371
.IP \(bu 2
329
containerlimit get    Get container limit
372
delete    Delete a port (== disconnect server from network)
330 373
.IP \(bu 2
331
setversioning         Set versioning mode (auto, none) for account or container
374
wait      Wait for port to finish [ACTIVE, DOWN, BUILD, ERROR]
375
.UNINDENT
376
.SS config
377
.INDENT 0.0
332 378
.IP \(bu 2
333
sharers               List the accounts that share objects with current user
379
list       list configuration options
334 380
.IP \(bu 2
335
touch                 Create an empty object (file)
381
get        get a configuration option
336 382
.IP \(bu 2
337
truncate              Truncate remote file up to a size
383
set        set a configuration option
338 384
.IP \(bu 2
339
unpublish             Unpublish an object
385
del        delete a configuration option
386
.UNINDENT
387
.SS history
388
.sp
389
Command user history, as stored in ~/.kamaki.history
390
.INDENT 0.0
340 391
.IP \(bu 2
341
upload                Upload a file or directory
392
show      show intersession history
342 393
.IP \(bu 2
343
versioning            Get  versioning for account or container
394
clean     clean up history
344 395
.IP \(bu 2
345
versions              Get the list of object versions
396
run       run/show previously executed command(s)
346 397
.UNINDENT
347
.SS test commands (hidden)
398
.SS livetest (hidden)
348 399
.INDENT 0.0
349 400
.IP \(bu 2
350 401
all         test all clients
......
363 414
.IP \(bu 2
364 415
prints      user\-test print methods for lists and dicts
365 416
.UNINDENT
417
.SS service (hidden)
418
.INDENT 0.0
419
.IP \(bu 2
420
list          List available services
421
.IP \(bu 2
422
uuid2username Get service username(s) from uuid(s)
423
.IP \(bu 2
424
quotas        Get service quotas
425
.IP \(bu 2
426
username2uuid Get service uuid(s) from username(s)
427
.UNINDENT
428
.SS endpoint (hidden)
429
.INDENT 0.0
430
.IP \(bu 2
431
list      Get endpoints service endpoints
432
.UNINDENT
433
.SS commission (hidden)
434
.INDENT 0.0
435
.IP \(bu 2
436
info      Get commission info (special privileges required)
437
.IP \(bu 2
438
resolve   Resolve multiple commissions (special privileges required)
439
.IP \(bu 2
440
accept    Accept a pending commission  (special privileges required)
441
.IP \(bu 2
442
reject    Reject a pending commission (special privileges required)
443
.IP \(bu 2
444
issue     Issue commissions as a json string (special privileges required)
445
.IP \(bu 2
446
pending   List pending commissions (special privileges required)
447
.UNINDENT
366 448
.SH AUTHOR
367 449
.sp
368 450
Synnefo development team <\fI\%synnefo-devel@googlegroups.com\fP>.
369 451
.SH COPYRIGHT
370
2012, GRNET
452
2013, GRNET
371 453
.\" Generated by docutils manpage writer.
454
.\" 
372 455
.

Also available in: Unified diff